organization_create_project_api module#

class edgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi(api_client=None)[source]#

Bases: object

clear_organization_transform(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Clear failed transform jobs

Clear all failed transform job from a create project job. Only jobs that have failed will be cleared.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

delete_organization_create_project(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Delete transformation job

Remove a transformation job. This will stop all running jobs.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

delete_organization_create_project_file(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
create_project_file_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Delete create project file

Remove a file from a create project job. Only files for which no jobs are running can be deleted.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • create_project_file_id (int) – Create project job file ID. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

get_organization_create_project_status(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
transform_limit: StrictInt[StrictInt],
transform_offset: StrictInt[StrictInt],
selection: StrictStr | None[StrictStr | None] = None,
**kwargs,
) → OrganizationCreateProjectStatusResponse[source]#

Get transformation job status

Get the current status of a transformation job job.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • transform_limit (int) – Maximum number of results of transformation jobs (required)

  • transform_offset (int) – Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging. (required)

  • selection (str) – Type of selected rows, either ‘all’, ‘created’, ‘in-progress’ or ‘failed’ (defaults to ‘all’)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

OrganizationCreateProjectStatusResponse

get_organization_create_projects(
organization_id: StrictInt[StrictInt],
limit: StrictInt | None[StrictInt | None] = None,
offset: StrictInt | None[StrictInt | None] = None,
include_pipeline_jobs: StrictBool | None[StrictBool | None] = None,
**kwargs,
) → OrganizationGetCreateProjectsResponse[source]#

List transformation jobs

Get list of transformation jobs.

Parameters:

  • organization_id (int) – Organization ID (required)

  • limit (int) – Maximum number of results

  • offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

  • include_pipeline_jobs (bool) – If enabled, also includes jobs that are part of a pipeline

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

OrganizationGetCreateProjectsResponse

organization_add_collaborator(
organization_id: StrictInt[StrictInt],
update_organization_add_collaborator_request: UpdateOrganizationAddCollaboratorRequest,
**kwargs,
) → GenericApiResponse[source]#

Add a collaborator to a project within an organisation

Add a new collaborator to a project owned by an organisation.

Parameters:

  • organization_id (int) – Organization ID (required)

  • update_organization_add_collaborator_request (UpdateOrganizationAddCollaboratorRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

organization_create_empty_project(
organization_id: StrictInt[StrictInt],
update_organization_create_empty_project_request: UpdateOrganizationCreateEmptyProjectRequest,
**kwargs,
) → CreateProjectResponse[source]#

Create new empty project

Create a new empty project within an organization.

Parameters:

  • organization_id (int) – Organization ID (required)

  • update_organization_create_empty_project_request (UpdateOrganizationCreateEmptyProjectRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CreateProjectResponse

organization_create_project(
organization_id: StrictInt[StrictInt],
organization_create_project_request: OrganizationCreateProjectRequest,
**kwargs,
) → OrganizationCreateProjectResponse[source]#

Start transformation job

Start a transformation job to fetch data from the organization and put it in a project, or transform into new data.

Parameters:

  • organization_id (int) – Organization ID (required)

  • organization_create_project_request (OrganizationCreateProjectRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

OrganizationCreateProjectResponse

retry_organization_create_project_file(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
create_project_file_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Retry transformation file

Retry a transformation action on a file from a transformation job. Only files that have failed can be retried.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • create_project_file_id (int) – Create project job file ID. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

retry_organization_transform(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Retry failed transform jobs

Retry all failed transform job from a transformation job. Only jobs that have failed will be retried.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

retry_organization_upload(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
**kwargs,
) → GenericApiResponse[source]#

Retry transformation upload job

Retry the upload job from a transformation job. Only jobs that have failed can be retried.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

update_organization_create_project(
organization_id: StrictInt[StrictInt],
create_project_id: StrictInt[StrictInt],
update_organization_create_project_request: UpdateOrganizationCreateProjectRequest,
**kwargs,
) → GenericApiResponse[source]#

Update transformation job

Update the properties of a transformation job.

Parameters:

  • organization_id (int) – Organization ID (required)

  • create_project_id (int) – Create project job ID. (required)

  • update_organization_create_project_request (UpdateOrganizationCreateProjectRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

upload_custom_block(
organization_id: StrictInt[StrictInt],
tar: StrictStr,
type: StrictStr,
block_id: StrictInt,
**kwargs,
) → StartJobResponse[source]#

Upload a custom block

Upload a zip file containing a custom transformation or deployment block.

Parameters:

  • organization_id (int) – Organization ID (required)

  • tar (str) – (required)

  • type (str) – (required)

  • block_id (int) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

StartJobResponse