Function ProjectsApiFactory

Returns {
    projectsCreate(requestParameters, options?) => AxiosPromise<ProjectRead>;
    projectsCreateBackup(requestParameters?, options?) => AxiosPromise<void>;
    projectsCreateDataset(requestParameters, options?) => AxiosPromise<RqId>;
    projectsDestroy(requestParameters, options?) => AxiosPromise<void>;
    projectsList(requestParameters?, options?) => AxiosPromise<PaginatedProjectReadList>;
    projectsPartialUpdate(requestParameters, options?) => AxiosPromise<ProjectRead>;
    projectsRetrieve(requestParameters, options?) => AxiosPromise<ProjectRead>;
    projectsRetrieveAnnotations(requestParameters, options?) => AxiosPromise<AnnotationsRead>;
    projectsRetrieveBackup(requestParameters, options?) => AxiosPromise<void>;
    projectsRetrieveDataset(requestParameters, options?) => AxiosPromise<File>;
    projectsRetrievePreview(requestParameters, options?) => AxiosPromise<void>;
}

• projectsCreate:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ProjectRead>

    Summary

    Method creates a new project

    Throws

• projectsCreateBackup:function

  • projectsCreateBackup(requestParameters?, options?): 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.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Methods create a project from a backup

    Throws

• projectsCreateDataset:function

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

  • The request POST /api/projects/id/dataset will initiate file upload and will create the rq job on the server in which the process of dataset import from a file will be carried out. Please, use the GET /api/projects/id/dataset endpoint for checking status of the process.

    Parameters

    • requestParameters: ProjectsApiProjectsCreateDatasetRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<RqId>

    Summary

    Import dataset in specific format as a project or check status of dataset import process

    Throws

• projectsDestroy:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a specific project

    Throws

• projectsList:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedProjectReadList>

    Summary

    Returns a paginated list of projects

    Throws

• projectsPartialUpdate:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ProjectRead>

    Summary

    Methods does a partial update of chosen fields in a project

    Throws

• projectsRetrieve:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ProjectRead>

    Summary

    Method returns details of a specific project

    Throws

• projectsRetrieveAnnotations:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsRetrieveAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AnnotationsRead>

    Summary

    Method allows to download project annotations

    Throws

• projectsRetrieveBackup:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsRetrieveBackupRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Methods creates a backup copy of a project

    Throws

• projectsRetrieveDataset:function

  • projectsRetrieveDataset(requestParameters, options?): 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.

    Parameters

    • requestParameters: ProjectsApiProjectsRetrieveDatasetRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Export project as a dataset in a specific format

    Throws

• projectsRetrievePreview:function

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

  • Parameters

    • requestParameters: ProjectsApiProjectsRetrievePreviewRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method returns a preview image for the project

    Throws