wdata-client 1.0.0

Wdata API

wdata-client

The Wdata Preparation API allow users to import data sets from their source system, tag, organize, manipulate, share, export, and query against the data

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.0
• Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.workiva.com

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import wdata_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import wdata_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wdata_client
from wdata_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://h.app.wdesk.com/s/wdata/prep
# See configuration.py for a list of all supported configuration parameters.
configuration = wdata_client.Configuration(
    host = "https://h.app.wdesk.com/s/wdata/prep"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with wdata_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wdata_client.APIHealthApi(api_client)

    try:
        # Health check
        api_response = api_instance.health_check()
        print("The response of APIHealthApi->health_check:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIHealthApi->health_check: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://h.app.wdesk.com/s/wdata/prep

Class	Method	HTTP request	Description
APIHealthApi	health_check	GET /health	Health check
AdministrativeTasksApi	delete_workspace	DELETE /api/v1/admin/account	Delete a single workspace
AdministrativeTasksApi	export_workspace	GET /api/v1/admin/export	Export a single workspace
AdministrativeTasksApi	find_workspace_files_by_size	GET /api/v1/admin/usage/filesBySize	Retrieve workspace files by size
AdministrativeTasksApi	get_workspace_query_usage	GET /api/v1/admin/usage/query	Retrieve workspace query usage
AdministrativeTasksApi	get_workspace_upload_usage	GET /api/v1/admin/usage/upload	Retrieve workspace upload usage
AdministrativeTasksApi	import_data	POST /api/v1/admin/import	Import data
AdministrativeTasksApi	validate_files	POST /api/v1/admin/validation/files	Validate files
AdministrativeTasksApi	validate_tables	POST /api/v1/admin/validation/tables	Validate tables
ConnectionManagementApi	get_connection	GET /api/v1/connections/{connectionId}	Get connection details
ConnectionManagementApi	get_refresh_batch_status	GET /api/v1/connections/batch/refresh/{batchId}	Gets the status of a batch refresh
ConnectionManagementApi	get_refresh_status	GET /api/v1/connections/{connectionId}/status	Get connection refresh status
ConnectionManagementApi	list_connections	GET /api/v1/connections	List connections
ConnectionManagementApi	refresh_batch	POST /api/v1/connections/batch/refresh	Refresh batch of connections
ConnectionManagementApi	refresh_connection	POST /api/v1/connections/{connectionId}/refresh	Refresh connection
FileManagementApi	delete_file	DELETE /api/v1/file/{fileId}	Delete a single file
FileManagementApi	download_file1	GET /api/v1/file/{fileId}/download	Download a single file
FileManagementApi	export_file_to_spreadsheets	POST /api/v1/file/{fileId}/export	Export a file to spreadsheets
FileManagementApi	get_errors	GET /api/v1/file/{fileId}/error	Retrieve errors
FileManagementApi	get_file	GET /api/v1/file/{fileId}	Retrieve a single file
FileManagementApi	get_files	GET /api/v1/file	Retrieve a list of files
FileManagementApi	upload_file	POST /api/v1/file	Upload a single file
FileManagementApi	validate_filename	GET /api/v1/file/validateName	Validate whether a file with the filename can be uploaded to the table
FolderManagementApi	create_folder	POST /api/v1/folder	Create a new folder
FolderManagementApi	delete_folder	DELETE /api/v1/folder/{folderId}	Delete a single folder
FolderManagementApi	get_folder	GET /api/v1/folder/{folderId}	Retrieve a single folder
FolderManagementApi	list_children	GET /api/v1/folder/{folderId}/children	Retrieve list of folder contents
FolderManagementApi	list_folders	GET /api/v1/folder	Retrieve a list of folders
FolderManagementApi	search	GET /api/v1/entity	Search
FolderManagementApi	set_children	POST /api/v1/folder/{folderId}/children	Move content into a folder
FolderManagementApi	update_folder	PUT /api/v1/folder/{folderId}	Update a single folder
ParameterManagementApi	create_parameter	POST /api/v1/parameter	Create parameter
ParameterManagementApi	delete_parameter	DELETE /api/v1/parameter/{parameterId}	Delete Parameter
ParameterManagementApi	get_parameter	GET /api/v1/parameter/{parameterId}	Get Parameter
ParameterManagementApi	list_parameters	GET /api/v1/parameter	Get Parameters
ParameterManagementApi	update_parameter	PUT /api/v1/parameter/{parameterId}	Update Parameter
PivotViewManagementApi	create_pivot_view	POST /api/v1/pivotview	Create a new pivot view
PivotViewManagementApi	delete_pivot_view	DELETE /api/v1/pivotview/{pivotViewId}	Delete a single pivot view
PivotViewManagementApi	get_pivot_view	GET /api/v1/pivotview/{pivotViewId}	Retrieve a single pivot view
PivotViewManagementApi	list_pivot_views	GET /api/v1/pivotview	Retrieve a list of pivot views
PivotViewManagementApi	update_pivot_view	PUT /api/v1/pivotview/{pivotViewId}	Update a single pivot view
QueryManagementApi	cancel_query	DELETE /api/v1/queryresult/{queryResultId}	Cancel a running query
QueryManagementApi	create_query	POST /api/v1/query	Create a new query
QueryManagementApi	delete_query	DELETE /api/v1/query/{queryId}	Delete a single query
QueryManagementApi	describe_query	POST /api/v1/query/{queryId}/describe	List the output columns of a query
QueryManagementApi	download_query_result	GET /api/v1/queryresult/{queryResultId}/download	Download a query result
QueryManagementApi	export_query_result_to_spreadsheets	POST /api/v1/queryresult/{queryResultId}/export	Export query result to spreadsheets
QueryManagementApi	get_dependencies	GET /api/v1/query/{queryId}/dependencies	Retrieve dependencies
QueryManagementApi	get_query	GET /api/v1/query/{queryId}	Retrieve a single query
QueryManagementApi	get_query_column_data	POST /api/v1/query/data	Retrieve query column data
QueryManagementApi	get_query_result	GET /api/v1/queryresult/{queryResultId}	Retrieve a single query result
QueryManagementApi	get_tables_dependent_on_query	GET /api/v1/query/{queryId}/dependents	Retrieve a list of dependents
QueryManagementApi	is_query_valid	POST /api/v1/query/validation	Parses the query to determine if it is valid
QueryManagementApi	list_queries	GET /api/v1/query	Retrieve list of queries
QueryManagementApi	list_query_results	GET /api/v1/queryresult	Retrieve a list of query results
QueryManagementApi	run_query	POST /api/v1/queryresult	Execute a query
QueryManagementApi	update_query	PUT /api/v1/query/{queryId}	Update a single query
SelectListManagementApi	create_select_list	POST /api/v1/selectlist	Create a new select list
SelectListManagementApi	delete	DELETE /api/v1/selectlist/{selectListId}	Delete a single select list
SelectListManagementApi	get_select_list	GET /api/v1/selectlist/{selectListId}	Retrieve a single select list
SelectListManagementApi	list_select_lists	GET /api/v1/selectlist	Retrieve a list of select lists
SelectListManagementApi	update_select_list	PUT /api/v1/selectlist/{selectListId}	Update a single select list
SharedTableManagementApi	create_shared_table	POST /api/v1/sharedtable	Create a new shared table
SharedTableManagementApi	delete_shared_table	DELETE /api/v1/sharedtable/{sharedTableId}	Delete a single shared table
SharedTableManagementApi	get_shared_table	GET /api/v1/sharedtable/{sharedTableId}	Retrieve a single shared table
SharedTableManagementApi	list_shared_tables	GET /api/v1/sharedtable	Retrieve a list of shared tables
TableManagementApi	create_table	POST /api/v1/table	Create a new table
TableManagementApi	delete_table	DELETE /api/v1/table/{tableId}	Delete a single table
TableManagementApi	get_dependents	GET /api/v1/table/{tableId}/dependents	Retrieve a list of dependents
TableManagementApi	get_import_info	GET /api/v1/table/{tableId}/importInfo	Retrieve import information
TableManagementApi	get_table	GET /api/v1/table/{tableId}	Retrieve a single table
TableManagementApi	get_tables	GET /api/v1/table	Retrieve a list of tables
TableManagementApi	import_file	POST /api/v1/table/{tableId}/import	Import a single file
TableManagementApi	import_from_spreadsheets	POST /api/v1/table/{tableId}/spreadsheet/import	Import from spreadsheets
TableManagementApi	unimport_file	DELETE /api/v1/table/{tableId}/import/{fileId}	Unimport a single file
TableManagementApi	update_table	PUT /api/v1/table/{tableId}	Update a single table
TagManagementApi	create_tag	POST /api/v1/tag	Create a new tag
TagManagementApi	delete_tag	DELETE /api/v1/tag/{tagId}	Delete a single tag
TagManagementApi	list_tags	GET /api/v1/tag	Retrieve a list of tags
TagManagementApi	update_tag	PUT /api/v1/tag/{tagId}	Update a single tag
TokenManagementApi	create_token	POST /api/v1/token	Create a new token
TokenManagementApi	download_file	GET /api/v1/token/{tokenId}	Download a single file
UtilitiesApi	parse_date	POST /api/v1/util/datetime	Parse a date

Documentation For Models

• BaseErrorResponseDetail
• BaseResponseCollectionFolderableDto
• BaseResponseConnectionDto
• BaseResponseConnectionRunDto
• BaseResponseDescribeQueryResponseDto
• BaseResponseFileMetaDto
• BaseResponseFolderDto
• BaseResponseGlobalParameterDto
• BaseResponseImportInfoDto
• BaseResponseLong
• BaseResponseMapStringString
• BaseResponsePivotViewDto
• BaseResponseQueryColumnDataDto
• BaseResponseQueryDto
• BaseResponseQueryResultDto
• BaseResponseRefreshBatchDto
• BaseResponseSelectListDto
• BaseResponseSharedTableDto
• BaseResponseSpreadsheetInfoDto
• BaseResponseString
• BaseResponseTableDto
• BaseResponseTagDto
• BaseResponseTokenDto
• BaseResponseValidateFilesDto
• BaseResponseValidateTablesDto
• Column
• ColumnDto
• ColumnInfoDto
• ConnectionDto
• ConnectionRunDto
• DatetimeDto
• DeleteWorkspace400Response
• DescribeQueryColumnDto
• DescribeQueryResponseDto
• ExportFileDto
• ExportQueryResultDto
• FileMetaDto
• FolderDto
• FolderableDto
• GlobalParameterDto
• HierarchyMetadata
• ImportDto
• ImportErrorDto
• ImportFromSpreadsheetDto
• ImportInfoDto
• MultiError
• PagedResponseConnectionDto
• PagedResponseFileMetaDto
• PagedResponseFolderDto
• PagedResponseFolderableDto
• PagedResponseGlobalParameterDto
• PagedResponseImportErrorDto
• PagedResponsePivotViewDto
• PagedResponseQueryDto
• PagedResponseQueryResultDto
• PagedResponseSelectListDto
• PagedResponseSharedTableDto
• PagedResponseTableDto
• PagedResponseTagDto
• PivotDefinitionDto
• PivotViewDefinitionColumnDto
• PivotViewDefinitionFilterDto
• PivotViewDefinitionRowDto
• PivotViewDefinitionValueDto
• PivotViewDto
• QueryColumnDataDto
• QueryDependencyDto
• QueryDto
• QueryParameterDto
• QueryResultDto
• QueryTextDto
• RefreshBatchDto
• RefreshConnectionDto
• SelectListDto
• SharedTableDto
• SingleError
• SpreadsheetInfoDto
• StartValidateFilesDto
• TableDto
• TableSchema
• TagDto
• TokenDto
• UniqueConstraintDto
• ValidateFilesDto
• ValidateTablesDto

Documentation For Authorization

Authentication schemes defined for the API:

oauth

• Type: OAuth
• Flow: accessCode
• Authorization URL: /iam/v1/oauth2/auth
• Scopes: N/A

Author

[e-mail]