Optional configuration: ConfigurationProtected axiosProtected baseProtected configurationRequest parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Method creates a new project
ProjectsApi
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.
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Methods create a project from a backup
ProjectsApi
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.
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Import dataset in specific format as a project or check status of dataset import process
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Method deletes a specific project
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Returns a paginated list of projects
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Methods does a partial update of chosen fields in a project
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Method returns details of a specific project
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Method allows to download project annotations
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Methods creates a backup copy of a project
ProjectsApi
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.
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Export project as a dataset in a specific format
ProjectsApi
Request parameters.
Optional options: AxiosRequestConfig<any>Override http request option.
Method returns a preview image for the project
ProjectsApi
Generated using TypeDoc
ProjectsApi - object-oriented interface
Export