openapi_client.BatchesApi

All URIs are relative to /api/v2

Method	HTTP request	Description
create_batch	POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches	Create batch
delete_batch	DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches/{batch_id}	Delete batch
delete_batches	DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches	Delete multiple batches
get_batch	GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches/{batch_id}	List batches
get_batches	GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches	List batches
update_batches	PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches	Update batches

create_batch

CreateBatch200Response create_batch(workspace_id, project_id, dataset_id, batches_post_request)

Create batch

Create a new batch through combine another datasets.

Example

Api Key Authentication (apiKey):
Api Key Authentication (apiSecret):

import openapi_client
from openapi_client.models.batches_post_request import BatchesPostRequest
from openapi_client.models.create_batch200_response import CreateBatch200Response
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.BatchesApi(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
    batches_post_request = openapi_client.BatchesPostRequest() # BatchesPostRequest | 

    try:
        # Create batch
        api_response = api_instance.create_batch(workspace_id, project_id, dataset_id, batches_post_request)
        print("The response of BatchesApi->create_batch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BatchesApi->create_batch: %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
batches_post_request	BatchesPostRequest

Return type

CreateBatch200Response

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]

delete_batch

ObjectJobSchema delete_batch(workspace_id, project_id, dataset_id, batch_id)

Delete batch

Deletes the batch and its associated data.

Example

Api Key Authentication (apiKey):
Api Key Authentication (apiSecret):

import openapi_client
from openapi_client.models.object_job_schema import ObjectJobSchema
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.BatchesApi(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
    batch_id = 121 # int | Id of the dataset

    try:
        # Delete batch
        api_response = api_instance.delete_batch(workspace_id, project_id, dataset_id, batch_id)
        print("The response of BatchesApi->delete_batch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BatchesApi->delete_batch: %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
batch_id	int	Id of the dataset

Return type

ObjectJobSchema

Authorization

apiKey, apiSecret

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Request accepted, processing continues off-line	-
400	Bad request syntax or unsupported method	-

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

delete_batches

ObjectJobSchema delete_batches(workspace_id, project_id, dataset_id, ids=ids)

Delete multiple batches

Deletes multiple batches and its associated data.

Example

Api Key Authentication (apiKey):
Api Key Authentication (apiSecret):

import openapi_client
from openapi_client.models.object_job_schema import ObjectJobSchema
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.BatchesApi(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
    ids = '' # str | Track multiple dataset ids, comma separated (optional) (default to '')

    try:
        # Delete multiple batches
        api_response = api_instance.delete_batches(workspace_id, project_id, dataset_id, ids=ids)
        print("The response of BatchesApi->delete_batches:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BatchesApi->delete_batches: %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
ids	str	Track multiple dataset ids, comma separated	[optional] [default to '']

Return type

ObjectJobSchema

Authorization

apiKey, apiSecret

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Request accepted, processing continues off-line	-
400	Bad request syntax or unsupported method	-

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

get_batch

BatchDetails get_batch(workspace_id, project_id, dataset_id, batch_id, fields=fields)

List batches

List batches and their details.

Example

Api Key Authentication (apiKey):
Api Key Authentication (apiSecret):

import openapi_client
from openapi_client.models.batch_details import BatchDetails
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.BatchesApi(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
    batch_id = 121 # int | Id of the batch
    fields = 'id,name,state,created_at,description,row_count,column_count,source' # str | Fields to be returned in a comma-separated format may include id, name, status, created_at. (optional) (default to 'id,name,state,created_at,description,row_count,column_count,source')

    try:
        # List batches
        api_response = api_instance.get_batch(workspace_id, project_id, dataset_id, batch_id, fields=fields)
        print("The response of BatchesApi->get_batch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BatchesApi->get_batch: %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
batch_id	int	Id of the batch
fields	str	Fields to be returned in a comma-separated format may include id, name, status, created_at.	[optional] [default to 'id,name,state,created_at,description,row_count,column_count,source']

Return type

BatchDetails

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_batches

BatchesList get_batches(workspace_id, project_id, dataset_id, fields=fields, id=id, created_at=created_at, status=status, row_count=row_count, limit=limit, offset=offset, sort=sort)

List batches

List batches and their details.

Example

Api Key Authentication (apiKey):
Api Key Authentication (apiSecret):

import openapi_client
from openapi_client.models.batches_list import BatchesList
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.BatchesApi(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,state,created_at,description,row_count,column_count,source' # str | Fields to be returned in a comma-separated format may include id, name, status, created_at. (optional) (default to 'id,name,state,created_at,description,row_count,column_count,source')
    id = '' # str | Track multiple batch ids, comma separated (optional) (default to '')
    created_at = '' # str | Track multiple batches, which falls under created_at date range (optional) (default to '')
    status = '' # str | Track multiple batch state, comma separated (optional) (default to '')
    row_count = '' # str | Track multiple batch row counts, 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 batches based on the fields (optional) (default to '(id:asc)')

    try:
        # List batches
        api_response = api_instance.get_batches(workspace_id, project_id, dataset_id, fields=fields, id=id, created_at=created_at, status=status, row_count=row_count, limit=limit, offset=offset, sort=sort)
        print("The response of BatchesApi->get_batches:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BatchesApi->get_batches: %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, status, created_at.	[optional] [default to 'id,name,state,created_at,description,row_count,column_count,source']
id	str	Track multiple batch ids, comma separated	[optional] [default to '']
created_at	str	Track multiple batches, which falls under created_at date range	[optional] [default to '']
status	str	Track multiple batch state, comma separated	[optional] [default to '']
row_count	str	Track multiple batch row counts, 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 batches based on the fields	[optional] [default to '(id:asc)']

Return type

BatchesList

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]

update_batches

ObjectJobSchema update_batches(workspace_id, project_id, dataset_id, batches_patch_request)

Update batches

Update batches state.

Example

Api Key Authentication (apiKey):
Api Key Authentication (apiSecret):

import openapi_client
from openapi_client.models.batches_patch_request import BatchesPatchRequest
from openapi_client.models.object_job_schema import ObjectJobSchema
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.BatchesApi(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
    batches_patch_request = openapi_client.BatchesPatchRequest() # BatchesPatchRequest | 

    try:
        # Update batches
        api_response = api_instance.update_batches(workspace_id, project_id, dataset_id, batches_patch_request)
        print("The response of BatchesApi->update_batches:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BatchesApi->update_batches: %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
batches_patch_request	BatchesPatchRequest

Return type

ObjectJobSchema

Authorization

apiKey, apiSecret

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Request accepted, processing continues off-line	-
400	Bad request syntax or unsupported method	-

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

Files

BatchesApi.md

Latest commit

History

BatchesApi.md

File metadata and controls

openapi_client.BatchesApi

create_batch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_batch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_batches

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_batch

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_batches

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_batches

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details