organization_create_project_api module
OrganizationCreateProjectApi
class edgeimpulse_api.api.organization_create_project_api.OrganizationCreateProjectApi(
api_client=None
)
Parameters
api_client=None
Methods
clear_organization_transform
edgeimpulse_api.api.organization_create_project_api.clear_organization_transform(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Clear failed transform jobs
Clear all failed transform job from a create project job. Only jobs that have failed will be cleared.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
delete_organization_create_project
edgeimpulse_api.api.organization_create_project_api.delete_organization_create_project(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete transformation job
Remove a transformation job. This will stop all running jobs.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
delete_organization_create_project_file
edgeimpulse_api.api.organization_create_project_api.delete_organization_create_project_file(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
create_project_file_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job file ID.', extra={})],
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Delete create project file
Remove a file from a create project job. Only files for which no jobs are running can be deleted.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
create_project_file_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job file ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
get_organization_create_project_status
edgeimpulse_api.api.organization_create_project_api.get_organization_create_project_status(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
transform_limit: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Maximum number of results of transformation jobs', extra={})],
transform_offset: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging.', extra={})],
selection: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description="Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')", extra={})] = None,
**kwargs
) ‑> edgeimpulse_api.models.organization_create_project_status_response.OrganizationCreateProjectStatusResponse
Get transformation job status
Get the current status of a transformation job job.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
transform_limit: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Maximum number of results of transformation jobs', extra={})]
transform_offset: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging.', extra={})]
selection: Annotated[pydantic.types.StrictStr | None, FieldInfo(default=PydanticUndefined, description="Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')", extra={})] = None
**kwargs
Return
edgeimpulse_api.models.organization_create_project_status_response.OrganizationCreateProjectStatusResponse
get_organization_create_projects
edgeimpulse_api.api.organization_create_project_api.get_organization_create_projects(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None,
offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None,
include_pipeline_jobs: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='If enabled, also includes jobs that are part of a pipeline', extra={})] = None,
**kwargs
) ‑> edgeimpulse_api.models.organization_get_create_projects_response.OrganizationGetCreateProjectsResponse
List transformation jobs
Get list of transformation jobs.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
limit: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Maximum number of results', extra={})] = None
offset: Annotated[pydantic.types.StrictInt | None, FieldInfo(default=PydanticUndefined, description='Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.', extra={})] = None
include_pipeline_jobs: Annotated[pydantic.types.StrictBool | None, FieldInfo(default=PydanticUndefined, description='If enabled, also includes jobs that are part of a pipeline', extra={})] = None
**kwargs
Return
edgeimpulse_api.models.organization_get_create_projects_response.OrganizationGetCreateProjectsResponse
organization_add_collaborator
edgeimpulse_api.api.organization_create_project_api.organization_add_collaborator(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
update_organization_add_collaborator_request: edgeimpulse_api.models.update_organization_add_collaborator_request.UpdateOrganizationAddCollaboratorRequest,
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Add a collaborator to a project within an organisation
Add a new collaborator to a project owned by an organisation.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_organization_add_collaborator_request: edgeimpulse_api.models.update_organization_add_collaborator_request.UpdateOrganizationAddCollaboratorRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
organization_create_empty_project
edgeimpulse_api.api.organization_create_project_api.organization_create_empty_project(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
update_organization_create_empty_project_request: edgeimpulse_api.models.update_organization_create_empty_project_request.UpdateOrganizationCreateEmptyProjectRequest,
**kwargs
) ‑> edgeimpulse_api.models.create_project_response.CreateProjectResponse
Create new empty project
Create a new empty project within an organization.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
update_organization_create_empty_project_request: edgeimpulse_api.models.update_organization_create_empty_project_request.UpdateOrganizationCreateEmptyProjectRequest
**kwargs
Return
edgeimpulse_api.models.create_project_response.CreateProjectResponse
organization_create_project
edgeimpulse_api.api.organization_create_project_api.organization_create_project(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
organization_create_project_request: edgeimpulse_api.models.organization_create_project_request.OrganizationCreateProjectRequest,
**kwargs
) ‑> edgeimpulse_api.models.organization_create_project_response.OrganizationCreateProjectResponse
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
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
organization_create_project_request: edgeimpulse_api.models.organization_create_project_request.OrganizationCreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.organization_create_project_response.OrganizationCreateProjectResponse
retry_organization_create_project_file
edgeimpulse_api.api.organization_create_project_api.retry_organization_create_project_file(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
create_project_file_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job file ID.', extra={})],
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retry transformation file
Retry a transformation action on a file from a transformation job. Only files that have failed can be retried.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
create_project_file_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job file ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
retry_organization_transform
edgeimpulse_api.api.organization_create_project_api.retry_organization_transform(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retry failed transform jobs
Retry all failed transform job from a transformation job. Only jobs that have failed will be retried.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
retry_organization_upload
edgeimpulse_api.api.organization_create_project_api.retry_organization_upload(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Retry transformation upload job
Retry the upload job from a transformation job. Only jobs that have failed can be retried.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
update_organization_create_project
edgeimpulse_api.api.organization_create_project_api.update_organization_create_project(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})],
update_organization_create_project_request: edgeimpulse_api.models.update_organization_create_project_request.UpdateOrganizationCreateProjectRequest,
**kwargs
) ‑> edgeimpulse_api.models.generic_api_response.GenericApiResponse
Update transformation job
Update the properties of a transformation job.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
create_project_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Create project job ID.', extra={})]
update_organization_create_project_request: edgeimpulse_api.models.update_organization_create_project_request.UpdateOrganizationCreateProjectRequest
**kwargs
Return
edgeimpulse_api.models.generic_api_response.GenericApiResponse
upload_custom_block
edgeimpulse_api.api.organization_create_project_api.upload_custom_block(
self,
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})],
tar: pydantic.types.StrictStr,
type: pydantic.types.StrictStr,
block_id: pydantic.types.StrictInt,
**kwargs
) ‑> edgeimpulse_api.models.start_job_response.StartJobResponse
Upload a custom block
Upload a zip file containing a custom transformation or deployment block.
Parameters
self
organization_id: Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Organization ID', extra={})]
tar: pydantic.types.StrictStr
type: pydantic.types.StrictStr
block_id: pydantic.types.StrictInt
**kwargs
Return
edgeimpulse_api.models.start_job_response.StartJobResponse
Last updated
Was this helpful?