Function ProjectsApiFp

Returns {
    projectsCreate(projectWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>;
    projectsCreateBackup(xOrganization?, cloudStorageId?, filename?, location?, org?, orgId?, rqId?, backupWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    projectsCreateDataset(id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, datasetWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<RqId>)>;
    projectsDestroy(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    projectsList(xOrganization?, assignee?, filter?, name?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, status?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedProjectReadList>)>;
    projectsPartialUpdate(id, patchedProjectWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>;
    projectsRetrieve(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>;
    projectsRetrieveAnnotations(format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<((axios?, basePath?) => AxiosPromise<AnnotationsRead>)>;
    projectsRetrieveBackup(id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    projectsRetrieveDataset(id, action?, cloudStorageId?, filename?, format?, location?, rqId?, useDefaultLocation?, options?) => Promise<((axios?, basePath?) => AxiosPromise<File>)>;
    projectsRetrievePreview(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• projectsCreate:function

  • projectsCreate(projectWriteRequest, xOrganization?, org?, orgId?, options?): Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>

  • Parameters

    • projectWriteRequest: ProjectWriteRequest

    • Optional xOrganization: string

      Organization unique slug

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>

    Summary

    Method creates a new project

    Throws

• projectsCreateBackup:function

  • projectsCreateBackup(xOrganization?, cloudStorageId?, filename?, location?, org?, orgId?, rqId?, backupWriteRequest?, options?): Promise<((axios?, basePath?) => 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

    • Optional xOrganization: string

      Organization unique slug

    • Optional cloudStorageId: number

      Storage id

    • Optional filename: string

      Backup file name

    • Optional location: ProjectsCreateBackupLocationEnum

      Where to import the backup file from

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional rqId: string

      rq id

    • Optional backupWriteRequest: null | ProjectFileRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Methods create a project from a backup

    Throws

• projectsCreateDataset:function

  • projectsCreateDataset(id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, datasetWriteRequest?, options?): Promise<((axios?, basePath?) => 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

    • id: number

      A unique integer value identifying this project.

    • Optional cloudStorageId: number

      Storage id

    • Optional filename: string

      Dataset file name

    • Optional format: string

      Desired dataset format name You can get the list of supported formats at: /server/annotation/formats

    • Optional location: ProjectsCreateDatasetLocationEnum

      Where to import the dataset from

    • Optional useDefaultLocation: boolean

      Use the location that was configured in the project to import annotations

    • Optional datasetWriteRequest: null | DatasetFileRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<RqId>)>

    Summary

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

    Throws

• projectsDestroy:function

  • projectsDestroy(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this project.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Method deletes a specific project

    Throws

• projectsList:function

  • projectsList(xOrganization?, assignee?, filter?, name?, org?, orgId?, owner?, page?, pageSize?, search?, sort?, status?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedProjectReadList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional assignee: string

      A simple equality filter for the assignee field

    • Optional filter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;name&#39;, &#39;owner&#39;, &#39;assignee&#39;, &#39;status&#39;, &#39;id&#39;, &#39;updated_date&#39;].

    • Optional name: string

      A simple equality filter for the name field

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • Optional owner: string

      A simple equality filter for the owner field

    • Optional page: number

      A page number within the paginated result set.

    • Optional pageSize: number

      Number of results to return per page.

    • Optional search: string

      A search term. Available search_fields: (&#39;name&#39;, &#39;owner&#39;, &#39;assignee&#39;, &#39;status&#39;)

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;name&#39;, &#39;owner&#39;, &#39;assignee&#39;, &#39;status&#39;, &#39;id&#39;, &#39;updated_date&#39;]

    • Optional status: ProjectsListStatusEnum

      A simple equality filter for the status field

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedProjectReadList>)>

    Summary

    Returns a paginated list of projects

    Throws

• projectsPartialUpdate:function

  • projectsPartialUpdate(id, patchedProjectWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this project.

    • Optional patchedProjectWriteRequest: PatchedProjectWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>

    Summary

    Methods does a partial update of chosen fields in a project

    Throws

• projectsRetrieve:function

  • projectsRetrieve(id, options?): Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this project.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ProjectRead>)>

    Summary

    Method returns details of a specific project

    Throws

• projectsRetrieveAnnotations:function

  • projectsRetrieveAnnotations(format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?): Promise<((axios?, basePath?) => AxiosPromise<AnnotationsRead>)>

  • Parameters

    • format: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats

    • id: number

      A unique integer value identifying this project.

    • Optional action: "download"

      Used to start downloading process after annotation file had been created

    • Optional cloudStorageId: number

      Storage id

    • Optional filename: string

      Desired output file name

    • Optional location: ProjectsRetrieveAnnotationsLocationEnum

      Where need to save downloaded dataset

    • Optional useDefaultLocation: boolean

      Use the location that was configured in project to export annotation

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AnnotationsRead>)>

    Summary

    Method allows to download project annotations

    Throws

• projectsRetrieveBackup:function

  • projectsRetrieveBackup(id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this project.

    • Optional action: "download"

      Used to start downloading process after backup file had been created

    • Optional cloudStorageId: number

      Storage id

    • Optional filename: string

      Backup file name

    • Optional location: ProjectsRetrieveBackupLocationEnum

      Where need to save downloaded backup

    • Optional useDefaultLocation: boolean

      Use the location that was configured in project to export backup

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Methods creates a backup copy of a project

    Throws

• projectsRetrieveDataset:function

  • projectsRetrieveDataset(id, action?, cloudStorageId?, filename?, format?, location?, rqId?, useDefaultLocation?, options?): Promise<((axios?, basePath?) => 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

    • id: number

      A unique integer value identifying this project.

    • Optional action: ProjectsRetrieveDatasetActionEnum

      Used to start downloading process after annotation file had been created

    • Optional cloudStorageId: number

      Storage id

    • Optional filename: string

      Desired output file name

    • Optional format: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats

    • Optional location: ProjectsRetrieveDatasetLocationEnum

      Where need to save downloaded dataset

    • Optional rqId: string

      rq id

    • Optional useDefaultLocation: boolean

      Use the location that was configured in project to import dataset

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<File>)>

    Summary

    Export project as a dataset in a specific format

    Throws

• projectsRetrievePreview:function

  • projectsRetrievePreview(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this project.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Method returns a preview image for the project

    Throws