Function ProjectsApiFp

Returns {
    projectsCreate(
        projectWriteRequest: ProjectWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectRead>,
    >;
    projectsCreateBackup(
        xOrganization?: string,
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsCreateBackupLocationEnum,
        org?: string,
        orgId?: number,
        rqId?: string,
        backupWriteRequest?: null | ProjectFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    projectsCreateBackupExport(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsCreateBackupExportLocationEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>,
    >;
    projectsCreateDataset(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: ProjectsCreateDatasetLocationEnum,
        useDefaultLocation?: boolean,
        datasetWriteRequest?: null | DatasetFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>,
    >;
    projectsCreateDatasetExport(
        format: string,
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsCreateDatasetExportLocationEnum,
        saveImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>,
    >;
    projectsDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    projectsList(
        xOrganization?: string,
        assignee?: string,
        filter?: string,
        name?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        search?: string,
        sort?: string,
        status?: ProjectsListStatusEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedProjectReadList>,
    >;
    projectsPartialUpdate(
        id: number,
        patchedProjectWriteRequest?: PatchedProjectWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectRead>,
    >;
    projectsRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectRead>,
    >;
    projectsRetrieveAnnotations(
        format: string,
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsRetrieveAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationsRead>,
    >;
    projectsRetrieveBackup(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsRetrieveBackupLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    projectsRetrieveDataset(
        id: number,
        action?: ProjectsRetrieveDatasetActionEnum,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: ProjectsRetrieveDatasetLocationEnum,
        rqId?: string,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    projectsRetrievePreview(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• projectsCreate:function

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

    Parameters

    • projectWriteRequest: ProjectWriteRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsCreateBackup:function

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

    • OptionalxOrganization: string

      Organization unique slug
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Backup file name
    • Optionallocation: ProjectsCreateBackupLocationEnum

      Where to import the backup file from
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • OptionalrqId: string

      rq id
    • OptionalbackupWriteRequest: null | ProjectFileRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsCreateBackupExport:function

  • projectsCreateBackupExport(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsCreateBackupExportLocationEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • id: number

      A unique integer value identifying this project.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Backup file name
    • Optionallocation: ProjectsCreateBackupExportLocationEnum

      Where need to save downloaded backup
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsCreateDataset:function

  • projectsCreateDataset(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: ProjectsCreateDatasetLocationEnum,
        useDefaultLocation?: boolean,
        datasetWriteRequest?: null | DatasetFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • id: number

      A unique integer value identifying this project.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Dataset file name
    • Optionalformat: string

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

      Where to import the dataset from
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in the project to import annotations
    • OptionaldatasetWriteRequest: null | DatasetFileRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsCreateDatasetExport:function

  • projectsCreateDatasetExport(
        format: string,
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsCreateDatasetExportLocationEnum,
        saveImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • 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.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionallocation: ProjectsCreateDatasetExportLocationEnum

      Where need to save downloaded dataset
    • OptionalsaveImages: boolean

      Include images or not
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsDestroy:function

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

    Parameters

    • id: number

      A unique integer value identifying this project.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsList:function

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

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalassignee: string

      A simple equality filter for the assignee field
    • Optionalfilter: 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;].
    • Optionalname: string

      A simple equality filter for the name field
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalowner: string

      A simple equality filter for the owner field
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;name&#39;, &#39;owner&#39;, &#39;assignee&#39;, &#39;status&#39;)
    • Optionalsort: 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;]
    • Optionalstatus: ProjectsListStatusEnum

      A simple equality filter for the status field
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsPartialUpdate:function

  • projectsPartialUpdate(
        id: number,
        patchedProjectWriteRequest?: PatchedProjectWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this project.
    • OptionalpatchedProjectWriteRequest: PatchedProjectWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsRetrieve:function

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

    Parameters

    • id: number

      A unique integer value identifying this project.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsRetrieveAnnotations:function

  • projectsRetrieveAnnotations(
        format: string,
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsRetrieveAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • 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.
    • Optionalaction: "download"

      Used to start downloading process locally after annotation file has been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionallocation: ProjectsRetrieveAnnotationsLocationEnum

      Where need to save downloaded dataset
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in project to export annotation
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsRetrieveBackup:function

  • projectsRetrieveBackup(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: ProjectsRetrieveBackupLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

    • id: number

      A unique integer value identifying this project.
    • Optionalaction: "download"

      Used to start downloading process after backup file had been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Backup file name
    • Optionallocation: ProjectsRetrieveBackupLocationEnum

      Where need to save downloaded backup
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in project to export backup
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsRetrieveDataset:function

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

    • id: number

      A unique integer value identifying this project.
    • Optionalaction: ProjectsRetrieveDatasetActionEnum

      Used to start downloading process locally after annotation file has been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionalformat: string

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

      Where need to save downloaded dataset
    • OptionalrqId: string

      rq id
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in project to import dataset
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• projectsRetrievePreview:function

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

    Parameters

    • id: number

      A unique integer value identifying this project.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws