Skip to content

Latest commit

 

History

History
770 lines (542 loc) · 29.7 KB

DatasetsApi.md

File metadata and controls

770 lines (542 loc) · 29.7 KB

openapi_client.DatasetsApi

All URIs are relative to /api/v2

Method HTTP request Description
create_datasets POST /workspaces/{workspace_id}/projects/{project_id}/datasets Create dataset
delete_dataset DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} Delete dataset
delete_datasets DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets Delete multiple datasets
get_dataset GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} Get dataset details
get_dataset_data GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/data Get dataset data
get_datasets GET /workspaces/{workspace_id}/projects/{project_id}/datasets Get list of datasets
update_dataset PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} Update dataset
update_datasets PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets Update datasets name

create_datasets

object create_datasets(workspace_id, project_id)

Create dataset

Create datasets

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    project_id = 4 # int | Project ID of the workspace (default to 4)

    try:
        # Create dataset
        api_response = api_instance.create_datasets(workspace_id, project_id)
        print("The response of DatasetsApi->create_datasets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatasetsApi->create_datasets: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
project_id int Project ID of the workspace [default to 4]

Return type

object

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Document created, URL follows -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_dataset

delete_dataset(workspace_id, project_id, dataset_id)

Delete dataset

Deletes the dataset and its associated data.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    project_id = 4 # int | Project ID of the workspace (default to 4)
    dataset_id = 121 # int | Id of the dataset

    try:
        # Delete dataset
        api_instance.delete_dataset(workspace_id, project_id, dataset_id)
    except Exception as e:
        print("Exception when calling DatasetsApi->delete_dataset: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
project_id int Project ID of the workspace [default to 4]
dataset_id int Id of the dataset

Return type

void (empty response body)

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Request fulfilled, nothing follows -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_datasets

delete_datasets(workspace_id, project_id, ids=ids)

Delete multiple datasets

Deletes multiple datasets and its associated data.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    project_id = 4 # int | Project ID of the workspace (default to 4)
    ids = '' # str | Track multiple dataset ids, comma separated (optional) (default to '')

    try:
        # Delete multiple datasets
        api_instance.delete_datasets(workspace_id, project_id, ids=ids)
    except Exception as e:
        print("Exception when calling DatasetsApi->delete_datasets: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
project_id int Project ID of the workspace [default to 4]
ids str Track multiple dataset ids, comma separated [optional] [default to '']

Return type

void (empty response body)

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Request fulfilled, nothing follows -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_dataset

DatasetDetails get_dataset(workspace_id, project_id, dataset_id, fields=fields)

Get dataset details

Returns dataset details. Query parameters can be used to optimize the response.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.dataset_details import DatasetDetails
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    project_id = 4 # int | Project ID of the workspace (default to 4)
    dataset_id = 121 # int | Id of the dataset
    fields = 'id,name,created_at,updated_at,created_by,status,status_info,get_url,data_schema,stats,sources,display_info,dependencies,data_url,resource_path' # str | Fields to be returned in a comma-separated format may include id, name, owner_workspace_id, updated_at. (optional) (default to 'id,name,created_at,updated_at,created_by,status,status_info,get_url,data_schema,stats,sources,display_info,dependencies,data_url,resource_path')

    try:
        # Get dataset details
        api_response = api_instance.get_dataset(workspace_id, project_id, dataset_id, fields=fields)
        print("The response of DatasetsApi->get_dataset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatasetsApi->get_dataset: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
project_id int Project ID of the workspace [default to 4]
dataset_id int Id of the dataset
fields str Fields to be returned in a comma-separated format may include id, name, owner_workspace_id, updated_at. [optional] [default to 'id,name,created_at,updated_at,created_by,status,status_info,get_url,data_schema,stats,sources,display_info,dependencies,data_url,resource_path']

Return type

DatasetDetails

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Dataset Details -
400 Bad Request -
401 Authorization error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_dataset_data

object get_dataset_data(workspace_id, project_id, dataset_id, columns=columns, limit=limit, offset=offset)

Get dataset data

Get the given dataset data

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 56 # int | 
    project_id = 56 # int | 
    dataset_id = 56 # int | 
    columns = 'columns_example' # str |  (optional)
    limit = 100 # int |  (optional) (default to 100)
    offset = 0 # int |  (optional) (default to 0)

    try:
        # Get dataset data
        api_response = api_instance.get_dataset_data(workspace_id, project_id, dataset_id, columns=columns, limit=limit, offset=offset)
        print("The response of DatasetsApi->get_dataset_data:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatasetsApi->get_dataset_data: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int
project_id int
dataset_id int
columns str [optional]
limit int [optional] [default to 100]
offset int [optional] [default to 0]

Return type

object

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request fulfilled, document follows -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_datasets

DatasetsList get_datasets(project_id, workspace_id, fields=fields, id=id, name=name, created_at=created_at, updated_at=updated_at, created_by=created_by, source_type=source_type, status=status, limit=limit, offset=offset, sort=sort)

Get list of datasets

Returns list of datasets in given project. Query parameters can be used to optimize the response.

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.datasets_list import DatasetsList
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    project_id = 4 # int | Project ID of the workspace (default to 4)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    fields = 'id,name,created_at,updated_at,created_by,status,status_info,get_url,data_schema,stats,sources,display_info,dependencies,data_url,resource_path' # str | Fields to be returned in a comma-separated format may include id, name, owner_workspace_id, updated_at. (optional) (default to 'id,name,created_at,updated_at,created_by,status,status_info,get_url,data_schema,stats,sources,display_info,dependencies,data_url,resource_path')
    id = '' # str | Track multiple dataset ids, comma separated (optional) (default to '')
    name = '' # str | Track multiple dataset names, comma separated (optional) (default to '')
    created_at = '' # str | Track multiple dataset, which falls under created_at date range (optional) (default to '')
    updated_at = '' # str | Track multiple dataset, which falls under updated_at date range (optional) (default to '')
    created_by = '' # str | Track multiple dataset created by, comma separated (optional) (default to '')
    source_type = '' # str | Track multiple dataset source type, comma separated (optional) (default to '')
    status = '' # str | Track multiple dataset status, comma separated (optional) (default to '')
    limit = 10 # int | Max number of result to return (optional) (default to 10)
    offset = 0 # int | Distance from the beginning of the list of results (optional) (default to 0)
    sort = '(id:asc)' # str | Sort the datasets based on the fields (optional) (default to '(id:asc)')

    try:
        # Get list of datasets
        api_response = api_instance.get_datasets(project_id, workspace_id, fields=fields, id=id, name=name, created_at=created_at, updated_at=updated_at, created_by=created_by, source_type=source_type, status=status, limit=limit, offset=offset, sort=sort)
        print("The response of DatasetsApi->get_datasets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatasetsApi->get_datasets: %s\n" % e)

Parameters

Name Type Description Notes
project_id int Project ID of the workspace [default to 4]
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
fields str Fields to be returned in a comma-separated format may include id, name, owner_workspace_id, updated_at. [optional] [default to 'id,name,created_at,updated_at,created_by,status,status_info,get_url,data_schema,stats,sources,display_info,dependencies,data_url,resource_path']
id str Track multiple dataset ids, comma separated [optional] [default to '']
name str Track multiple dataset names, comma separated [optional] [default to '']
created_at str Track multiple dataset, which falls under created_at date range [optional] [default to '']
updated_at str Track multiple dataset, which falls under updated_at date range [optional] [default to '']
created_by str Track multiple dataset created by, comma separated [optional] [default to '']
source_type str Track multiple dataset source type, comma separated [optional] [default to '']
status str Track multiple dataset status, comma separated [optional] [default to '']
limit int Max number of result to return [optional] [default to 10]
offset int Distance from the beginning of the list of results [optional] [default to 0]
sort str Sort the datasets based on the fields [optional] [default to '(id:asc)']

Return type

DatasetsList

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 List of datasets -
400 Bad Request -
401 Authorization error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_dataset

object update_dataset(workspace_id, project_id, dataset_id, dataset_patch_request, validation_only=validation_only)

Update dataset

Update the dataset

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.dataset_patch_request import DatasetPatchRequest
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    project_id = 4 # int | Project ID of the workspace (default to 4)
    dataset_id = 121 # int | Id of the dataset
    dataset_patch_request = openapi_client.DatasetPatchRequest() # DatasetPatchRequest | 
    validation_only = False # bool |  (optional) (default to False)

    try:
        # Update dataset
        api_response = api_instance.update_dataset(workspace_id, project_id, dataset_id, dataset_patch_request, validation_only=validation_only)
        print("The response of DatasetsApi->update_dataset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatasetsApi->update_dataset: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
project_id int Project ID of the workspace [default to 4]
dataset_id int Id of the dataset
dataset_patch_request DatasetPatchRequest
validation_only bool [optional] [default to False]

Return type

object

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request fulfilled, document follows -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_datasets

object update_datasets(workspace_id, project_id, datasets_patch_request, validation_only=validation_only)

Update datasets name

Update the name of multiple datasets

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (apiSecret):
import openapi_client
from openapi_client.models.datasets_patch_request import DatasetsPatchRequest
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: apiSecret
configuration.api_key['apiSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiSecret'] = 'Bearer'

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DatasetsApi(api_client)
    workspace_id = 4 # int | Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. (default to 4)
    project_id = 4 # int | Project ID of the workspace (default to 4)
    datasets_patch_request = openapi_client.DatasetsPatchRequest() # DatasetsPatchRequest | 
    validation_only = False # bool |  (optional) (default to False)

    try:
        # Update datasets name
        api_response = api_instance.update_datasets(workspace_id, project_id, datasets_patch_request, validation_only=validation_only)
        print("The response of DatasetsApi->update_datasets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DatasetsApi->update_datasets: %s\n" % e)

Parameters

Name Type Description Notes
workspace_id int Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace. [default to 4]
project_id int Project ID of the workspace [default to 4]
datasets_patch_request DatasetsPatchRequest
validation_only bool [optional] [default to False]

Return type

object

Authorization

apiKey, apiSecret

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Request fulfilled, document follows -
400 Bad request syntax or unsupported method -

[Back to top] [Back to API list] [Back to Model list] [Back to README]