Function ProjectsApiFactory

Returns {
    projectsCreate(
        requestParameters: ProjectsApiProjectsCreateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ProjectRead>;
    projectsCreateBackup(
        requestParameters?: ProjectsApiProjectsCreateBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    projectsCreateBackupExport(
        requestParameters: ProjectsApiProjectsCreateBackupExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>;
    projectsCreateDataset(
        requestParameters: ProjectsApiProjectsCreateDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>;
    projectsCreateDatasetExport(
        requestParameters: ProjectsApiProjectsCreateDatasetExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>;
    projectsDestroy(
        requestParameters: ProjectsApiProjectsDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    projectsList(
        requestParameters?: ProjectsApiProjectsListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedProjectReadList>;
    projectsPartialUpdate(
        requestParameters: ProjectsApiProjectsPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ProjectRead>;
    projectsRetrieve(
        requestParameters: ProjectsApiProjectsRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ProjectRead>;
    projectsRetrieveAnnotations(
        requestParameters: ProjectsApiProjectsRetrieveAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationsRead>;
    projectsRetrieveBackup(
        requestParameters: ProjectsApiProjectsRetrieveBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    projectsRetrieveDataset(
        requestParameters: ProjectsApiProjectsRetrieveDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    projectsRetrievePreview(
        requestParameters: ProjectsApiProjectsRetrievePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• projectsCreate:function

  • projectsCreate(
        requestParameters: ProjectsApiProjectsCreateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ProjectRead>

    Parameters

    • requestParameters: ProjectsApiProjectsCreateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ProjectRead>

    Throws

• projectsCreateBackup:function

  • projectsCreateBackup(
        requestParameters?: ProjectsApiProjectsCreateBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    The backup import process is as follows: The first request POST /api/projects/backup will initiate file upload and will create the rq job on the server in which the process of a project creating from an uploaded backup will be carried out. After initiating the backup upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent requests to track the status of the project creation. Once the project has been successfully created, the server will return the id of the newly created project.

    Parameters

    • requestParameters: ProjectsApiProjectsCreateBackupRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• projectsCreateBackupExport:function

  • projectsCreateBackupExport(
        requestParameters: ProjectsApiProjectsCreateBackupExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>

    The request POST /api/<projects|tasks>/id/backup/export will initialize a background process to backup a resource. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • requestParameters: ProjectsApiProjectsCreateBackupExportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqId>

    Throws

• projectsCreateDataset:function

  • projectsCreateDataset(
        requestParameters: ProjectsApiProjectsCreateDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>

    The request POST /api/projects/id/dataset initiates a background process to import dataset into a project. Please, use the GET /api/requests/<rq_id> endpoint for checking status of the process. The rq_id parameter can be found in the response on initiating request.

    Parameters

    • requestParameters: ProjectsApiProjectsCreateDatasetRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqId>

    Throws

• projectsCreateDatasetExport:function

  • projectsCreateDatasetExport(
        requestParameters: ProjectsApiProjectsCreateDatasetExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>

    The request POST /api/<projects|tasks|jobs>/id/dataset/export will initialize a background process to export a dataset. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • requestParameters: ProjectsApiProjectsCreateDatasetExportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqId>

    Throws

• projectsDestroy:function

  • projectsDestroy(
        requestParameters: ProjectsApiProjectsDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: ProjectsApiProjectsDestroyRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• projectsList:function

  • projectsList(
        requestParameters?: ProjectsApiProjectsListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedProjectReadList>

    Parameters

    • requestParameters: ProjectsApiProjectsListRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaginatedProjectReadList>

    Throws

• projectsPartialUpdate:function

  • projectsPartialUpdate(
        requestParameters: ProjectsApiProjectsPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ProjectRead>

    Parameters

    • requestParameters: ProjectsApiProjectsPartialUpdateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ProjectRead>

    Throws

• projectsRetrieve:function

  • projectsRetrieve(
        requestParameters: ProjectsApiProjectsRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ProjectRead>

    Parameters

    • requestParameters: ProjectsApiProjectsRetrieveRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ProjectRead>

    Throws

• projectsRetrieveAnnotations:function

  • projectsRetrieveAnnotations(
        requestParameters: ProjectsApiProjectsRetrieveAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationsRead>

    Deprecation warning: Using this endpoint to initiate export of annotations as a dataset or to check export status is deprecated. Consider using new API: - POST /api/projects/<project_id>/dataset/export?save_images=False to initiate exporting process - GET /api/requests/<rq_id> to check export status, where rq_id is request id returned on initializing request'

    Parameters

    • requestParameters: ProjectsApiProjectsRetrieveAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AnnotationsRead>

    Throws

• projectsRetrieveBackup:function

  • projectsRetrieveBackup(
        requestParameters: ProjectsApiProjectsRetrieveBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/projects/<project_id>/backup/export to initiate backup process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • requestParameters: ProjectsApiProjectsRetrieveBackupRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• projectsRetrieveDataset:function

  • projectsRetrieveDataset(
        requestParameters: ProjectsApiProjectsRetrieveDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

    To check the status of the process of importing a project dataset from a file: After initiating the dataset upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent GET /api/projects/id/dataset requests to track the status of the dataset import. Also you should specify action parameter: action=import_status. Deprecation warning: Utilizing this endpoint to export project dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/projects/<project_id>/dataset/export/?save_images=True to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • requestParameters: ProjectsApiProjectsRetrieveDatasetRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• projectsRetrievePreview:function

  • projectsRetrievePreview(
        requestParameters: ProjectsApiProjectsRetrievePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: ProjectsApiProjectsRetrievePreviewRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws