{"swagger":"2.0","info":{"description":"

OVERVIEW

The Vercator Cloud API allows you to programmatically access and run the Vercator Cloud service without using the web portal. The easiest way to get started with the API is to use this page which provides combined documentation as well as an API sandbox to do simple testing within the browser. The operations supported focus on creating a project, and being able to get statuses.

AUTHENTICATION

You need a valid API Bearer Key to send requests to the API endpoints. You can get your key from the Admin panel of the Vercator Cloud web portal. It is possible to call the API directly from this page if you have a valid API Token. All operations require to be authenticated. In order to do so, please click the Authorize button, and enter your API_KEY prefixed by 'Bearer'. For instance, if your api key is '124-dj1-efa1', you must enter: Bearer 124-dj1-efa1

Links

","version":"0","title":"Vercator Cloud Rest API","contact":{"name":"Correvate Support","url":"https://correvate.atlassian.net/servicedesk/customer/portal/1","email":"support@correvate.atlassian.net"}},"host":"vercator.cloud","basePath":"/","tags":[{"name":"API","description":"Endpoints"},{"name":"AutoRegistrationJob","description":"All endpoints related with the automatic registration job operations"},{"name":"Company","description":"All endpoints related with the company associated with authentication token."},{"name":"CompanyStorage","description":"All endpoints related with the company storage associated with authentication token."},{"name":"ExportJob","description":"All endpoints related with the export jobs operations"},{"name":"GeoReferencing","description":"All endpoints related with the geo referencing jobs operations"},{"name":"ImportJob","description":"All endpoints related with the import jobs operations"},{"name":"ManualRegistrationJob","description":"All endpoints related with the manual registration job operations"},{"name":"MergeJob","description":"All endpoints related with the merge jobs operations"},{"name":"OptimiseRegistrationJob","description":"All endpoints related with the optimise registration job operations"},{"name":"Profile","description":"All endpoints related with the profile associated with authentication token."},{"name":"Project","description":"All endpoints related with the company projects associated with authentication token."},{"name":"Public Endpoints","description":"All endpoints related with the signup and login process."},{"name":"RegistrationQAJob","description":"All endpoints related with the registration QA job operations"},{"name":"SegmentationApiJob","description":"All endpoints related with the segmentation jobs operations"},{"name":"SegmentationJob","description":"All endpoints related with the segmentation jobs operations"},{"name":"System","description":"Internal endpoints useful to the Vercator infrastructure / components. Examples:\n * Share application version\n * Sharing configuration properties with frontend application\n * Define an endpoint to be used for monitoring?"},{"name":"User","description":"All endpoints related with the user associated with authentication token."},{"name":"Users","description":"All endpoints related with the users."},{"name":"Visualisation","description":"All endpoints related with the job visualisation"},{"name":"api-access-keys-controller","description":"Api Access Keys Controller"},{"name":"file-security-controller","description":"File Security Controller"},{"name":"file-storage-controller","description":"File Storage Controller"},{"name":"job-controller","description":"Job Controller"},{"name":"level-controller","description":"Level Controller"},{"name":"project-controller","description":"Project Controller"},{"name":"scan-controller","description":"Scan Controller"},{"name":"scan-conversion-utility-controller","description":"Scan Conversion Utility Controller"},{"name":"scan-format-conversion-controller","description":"Scan Format Conversion Controller"},{"name":"scan-grapher-app-controller","description":"Scan Grapher App Controller"},{"name":"scan-pair-controller","description":"Scan Pair Controller"},{"name":"scan-target-link-controller","description":"Scan Target Link Controller"},{"name":"survey-coordinates-controller","description":"Survey Coordinates Controller"},{"name":"survey-target-controller","description":"Survey Target Controller"},{"name":"utility-task-controller","description":"Utility Task Controller"}],"paths":{"/api/v0/export/{exportJobId}/scan/{scanId}":{"get":{"tags":["API"],"summary":"Generates a public link to an exported scan.","description":"Gives access to the exported scans' file. Once a scan is exported it can be access through this endpoint using its identifier and its project's identifier.
Note that the link has an expiration timeout of 1 hour.","operationId":"getExportedScanLinkUsingGET","produces":["application/json"],"parameters":[{"name":"exportJobId","in":"path","description":"Export identifier","required":true,"type":"integer","format":"int64","x-example":1},{"name":"scanId","in":"path","description":"Scan identifier","required":true,"type":"integer","format":"int64","x-example":1}],"responses":{"200":{"description":"[OK] The scan public link has been generated. ","schema":{"$ref":"#/definitions/PublicLinkApiDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false}},"/api/v0/projects":{"post":{"tags":["API"],"summary":"Create a project","description":"Create a project and start the alignment process.","operationId":"createProjectUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Project information","required":true,"schema":{"$ref":"#/definitions/ProjectApiPost"}}],"responses":{"200":{"description":"[OK] The project was created and the alignment process has been started successfully.","schema":{"$ref":"#/definitions/ProjectApiDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false}},"/api/v0/projects/{id}":{"get":{"tags":["API"],"summary":"Get a project","description":"Retrieve a project and its current state.","operationId":"getProjectUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Project identifier to fetch","required":true,"type":"integer","format":"int64","x-example":1}],"responses":{"200":{"description":"[OK] The project was found and returned.","schema":{"$ref":"#/definitions/ProjectApiDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false}},"/api/v0/scan-conversion":{"get":{"tags":["API"],"summary":"Returns a list of scan conversion jobs","operationId":"getScanConversionBatchesByUserIdUsingGET","produces":["application/json"],"parameters":[{"name":"authenticated","in":"query","required":false,"type":"boolean"},{"name":"authorities[0].authority","in":"query","required":false,"type":"string"},{"name":"credentials","in":"query","required":false,"type":"object"},{"name":"details","in":"query","required":false,"type":"object"},{"name":"principal","in":"query","required":false,"type":"object"}],"responses":{"200":{"description":"The tasks were found and returned.","schema":{"type":"array","items":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false},"post":{"tags":["API"],"summary":"Convert a scan","operationId":"convertScansUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Project information","required":true,"schema":{"$ref":"#/definitions/ScanFormatConversionBatchPost"}}],"responses":{"200":{"description":"[OK] The scan conversion job has been launched.","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false}},"/api/v0/scan-conversion/{batchId}":{"get":{"tags":["API"],"summary":"Inspect scan conversion status","operationId":"scanConversionBatchStatusUsingGET","produces":["application/json"],"parameters":[{"name":"batchId","in":"path","description":"Utility task identifier","required":true,"type":"integer","format":"int64","x-example":1}],"responses":{"200":{"description":"[OK] The scan conversion job has been launched.","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false},"delete":{"tags":["API"],"summary":"Delete a scan conversion batch job","operationId":"deleteScanConversionBatchTaskUsingDELETE","produces":["application/json"],"parameters":[{"name":"batchId","in":"path","description":"Utility task identifier","required":true,"type":"integer","format":"int64","x-example":1}],"responses":{"200":{"description":"[OK] The scan conversion batch job has been deleted.","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false}},"/api/v0/scan-conversion/{batchId}/links":{"get":{"tags":["API"],"summary":"Generates public links to converted scans.","description":"Gives access to the converted scans' files. Once scans are exported they can be accessed through this endpoint using their utility task identifier.
Note that the links have an expiration timeout of 1 hour.
The result is a mapping from the original scan to the link to the result.
There is an additional mapping from failed scans (if any) to the corresponding error messaged.There is also a list of unfinished tasks (in case this endpoint is used before all the tasks have finished).","operationId":"getConvertedScanLinkUsingGET","produces":["application/json"],"parameters":[{"name":"batchId","in":"path","description":"Conversion identifier","required":true,"type":"integer","format":"int64","x-example":1}],"responses":{"200":{"description":"[OK] The scan public link has been generated. ","schema":{"$ref":"#/definitions/PublicLinkListApiDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"API access key":[]}],"deprecated":false}},"/api/v3/segmentation/runs":{"get":{"tags":["SegmentationApiJob"],"summary":"Get segmentation jobs","description":"Get segmentation API jobs using filters, pagination and sorting","operationId":"segmentationJobsGETUsingGET_2","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned segmentation jobs","schema":{"$ref":"#/definitions/Paginated«SegmentationRunDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["SegmentationApiJob"],"summary":"Run a new segmentation job","description":"Run a new segmentation job","operationId":"runSegmentationJobPOSTUsingPOST_2","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"segmentationApiRunCreateRequest","description":"Details of the segmentation job to run","required":false,"schema":{"$ref":"#/definitions/SegmentationApiRunCreateRequest"}}],"responses":{"200":{"description":"The segmentation job that will be run","schema":{"$ref":"#/definitions/SegmentationRunDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/api/v3/segmentation/runs/{jobId}/inputs":{"get":{"tags":["SegmentationApiJob"],"summary":"Get input of a run of a Segmentation job","description":"Get input of a run of an Segmentation job","operationId":"segmentationJobsRunInputGETUsingGET_2","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an Segmentation job","schema":{"$ref":"#/definitions/SegmentationApiRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/api/v3/segmentation/runs/{jobId}/outputs":{"get":{"tags":["SegmentationApiJob"],"summary":"Get output of a run of a Segmentation job","description":"Get output of a run of a Segmentation job","operationId":"segmentationJobsRunOutputGETUsingGET_2","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a Segmentation job","schema":{"$ref":"#/definitions/SegmentationApiRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/api/v3/segmentation/runs/{jobId}/status":{"get":{"tags":["SegmentationApiJob"],"summary":"Get status of a run of a Segmentation job","description":"Get status of a run of a Segmentation job","operationId":"segmentationJobsRunStatusGETUsingGET_2","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an segmentation job","schema":{"$ref":"#/definitions/SegmentationApiRunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/mapi/v0/scangrapherapp/uploadproject":{"post":{"tags":["scan-grapher-app-controller"],"summary":"uploadScanGrapher","operationId":"uploadScanGrapherUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/AppScanGrapherUploadDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AppScanGrapherUploadCompleted"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/companies/{companyId}/storages":{"get":{"tags":["file-storage-controller"],"summary":"getStorages","operationId":"getStoragesUsingGET","produces":["application/json"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FileStorageDto"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"post":{"tags":["file-storage-controller"],"summary":"createStorage","operationId":"createStorageUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/FileStoragePost"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileStorageDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/companies/{companyId}/storages/{storageId}":{"post":{"tags":["file-storage-controller"],"summary":"editStorage","operationId":"editStorageUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/FileStoragePost"}},{"name":"storageId","in":"path","description":"storageId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileStorageDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"delete":{"tags":["file-storage-controller"],"summary":"deleteStorage","operationId":"deleteStorageUsingDELETE","produces":["application/json"],"parameters":[{"name":"companyId","in":"path","description":"companyId","required":true,"type":"integer","format":"int64"},{"name":"storageId","in":"path","description":"storageId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileStorageDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/companies/{id}/keys":{"get":{"tags":["api-access-keys-controller"],"summary":"getKeys","operationId":"getKeysUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ApiAccessKeyDto"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"post":{"tags":["api-access-keys-controller"],"summary":"createKey","operationId":"createKeyUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApiAccessKeyCreatedDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":true}},"/webapi/companies/{id}/security":{"get":{"tags":["file-security-controller"],"summary":"getCompanyCookie","operationId":"getCompanyCookieUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/dropbox-configuration":{"get":{"tags":["file-storage-controller"],"summary":"getDropboxConfiguration","operationId":"getDropboxConfigurationUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DropboxConfigurationDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}":{"get":{"tags":["job-controller"],"summary":"getJob","operationId":"getJobUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JobDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"delete":{"tags":["job-controller"],"summary":"deleteJob","operationId":"deleteJobUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/config":{"get":{"tags":["job-controller"],"summary":"getJobConfig","operationId":"getJobConfigUsingGET","consumes":["*/*"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VercatorConfigDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/fine-registration-failure":{"patch":{"tags":["job-controller"],"summary":"failFineRegistration","operationId":"failFineRegistrationUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/JobFailureStatusDto"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JobDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/fine-registration-report-csv":{"get":{"tags":["job-controller"],"summary":"getFineRegistrationReportCsvUrl","operationId":"getFineRegistrationReportCsvUrlUsingGET","consumes":["*/*"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FineRegistrationReportCsvUrl"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/fine-registration-report-data":{"get":{"tags":["job-controller"],"summary":"getFineRegistrationReportData","operationId":"getFineRegistrationReportDataUsingGET","consumes":["*/*"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FineRegistrationReportData"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/progress":{"patch":{"tags":["job-controller"],"summary":"setJobProgress","operationId":"setJobProgressUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/JobProgress"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JobDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/statistics":{"patch":{"tags":["job-controller"],"summary":"setJobStatistics","operationId":"setJobStatisticsUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/FineRegistrationCompletedDto"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JobDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/status":{"get":{"tags":["job-controller"],"summary":"getJobStatus","operationId":"getJobStatusUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{id}/transformations-csv":{"get":{"tags":["job-controller"],"summary":"getTransformationsCsvUrl","operationId":"getTransformationsCsvUrlUsingGET","consumes":["*/*"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FineRegistrationMatricesCsvUrl"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/pairs/{id}/coarse-registered":{"patch":{"tags":["scan-pair-controller"],"summary":"setScanCoarseRegistered","operationId":"setScanCoarseRegisteredUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"scanInfo","description":"scanInfo","required":true,"schema":{"$ref":"#/definitions/StatusDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/coarse-global-converted":{"patch":{"tags":["scan-controller"],"summary":"setScanCoarseGlobalConverted","operationId":"setScanCoarseGlobalConvertedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/converted-before-preprocessing":{"patch":{"tags":["scan-controller"],"summary":"setConvertedBeforePreprocessing","operationId":"setConvertedBeforePreprocessingUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/copied":{"patch":{"tags":["scan-controller"],"summary":"setScanCopied","operationId":"setScanCopiedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/exported":{"patch":{"tags":["scan-controller"],"summary":"setScanExported","operationId":"setScanExportedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/fine-registered":{"patch":{"tags":["scan-controller"],"summary":"setScanFineRegistered","operationId":"setScanFineRegisteredUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/potree-converted":{"patch":{"tags":["scan-controller"],"summary":"setScanPotreeConverted","operationId":"setScanPotreeConvertedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/scans/{scanId}/preprocessed":{"patch":{"tags":["scan-controller"],"summary":"setScanPreprocessed","operationId":"setScanPreprocessedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/PreprocessingCompletedMessage"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/survey-coordinate-report-txt":{"get":{"tags":["job-controller"],"summary":"getSurveyCoordinateReportTxtUrl","operationId":"getSurveyCoordinateReportTxtUrlUsingGET","consumes":["*/*"],"produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SurveyCoordinateReportTxtUrl"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/jobs/{jobId}/zip-exported-scans-failure":{"patch":{"tags":["job-controller"],"summary":"failZipExportedScansJob","operationId":"failZipExportedScansJobUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/JobFailureStatusDto"}},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JobDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/keys/{id}":{"delete":{"tags":["api-access-keys-controller"],"summary":"deleteKey","operationId":"deleteKeyUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/levels":{"post":{"tags":["level-controller"],"summary":"createLevel","operationId":"createLevelUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"levelPost","description":"levelPost","required":true,"schema":{"$ref":"#/definitions/LevelPost"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LevelDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/levels/{id}":{"get":{"tags":["level-controller"],"summary":"getLevel","operationId":"getLevelUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanGrapherLevel"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"put":{"tags":["level-controller"],"summary":"saveLevel","operationId":"saveLevelUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"in":"body","name":"levelPost","description":"levelPost","required":true,"schema":{"$ref":"#/definitions/LevelPost"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LevelDto"}}},"deprecated":false},"delete":{"tags":["level-controller"],"summary":"deleteLevel","operationId":"deleteLevelUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/company":{"get":{"tags":["Company"],"summary":"Get company","description":"Retrieves the details of the company associated with authentication token.","operationId":"companyGETUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"Company details if successful","schema":{"$ref":"#/definitions/CompanyDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"patch":{"tags":["Company"],"summary":"Update company","description":"Updates the information of the company associated with authentication token.","operationId":"companyPATCHUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Company information to update","required":false,"schema":{"$ref":"#/definitions/CompanyUpdateRequest"}}],"responses":{"200":{"description":"The company details with updated information if successful","schema":{"$ref":"#/definitions/CompanyDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/billing/transactions":{"get":{"tags":["Company"],"summary":"List company transactions","operationId":"companyBillingTransactionsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"chargeType","in":"query","description":"Charge type","required":false,"type":"string","enum":["ALL","USAGE","CREDIT"]},{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"endDate","in":"query","description":"End date","required":false,"type":"string","format":"date-time"},{"name":"id","in":"query","description":"Transaction id","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectIds","in":"query","description":"List of project ids. Must be used together with project type","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"projectType","in":"query","description":"Project type","required":false,"type":"string","enum":["JOB","V2SR","V2SC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separate by commas","required":false,"type":"array","items":{"type":"string","enum":["id","date"]},"collectionFormat":"multi","enum":["id","date"]},{"name":"startDate","in":"query","description":"Start date","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Company transactions","schema":{"$ref":"#/definitions/Paginated«CompanyTransactionDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/remote-storages":{"get":{"tags":["Company"],"summary":"Get company remote storages","description":"Get remote storages with (filtering, paging, sorting) of the company associated with authentication token.","operationId":"remoteStoragesGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"id","in":"query","description":"Key id for filtering","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separate by commas","required":false,"type":"array","items":{"type":"string","enum":["id","createdAt","name"]},"collectionFormat":"multi","default":"name","enum":["id","createdAt","name"]}],"responses":{"200":{"description":"Returned company remote storages","schema":{"$ref":"#/definitions/Paginated«AbstractRemoteStorageDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["Company"],"summary":"Creates remote storage","description":"Creates and validates new remote storage in a company of the admin user making this request","operationId":"remoteStoragesPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Remote storage details. Must match one of RemoteStorageCreateS3Request, RemoteStorageCreateAzureRequest, RemoteStorageDropboxRequest.","required":false,"schema":{"$ref":"#/definitions/RemoteStorageCreateRequest"}}],"responses":{"200":{"description":"Created remote storage","schema":{"$ref":"#/definitions/AbstractRemoteStorageDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/remote-storages/{id}":{"get":{"tags":["Company"],"summary":"List remote storage contents","description":"Returns paginated contents of a remote storage","operationId":"listRemoteStorageGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor.present","in":"query","required":false,"type":"boolean"},{"name":"folderId.present","in":"query","required":false,"type":"boolean"},{"name":"id","in":"path","description":"Remote storage id","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"type.present","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"Content of the remote storage","schema":{"$ref":"#/definitions/Paginated«RemoteDataDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"delete":{"tags":["Company"],"summary":"Deletes remote storage","description":"Deletes an existing remote storage in a company of the admin user making this request","operationId":"remoteStoragesDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Remote storage id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Remote storage successfully deleted"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"patch":{"tags":["Company"],"summary":"Update remote storage","description":"Updates an existing remote storage in a company of the admin user making this request","operationId":"remoteStoragesPATCHUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Remote storage id","required":false,"type":"integer","format":"int64"},{"in":"body","name":"remoteStorageUpdateRequest","description":" Remote storage details","required":false,"schema":{"$ref":"#/definitions/RemoteStorageUpdateRequest"}}],"responses":{"200":{"description":"Remote storage successfully updated","schema":{"$ref":"#/definitions/AbstractRemoteStorageDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/remote-storages/{id}/{remoteDataId}":{"get":{"tags":["Company"],"summary":"Get data in remote storage","operationId":"remoteStorageDataGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"remoteDataId","in":"path","description":"remoteDataId","required":true,"type":"string"}],"responses":{"200":{"description":"Data has been returned successfully","schema":{"$ref":"#/definitions/RemoteDataDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/storage":{"get":{"tags":["CompanyStorage"],"summary":"Get hosted storage files","description":"Retrieve files and folders from a company hosted storage","operationId":"storageGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor.present","in":"query","required":false,"type":"boolean"},{"name":"folderId.present","in":"query","required":false,"type":"boolean"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"type.present","in":"query","required":false,"type":"boolean"}],"responses":{"200":{"description":"Returns company hosted storage files","schema":{"$ref":"#/definitions/Paginated«DataDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"delete":{"tags":["CompanyStorage"],"summary":"Delete file or folder by it's id","operationId":"storageDataDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"in":"body","name":"storageDataDeleteRequest","description":"storageDataDeleteRequest","required":true,"schema":{"$ref":"#/definitions/StorageDataDeleteRequest"}}],"responses":{"200":{"description":"File or folder deleted successfully","schema":{"$ref":"#/definitions/ResponseEntity"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/storage/browser/access/{cookieId}":{"get":{"tags":["CompanyStorage"],"summary":"Generate access cookies for a cookie id","operationId":"generateAccessCookiesGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cookieId","in":"path","description":"Cookie id of a file or folder","required":false,"type":"string"}],"responses":{"200":{"description":"Cookie generated successfully","schema":{"$ref":"#/definitions/ResponseEntity"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/storage/browser/upload":{"post":{"tags":["CompanyStorage"],"summary":"Validate and start hosted storage upload","description":"Performs all the necessary steps before uploading files to the hosted storage:\n","operationId":"storageUploadPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"browserUploadRequest","description":"browserUploadRequest","required":true,"schema":{"$ref":"#/definitions/BrowserUploadRequest"}}],"responses":{"200":{"description":"Returns validation results","schema":{"$ref":"#/definitions/BrowserUploadDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/storage/browser/upload/complete":{"put":{"tags":["CompanyStorage"],"summary":"Complete upload that was previously started by storageUploadPOST","description":"Validates that files were uploaded successfully and updates isUploading flags accordingly","operationId":"storageUploadCompletePUTUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"browserUploadRequest","description":"browserUploadRequest","required":true,"schema":{"$ref":"#/definitions/BrowserUploadCompleteRequest"}}],"responses":{"200":{"description":"Upload completed successfully","schema":{"$ref":"#/definitions/ResponseEntity"}},"400":{"description":"If the data in the request is incorrect or some of the files were not uploaded","schema":{"$ref":"#/definitions/Errors"}}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/storage/folders":{"post":{"tags":["CompanyStorage"],"summary":"Create a folder in vercator storage","operationId":"createStorageFolderPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"createFolderRequest","description":"createFolderRequest","required":true,"schema":{"$ref":"#/definitions/CreateFolderRequest"}}],"responses":{"200":{"description":"Folder created successfully","schema":{"$ref":"#/definitions/DataDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/storage/{dataId}":{"get":{"tags":["CompanyStorage"],"summary":"Get file or folder in vercator storage","operationId":"storageDataGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"dataId","in":"path","description":"dataId","required":true,"type":"string"}],"responses":{"200":{"description":"Data has been returned successfully","schema":{"$ref":"#/definitions/DataDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/users":{"get":{"tags":["Company"],"summary":"Get company users","description":"Get company users with (filtering, paging, sorting) of the company associated with authentication token.","operationId":"companyUsersGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"id","in":"query","description":"Key id for filtering","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separate by commas","required":false,"type":"array","items":{"type":"string","enum":["id","createdAt","firstName","lastName","emailAddress"]},"collectionFormat":"multi","default":"[firstName]","enum":["id","createdAt","firstName","lastName","emailAddress"]}],"responses":{"200":{"description":"Returned company users","schema":{"$ref":"#/definitions/Paginated«UserAdminDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["Company"],"summary":"Create a user","description":"Creates a new user in the company associated with authentication token","operationId":"companyUsersPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Details of the user to create","required":false,"schema":{"$ref":"#/definitions/CompanyUserCreateRequest"}}],"responses":{"200":{"description":"The created user details","schema":{"$ref":"#/definitions/UserAdminDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/users/{userId}":{"delete":{"tags":["Company"],"summary":"Delete company user","description":"Delete company user of the company associated with authentication token.","operationId":"companyUsersDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User id for filtering","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"User removed successfully"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"patch":{"tags":["Company"],"summary":"Updates a user","description":"Updating details and/or authorizations of a user associated with the company of the admin user making this request","operationId":"companyUserPATCHUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Details of the user to update","required":false,"schema":{"$ref":"#/definitions/CompanyUserUpdateRequest"}},{"name":"userId","in":"path","description":"User Id to be updated","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"The updated user details","schema":{"$ref":"#/definitions/UserAdminDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/users/{userId}/keys":{"get":{"tags":["Company"],"summary":"Get company user API access keys ","description":"Get API access keys of the company user (with filtering, paging, sorting)","operationId":"userKeysGETUsingGET_2","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"id","in":"query","description":"Key id for filtering","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separate by commas","required":false,"type":"array","items":{"type":"string","enum":["id","createdAt"]},"collectionFormat":"multi","default":"id","enum":["id","createdAt"]},{"name":"userId","in":"path","description":"User Id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Returned company user's API access keys","schema":{"$ref":"#/definitions/Paginated«UserKeyDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["Company"],"summary":"Create API access key","description":"Create API access key for the user","operationId":"usersKeysPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Information about access key","required":false,"schema":{"$ref":"#/definitions/UserKeyCreateRequest"}},{"name":"userId","in":"path","description":"User Id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success code if the access key has been created","schema":{"$ref":"#/definitions/CreatedUserKeyDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/company/users/{userId}/keys/{keyId}":{"delete":{"tags":["Company"],"summary":"Delete company user access key","description":"Delete access key of company user by id","operationId":"userKeysDELETEUsingDELETE_2","produces":["application/json"],"parameters":[{"name":"keyId","in":"path","description":"Access Key Id","required":false,"type":"integer","format":"int64"},{"name":"userId","in":"path","description":"User Id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Access Key removed successfully"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"If user associated with authentication token is not a company admin","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/profile":{"get":{"tags":["Profile"],"summary":"Get profile","description":"Retrieves all the details associated with logged in credentials.","operationId":"profileGETUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"The profile details if successful","schema":{"$ref":"#/definitions/ProfileDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects":{"get":{"tags":["Project"],"summary":"Get user's project","description":"Get projects with (filtering, paging, sorting) of the user associated with the authentication token.","operationId":"projectsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"id","in":"query","description":"Key id for filtering","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Name for filtering","required":false,"type":"string"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name"]},"collectionFormat":"multi","default":"id","enum":["id","name"]}],"responses":{"200":{"description":"Returned user's projects","schema":{"$ref":"#/definitions/Paginated«ProjectDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["Project"],"summary":"Create a project","description":"Creates a new project in the company associated with authentication token","operationId":"companyProjectPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Details of the project to create","required":false,"schema":{"$ref":"#/definitions/ProjectCreateRequest"}}],"responses":{"200":{"description":"The created project details","schema":{"$ref":"#/definitions/ProjectDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}":{"delete":{"tags":["Project"],"summary":"Delete user's project","description":"Deletes empty users project or returns error if a project contains any jobs","operationId":"projectsDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Deletion done"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"patch":{"tags":["Project"],"summary":"Update a project","description":"Update an existing project in the company associated with authentication token","operationId":"updateCompanyProjectPATCHUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project id","required":false,"type":"integer","format":"int64"},{"in":"body","name":"projectUpdateRequest","description":"Details of the project to update","required":false,"schema":{"$ref":"#/definitions/ProjectUpdateRequest"}}],"responses":{"200":{"description":"The updated project details","schema":{"$ref":"#/definitions/ProjectDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/auto-registration":{"get":{"tags":["AutoRegistrationJob"],"summary":"Get project's automatic registration jobs","description":"Get automatic registration jobs associated with project using filters, pagination and sorting","operationId":"registrationJobsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned automatic registration jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["AutoRegistrationJob"],"summary":"Run a new automatic registration job","description":"Run a new automatic registration job","operationId":"runRegistrationJobPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"registrationRunCreateRequest","description":"Details of the automatic registration job to run","required":false,"schema":{"$ref":"#/definitions/AutoRegistrationRunCreateRequest"}}],"responses":{"200":{"description":"The automatic registration job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/auto-registration/{runId}":{"delete":{"tags":["AutoRegistrationJob"],"summary":"Delete an Auto Registration job","description":"Deletes an Auto Registration job. Will fail if a job is still in progress","operationId":"registrationJobDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Job deletion started"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/auto-registration/{runId}/inputs":{"get":{"tags":["AutoRegistrationJob"],"summary":"Get input of a run of an automatic registration job","description":"Get input of a run of an automatic registration job","operationId":"registrationJobsRunInputGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an automatic registration job","schema":{"$ref":"#/definitions/AutoRegistrationRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/auto-registration/{runId}/outputs":{"get":{"tags":["AutoRegistrationJob"],"summary":"Get outputs of a run of an automatic registration job","description":"Get outputs of a run of an automatic registration job","operationId":"registrationJobsRunOutputsGETUsingGET_2","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Automatic registration job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an automatic registration job","schema":{"$ref":"#/definitions/AutoRegistrationRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/auto-registration/{runId}/status":{"get":{"tags":["AutoRegistrationJob"],"summary":"Get status of a run of an automatic registration job","description":"Get status of a run of an automatic registration job","operationId":"registrationJobsRunStatusGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Automatic registration job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an automatic registration job","schema":{"$ref":"#/definitions/RunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/export":{"get":{"tags":["ExportJob"],"summary":"Get project's export jobs","description":"Get export jobs associated with project using filters, pagination and sorting ","operationId":"exportJobsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned export jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["ExportJob"],"summary":"Run a new export job","description":"Run a new export job","operationId":"runExportJobPostUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"exportRunCreateRequest","description":"exportRunCreateRequest","required":true,"schema":{"$ref":"#/definitions/ExportRunCreateRequest"}},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"The export job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/export/{runId}":{"delete":{"tags":["ExportJob"],"summary":"Delete an export job","description":"Deletes an export job. Will fail if a job is still in progress","operationId":"exportJobDELETEUsingDELETE_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an export job"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/export/{runId}/inputs":{"get":{"tags":["ExportJob"],"summary":"Get inputs of a run of an Export job","description":"Get inputs of a run of an Export job","operationId":"exportJobsRunInputsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Export job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned inputs of a run of an export job","schema":{"$ref":"#/definitions/ExportRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/export/{runId}/outputs":{"get":{"tags":["ExportJob"],"summary":"Get outputs of a run of an Export job","description":"Get outputs of a run of an Export job","operationId":"exportJobsRunOutputsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Export job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an export job","schema":{"$ref":"#/definitions/ExportRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/export/{runId}/status":{"get":{"tags":["ExportJob"],"summary":"Get status of a run of an Export job","description":"Get status of a run of an Export job","operationId":"exportJobsRunStatusGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Export job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an export job","schema":{"$ref":"#/definitions/RunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/georeferencing":{"get":{"tags":["GeoReferencing"],"summary":"Get project's geo referencing jobs","description":"Get geo referencing jobs associated with project using filters, pagination and sorting","operationId":"geoReferencingJobsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned geo referencing jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["GeoReferencing"],"summary":"Run a new geo referencing job","description":"Run a new geo referencing job","operationId":"runGeoReferencingJobPOSTUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"geoReferencingRunCreateRequest","description":"Details of the geo referencing job to run","required":false,"schema":{"$ref":"#/definitions/GeoReferencingRunCreateRequest"}},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"The geo referencing job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/georeferencing/{runId}":{"delete":{"tags":["GeoReferencing"],"summary":"Delete a geo referencing job","description":"Deletes a geo referencing job. Will fail if a job is still in progress","operationId":"geoReferencingJobDELETEUsingDELETE_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Job deleted"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/georeferencing/{runId}/inputs":{"get":{"tags":["GeoReferencing"],"summary":"Get input of a run of a geo referencing job","description":"Get input of a run of a geo referencing job","operationId":"geoReferencingJobsRunInputGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of a geo referencing job","schema":{"$ref":"#/definitions/GeoReferencingRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/georeferencing/{runId}/outputs":{"get":{"tags":["GeoReferencing"],"summary":"Get outputs of a run of a geo referencing job","description":"Get outputs of a run of a geo referencing job","operationId":"geoReferencingJobsRunOutputsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"geo referencing job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a geo referencing job","schema":{"$ref":"#/definitions/GeoReferencingRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/import":{"get":{"tags":["ImportJob"],"summary":"Get project's import jobs","description":"Get import jobs associated with project using filters, pagination and sorting ","operationId":"importJobsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned import jobs","schema":{"$ref":"#/definitions/Paginated«ImportRunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["ImportJob"],"summary":"Run a new import job","description":"Run a new import job","operationId":"runImportJobPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"Details of the import job to run","required":false,"schema":{"$ref":"#/definitions/ImportRunCreateRequest"}}],"responses":{"200":{"description":"The import job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/import/{runId}":{"delete":{"tags":["ImportJob"],"summary":"Delete an import job","description":"Deletes an import job. Will fail if a job is still in progress","operationId":"importJobDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an import job"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/import/{runId}/inputs":{"get":{"tags":["ImportJob"],"summary":"Get input of a run of an Import job","description":"Get input of a run of an Import job","operationId":"importJobsRunInputGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an import job","schema":{"$ref":"#/definitions/ImportRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/import/{runId}/outputs":{"get":{"tags":["ImportJob"],"summary":"Get output of a run of an Import job","description":"Get output of a run of an Import job","operationId":"importJobsRunOutputGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"outputIds","in":"query","description":"Output Ids that is associated with the job","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi","allowEmptyValue":false},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an import job","schema":{"$ref":"#/definitions/ImportRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/import/{runId}/status":{"get":{"tags":["ImportJob"],"summary":"Get status of a run of an Import job","description":"Get status of a run of an Import job","operationId":"importJobsRunStatusGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an import job","schema":{"$ref":"#/definitions/RunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/manual-registration":{"get":{"tags":["ManualRegistrationJob"],"summary":"Get project's manual registration jobs","description":"Get manual registration jobs associated with project using filters, pagination and sorting","operationId":"manualRegistrationJobsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned manual registration jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["ManualRegistrationJob"],"summary":"Run a new manual registration job","description":"Run a new manual registration job","operationId":"runManualRegistrationJobPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"registrationRunCreateRequest","description":"Details of the manual registration job to run","required":false,"schema":{"$ref":"#/definitions/ManualRegistrationRunCreateRequest"}}],"responses":{"200":{"description":"The manual registration job that will be stored","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/manual-registration/apply-changes":{"post":{"tags":["ManualRegistrationJob"],"summary":"Computes the optimal transformation matrix of each point cloud based on all pairwise transformations","description":"Computes the optimal transformation matrix of each point cloud based on all pairwise transformations","operationId":"applyPairwiseRegistrationPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"Details of pairwise registration request","required":false,"schema":{"$ref":"#/definitions/ProcessPairwiseRegistrationsRequest"}}],"responses":{"200":{"description":"Returned result of a run of pairwise transformations","schema":{"$ref":"#/definitions/ProcessPairwiseRegistrationsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/manual-registration/{runId}":{"delete":{"tags":["ManualRegistrationJob"],"summary":"Delete a Manual Registration job","description":"Deletes a Manual Registration job. Will fail if a job is still in progress","operationId":"manualRegistrationJobDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Job deleted"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/manual-registration/{runId}/inputs":{"get":{"tags":["ManualRegistrationJob"],"summary":"Get input of a run of a manual registration job","description":"Get input of a run of a manual registration job","operationId":"manualRegistrationJobsRunInputGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of a manual registration job","schema":{"$ref":"#/definitions/ManualRegistrationRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/manual-registration/{runId}/outputs":{"get":{"tags":["ManualRegistrationJob"],"summary":"Get outputs of a run of a manual registration job","description":"Get outputs of a run of a manual registration job","operationId":"registrationJobsRunOutputsGETUsingGET_3","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Manual registration job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a manual registration job","schema":{"$ref":"#/definitions/ManualRegistrationRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/merge":{"get":{"tags":["MergeJob"],"summary":"Get project's merge jobs","description":"Get merge jobs associated with project using filters, pagination and sorting ","operationId":"mergeJobsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned merge jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["MergeJob"],"summary":"Run a new merge job","description":"Run a new merge job","operationId":"runMergeJobPostUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"mergeRunCreateRequest","description":"mergeRunCreateRequest","required":true,"schema":{"$ref":"#/definitions/MergeRunCreateRequest"}},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"The merge job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/merge/{runId}":{"delete":{"tags":["MergeJob"],"summary":"Delete a Merge job","description":"Deletes a Merge job. Will fail if a job is still in progress","operationId":"mergeJobDELETEUsingDELETE_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"If job deletion was triggered successfully"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/merge/{runId}/inputs":{"get":{"tags":["MergeJob"],"summary":"Get input of a run of a Merge job","description":"Get input of a run of a Merge job","operationId":"mergeJobsRunInputGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of a merge job","schema":{"$ref":"#/definitions/MergeRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/merge/{runId}/outputs":{"get":{"tags":["MergeJob"],"summary":"Get outputs of a run of a Merge job","description":"Get outputs of a run of a Merge job","operationId":"mergeJobsRunOutputsGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Merge job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a merge job","schema":{"$ref":"#/definitions/MergeRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/merge/{runId}/outputs/instances":{"get":{"tags":["MergeJob"],"summary":"Get class instances from a Merge job","description":"Get paginated instances of a class from a classified Merge job","operationId":"mergeJobInstancesGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"classId","in":"query","description":"Class id to retrieve instances from","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned class instances of a merge job","schema":{"$ref":"#/definitions/Paginated«PointCloudClassInstanceDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/merge/{runId}/status":{"get":{"tags":["MergeJob"],"summary":"Get status of a run of a Merge job","description":"Get status of a run of a Merge job","operationId":"mergeJobsRunStatusGETUsingGET_1","produces":["*/*"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Merge job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of a merge job","schema":{"$ref":"#/definitions/RunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/optimise-registration":{"get":{"tags":["OptimiseRegistrationJob"],"summary":"Get project's optimise registration jobs","description":"Get optimise registration jobs associated with project using filters, pagination and sorting","operationId":"optimiseRegistrationJobsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned optimise registration jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["OptimiseRegistrationJob"],"summary":"Run a new optimise registration job","description":"Run a new optimise registration job","operationId":"runOptimiseRegistrationJobPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"Details of the optimise registration job to run","required":false,"schema":{"$ref":"#/definitions/OptimiseRegistrationRunCreateRequest"}}],"responses":{"200":{"description":"The optimise registration job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/optimise-registration/{runId}":{"delete":{"tags":["OptimiseRegistrationJob"],"summary":"Delete an Optimise Registration job","description":"Deletes an Optimise Registration job. Will fail if a job is still in progress","operationId":"optimiseRegistrationJobDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"If job deletion was triggered successfully"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/optimise-registration/{runId}/inputs":{"get":{"tags":["OptimiseRegistrationJob"],"summary":"Get input of a run of an optimise registration job","description":"Get input of a run of an optimise registration job","operationId":"optimiseRegistrationJobsRunInputGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an optimise registration job","schema":{"$ref":"#/definitions/OptimiseRegistrationRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/optimise-registration/{runId}/outputs":{"get":{"tags":["OptimiseRegistrationJob"],"summary":"Get outputs of a run of an optimise registration job","description":"Get outputs of a run of an optimise registration job","operationId":"optimiseRegistrationJobsRunOutputsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"optimise registration job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an optimise registration job","schema":{"$ref":"#/definitions/OptimiseRegistrationRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/optimise-registration/{runId}/status":{"get":{"tags":["OptimiseRegistrationJob"],"summary":"Get status of a run of an optimise registration job","description":"Get status of a run of an optimise registration job","operationId":"optimiseRegistrationJobsRunStatusGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Optimise registration job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an optimise registration job","schema":{"$ref":"#/definitions/RunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/registration-qa":{"get":{"tags":["RegistrationQAJob"],"summary":"Get project's registration QA jobs","description":"Get registration QA jobs associated with project using filters, pagination and sorting","operationId":"registrationQAJobsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"registrationJob","in":"query","description":"Registration job for filtering with format Job_Type|Job_Id","required":false,"type":"string"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned registration QA jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["RegistrationQAJob"],"summary":"Run a new registration QA job","description":"Run a new registration QA job","operationId":"runRegistrationQAJobPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"Details of the registration QA job to run","required":false,"schema":{"$ref":"#/definitions/RegistrationQARunCreateRequest"}}],"responses":{"200":{"description":"The registration QA job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/registration-qa/{runId}":{"delete":{"tags":["RegistrationQAJob"],"summary":"Delete a registration QA job","description":"Deletes a registration QA job. Will fail if a job is still in progress","operationId":"registrationQAJobDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a registration QA job"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/registration-qa/{runId}/inputs":{"get":{"tags":["RegistrationQAJob"],"summary":"Get input of a run of a registration QA job","description":"Get input of a run of a registration QA job","operationId":"registrationQAJobsRunInputGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of a registration QA job","schema":{"$ref":"#/definitions/RegistrationQARunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/registration-qa/{runId}/outputs":{"get":{"tags":["RegistrationQAJob"],"summary":"Get outputs of a run of a registration QA job","description":"Get outputs of a run of a registration QA job","operationId":"registrationQAJobsRunOutputsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Registration QA job run id","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a registration QA job","schema":{"$ref":"#/definitions/RegistrationQARunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/segmentation":{"get":{"tags":["SegmentationJob"],"summary":"Get project's segmentation jobs","description":"Get segmentation jobs associated with project using filters, pagination and sorting ","operationId":"segmentationJobsGETUsingGET_3","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"groupName","in":"query","description":"Group Name for filtering","required":false,"type":"string"},{"name":"ids","in":"query","description":"Run IDs for filtering","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","startedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","startedAt"]},{"name":"status","in":"query","description":"Status for filtering","required":false,"type":"string","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}],"responses":{"200":{"description":"Returned segmentation jobs","schema":{"$ref":"#/definitions/Paginated«RunSummaryDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["SegmentationJob"],"summary":"Run a new segmentation job","description":"Run a new segmentation job","operationId":"runSegmentationJobPOSTUsingPOST_3","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"Details of the segmentation job to run","required":false,"schema":{"$ref":"#/definitions/SegmentationRunCreateRequest"}}],"responses":{"200":{"description":"The segmentation job that will be run","schema":{"$ref":"#/definitions/RunSummaryDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/segmentation/{runId}":{"delete":{"tags":["SegmentationJob"],"summary":"Delete a Segmentation job","description":"Deletes a Segmentation job. Will fail if a job is still in progress","operationId":"segmentationJobDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of a Segmentation job"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/segmentation/{runId}/inputs":{"get":{"tags":["SegmentationJob"],"summary":"Get input of a run of an Segmentation job","description":"Get input of a run of an Segmentation job","operationId":"segmentationJobsRunInputGETUsingGET_3","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an Segmentation job","schema":{"$ref":"#/definitions/SegmentationRunCreateRequest"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/segmentation/{runId}/outputs":{"get":{"tags":["SegmentationJob"],"summary":"Get output of a run of an Segmentation job","description":"Get output of a run of an Segmentation job","operationId":"segmentationJobsRunOutputGETUsingGET_3","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned outputs of a run of an Segmentation job","schema":{"$ref":"#/definitions/SegmentationRunOutputsDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/segmentation/{runId}/outputs/instances":{"get":{"tags":["SegmentationJob"],"summary":"Get class instances from a Segmentation job","description":"Get paginated instances of a class from a Segmentation job","operationId":"segmentationJobInstancesGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"classId","in":"query","description":"Class id to retrieve instances from","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned class instances of a segmentation job","schema":{"$ref":"#/definitions/Paginated«PointCloudClassInstanceDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/runs/segmentation/{runId}/status":{"get":{"tags":["SegmentationJob"],"summary":"Get status of a run of an Segmentation job","description":"Get status of a run of an Segmentation job","operationId":"segmentationJobsRunStatusGETUsingGET_3","produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project Id that is associated with the job","required":false,"type":"integer","format":"int64"},{"name":"runId","in":"path","description":"Run Id that is associated with the job","required":false,"type":"string"}],"responses":{"200":{"description":"Returned status of a run of an segmentation job","schema":{"$ref":"#/definitions/RunStatusDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/projects/{projectId}/user_settings":{"put":{"tags":["Project"],"summary":"Update a user's setting of a project","description":"Update settings of project for the user associated with the authentication token.","operationId":"projectsUserSettingsPUTUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"Project id","required":false,"type":"integer","format":"int64"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/ProjectUserSettingsRequest"}}],"responses":{"200":{"description":"User settings of project have been updated successfully"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/public/activate":{"post":{"tags":["Public Endpoints"],"summary":"Activate user","description":"Activates user by confirming the associated e-mail. Using token received in the activation e-mail","operationId":"activateEmailPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"activation details","required":false,"schema":{"$ref":"#/definitions/ActivateEmailRequest"}}],"responses":{"200":{"description":"User activation if successful"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/activate/token":{"post":{"tags":["Public Endpoints"],"summary":"Request new activation token","description":"Request new activation token to be sent to user's associated e-mail. Using token received in the activation e-mail","operationId":"activateEmailNewTokenPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/ActivateEmailNewTokenRequest"}}],"responses":{"200":{"description":"New activation token has been sent to user's associated e-mail"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/info":{"get":{"tags":["System"],"summary":"Web API properties","description":"Retrieves relevant configuration properties to be used by consumers of this API.","operationId":"apiInfoGETUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"The Web API configuration properties","schema":{"$ref":"#/definitions/WebApiInfoDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/login":{"post":{"tags":["Public Endpoints"],"summary":"Authenticates a user","description":"Performs username / password authentication to Vercator. Retrieving an authentication token that can be used on subsequent calls to endpoints that require authentication.","operationId":"loginPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"login details","required":false,"schema":{"$ref":"#/definitions/LoginRequest"}}],"responses":{"200":{"description":"User authentication if successful","schema":{"$ref":"#/definitions/LoginDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"If the authentication fails","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/login-visualisation":{"post":{"tags":["Visualisation"],"summary":"Visualisation login","description":"Generate JWT token to access visualisation","operationId":"loginVisualisationPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"visualisationLoginRequest","description":"visualisationLoginRequest","required":true,"schema":{"$ref":"#/definitions/VisualisationLoginRequest"}}],"responses":{"200":{"description":"JWT token","schema":{"$ref":"#/definitions/VisualisationTokenDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/logout":{"post":{"tags":["Public Endpoints"],"summary":"Revokes a user session","description":"Revokes the current user authentication token in Vercator.","operationId":"logoutPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"If session revoked successfully"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"If the user is not currently authenticated.","schema":{"$ref":"#/definitions/Errors"}}},"deprecated":false}},"/webapi/new/public/reset":{"post":{"tags":["Public Endpoints"],"summary":"Reset user password","description":"Resets user's password using recovery token received by e-mail","operationId":"passwordResetPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"reset details","required":false,"schema":{"$ref":"#/definitions/PasswordResetRequest"}}],"responses":{"200":{"description":"If user's password was reset successfully"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/reset/token":{"post":{"tags":["Public Endpoints"],"summary":"Request new reset password token","description":"Request new reset password token to be sent to user's e-mail","operationId":"passwordResetNewTokenPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"user details","required":false,"schema":{"$ref":"#/definitions/PasswordResetNewTokenRequest"}}],"responses":{"200":{"description":"New reset password token has been sent to user's e-mail"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/public/signup":{"post":{"tags":["Public Endpoints"],"summary":"Signup","description":"Performs the signup of a new company and an admin user","operationId":"signupPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"signup details","required":false,"schema":{"$ref":"#/definitions/SignupRequest"}}],"responses":{"200":{"description":"New company and admin user are successfully created"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/new/user":{"get":{"tags":["User"],"summary":"Get user","description":"Retrieves the details of the user associated with authentication token","operationId":"userGETUsingGET_1","produces":["application/json"],"responses":{"200":{"description":"User details if successful","schema":{"$ref":"#/definitions/UserDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"patch":{"tags":["User"],"summary":"Update user","description":"Updates the information of the user associated with authentication token","operationId":"userPATCHUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"User information to update","required":false,"schema":{"$ref":"#/definitions/UserUpdateRequest"}}],"responses":{"200":{"description":"The user details with updated information if successful","schema":{"$ref":"#/definitions/UserDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/user/keys":{"get":{"tags":["User"],"summary":"Get user's API access keys ","description":"Get API access keys with (filtering, paging, sorting) of the user associated with authentication token.","operationId":"userKeysGETUsingGET_3","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"id","in":"query","description":"Key id for filtering","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separate by commas","required":false,"type":"array","items":{"type":"string","enum":["id","createdAt"]},"collectionFormat":"multi","default":"id","enum":["id","createdAt"]}],"responses":{"200":{"description":"Returned user's API access keys","schema":{"$ref":"#/definitions/Paginated«UserKeyDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["User"],"summary":"Create API access key","description":"Create API access key for the user associated with authentication token","operationId":"userKeysPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Information about access key","required":false,"schema":{"$ref":"#/definitions/UserKeyCreateRequest"}}],"responses":{"200":{"description":"Success code if the access key has been created","schema":{"$ref":"#/definitions/CreatedUserKeyDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/user/keys/{id}":{"delete":{"tags":["User"],"summary":"Delete user access key","description":"Delete access key of user associated with authentication token.","operationId":"userKeysDELETEUsingDELETE_3","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Access Key Id","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Access Key removed successfully"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/user/password":{"put":{"tags":["User"],"summary":"Change a user's password","description":"Changes the password of the user associated with authentication token","operationId":"userChangePasswordPUTUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"User's old and new passwords","required":false,"schema":{"$ref":"#/definitions/UserChangePasswordRequest"}}],"responses":{"200":{"description":"Success code if the password has been changed"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/users":{"get":{"tags":["Users"],"summary":"Get public information of users in a company ","description":"Get public information of users with (filtering, paging, sorting) of the company associated with authentication token.","operationId":"usersPublicGetUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"id","in":"query","description":"Key id for filtering","required":false,"type":"integer","format":"int64"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separate by commas","required":false,"type":"array","items":{"type":"string","enum":["id","firstName","lastName"]},"collectionFormat":"multi","default":"id","enum":["id","firstName","lastName"]}],"responses":{"200":{"description":"Returns public user information","schema":{"$ref":"#/definitions/Paginated«UserPublicDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/visualisation/{visualisationId}/data":{"get":{"tags":["Visualisation"],"summary":"Visualisation data","description":"Get visualisation data","operationId":"visualisationDataGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"visualisationId","in":"path","description":"visualisationId","required":true,"type":"string"}],"responses":{"200":{"description":"Visualisation data and cookies","schema":{"$ref":"#/definitions/VisualisationDataDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/visualisation/{visualisationId}/data/instances":{"get":{"tags":["Visualisation"],"summary":"Get class instances from visualisation","description":"Get paginated instances of a class from a segmented point cloud visualisation","operationId":"visualisationDataInstancesGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"classId","in":"query","description":"Class id to retrieve instances from","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"visualisationId","in":"path","description":"Visualisation ID","required":false,"type":"string"}],"responses":{"200":{"description":"Returned class instances of a visualisation","schema":{"$ref":"#/definitions/Paginated«PointCloudClassInstanceDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/visualisations":{"get":{"tags":["Visualisation"],"summary":"Get visualisation list","description":"Get a list of visualisations","operationId":"visualisationJobsGETUsingGET_1","produces":["application/json"],"parameters":[{"name":"cursor","in":"query","description":"Paging Cursor (base64 encoded)","required":false,"type":"string"},{"name":"ids","in":"query","description":"Visualisation IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jobId","in":"query","description":"Job ID","required":false,"type":"string"},{"name":"jobType","in":"query","description":"Job type","required":false,"type":"string","enum":["SEGMENTATION","MERGE"]},{"name":"limit.present","in":"query","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Visualisation name","required":false,"type":"string"},{"name":"order","in":"query","description":"Controls if sorting is done in ascending or descending order","required":false,"type":"string","default":"ASC","enum":["ASC","DESC"]},{"name":"projectId","in":"query","description":"Project id","required":false,"type":"integer","format":"int64"},{"name":"sort","in":"query","description":"Fields for sorting. Supports one or more fields separated by commas","required":false,"type":"array","items":{"type":"string","enum":["id","name","lastAccessedAt"]},"collectionFormat":"multi","default":"name","enum":["id","name","lastAccessedAt"]}],"responses":{"200":{"description":"Returned visualisations","schema":{"$ref":"#/definitions/Paginated«VisualisationDto»"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false},"post":{"tags":["Visualisation"],"summary":"Create a new visualisation","description":"Run a new automatic registration job","operationId":"createVisualisationPOSTUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"request","description":"Details of the visualisation","required":false,"schema":{"$ref":"#/definitions/VisualisationCreateRequest"}}],"responses":{"200":{"description":"Created visualisation","schema":{"$ref":"#/definitions/VisualisationDto"}},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/new/visualisations/{visualisationId}":{"delete":{"tags":["Visualisation"],"summary":"Delete a visualisation","description":"Deletes a visualisation","operationId":"visualisationDELETEUsingDELETE_1","produces":["application/json"],"parameters":[{"name":"visualisationId","in":"path","description":"Visualisation id","required":false,"type":"string"}],"responses":{"200":{"description":"Deleted successfully"},"400":{"description":"If the data in the request is incorrect","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"security":[{"Authentication Header":[]}],"deprecated":false}},"/webapi/pairs/{id}/registration-statistics":{"patch":{"tags":["scan-pair-controller"],"summary":"setScanPairRegistrationStatistics","operationId":"setScanPairRegistrationStatisticsUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"in":"body","name":"registrationStatistics","description":"registrationStatistics","required":true,"schema":{"$ref":"#/definitions/ScanPairRegistrationStatisticsDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects":{"get":{"tags":["project-controller"],"summary":"getProjects","operationId":"getProjectsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RegistrationProjectDto"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}":{"get":{"tags":["project-controller"],"summary":"getProject","operationId":"getProjectUsingGET_1","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"delete":{"tags":["project-controller"],"summary":"deleteProject","operationId":"deleteProjectUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}/config":{"get":{"tags":["project-controller"],"summary":"getProjectConfiguration","operationId":"getProjectConfigurationUsingGET","consumes":["*/*"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VercatorConfigDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"put":{"tags":["project-controller"],"summary":"setProjectConfiguration","operationId":"setProjectConfigurationUsingPUT","consumes":["*/*"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/VercatorConfigPostDto"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}}},"deprecated":false}},"/webapi/projects/{id}/details":{"post":{"tags":["project-controller"],"summary":"updateProject","operationId":"updateProjectUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ProjectPost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}/exports":{"get":{"tags":["project-controller"],"summary":"getProjectsExports","operationId":"getProjectsExportsUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ExportJobDto"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}/jobs":{"post":{"tags":["job-controller"],"summary":"createJob","operationId":"createJobUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/JobPost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/JobDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}/pairs":{"put":{"tags":["project-controller"],"summary":"setProjectPairs","operationId":"setProjectPairsUsingPUT","consumes":["*/*"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ScanPairsPost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WebProjectDto"}}},"deprecated":false}},"/webapi/projects/{id}/scangrapher":{"post":{"tags":["project-controller"],"summary":"updateProjectScans","operationId":"updateProjectScansUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ScanGrapherPost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}/scans":{"post":{"tags":["project-controller"],"summary":"addProjectScans","operationId":"addProjectScansUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/WebScansPost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WebProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"delete":{"tags":["project-controller"],"summary":"deleteProjectScans","operationId":"deleteProjectScansUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ScansDeletePost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{id}/security":{"get":{"tags":["file-security-controller"],"summary":"getProjectCookie","operationId":"getProjectCookieUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{projectId}/jobs/{exportJobId}/share":{"post":{"tags":["project-controller"],"summary":"shareExportedScans","operationId":"shareExportedScansUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"exportJobId","in":"path","description":"exportJobId","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"requestBody","description":"requestBody","required":true,"schema":{"$ref":"#/definitions/ShareExportsDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExportsSharedDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{projectId}/project-transformation-matrix-calculated":{"patch":{"tags":["survey-coordinates-controller"],"summary":"updateProjectTransformation","operationId":"updateProjectTransformationUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{projectId}/scantargetlinks":{"post":{"tags":["scan-target-link-controller"],"summary":"createScanTargetLink","operationId":"createScanTargetLinkUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"link","description":"link","required":true,"schema":{"$ref":"#/definitions/ScanTargetLinkDto"}},{"name":"projectId","in":"path","description":"projectId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/projects/{projectId}/surveytargets":{"post":{"tags":["survey-target-controller"],"summary":"addSurveyTargets","operationId":"addSurveyTargetsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"projectId","in":"path","description":"projectId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"surveyTargets","description":"surveyTargets","required":true,"schema":{"$ref":"#/definitions/SurveyTargetsPost"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-conversion-utility":{"get":{"tags":["scan-conversion-utility-controller"],"summary":"getAllScanConversionProjects","operationId":"getAllScanConversionProjectsUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ScanConversionUtilityProject"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"post":{"tags":["scan-conversion-utility-controller"],"summary":"createScanConversionMetaData","operationId":"createScanConversionMetaDataUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"scanConversionUtilityProject","description":"scanConversionUtilityProject","required":true,"schema":{"$ref":"#/definitions/ScanConversionUtilityProject"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanConversionUtilityProject"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-conversion-utility/start-processing":{"post":{"tags":["scan-conversion-utility-controller"],"summary":"startProcessing","operationId":"startProcessingUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"scanConversionUtilityProject","description":"scanConversionUtilityProject","required":true,"schema":{"$ref":"#/definitions/ScanConversionUtilityProject"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanConversionUtilityProject"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-conversion-utility/{id}":{"get":{"tags":["scan-conversion-utility-controller"],"summary":"getScanConversionProject","operationId":"getScanConversionProjectUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanConversionUtilityProject"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"put":{"tags":["scan-conversion-utility-controller"],"summary":"updateScanConversionMetaData","operationId":"updateScanConversionMetaDataUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"in":"body","name":"scanConversionUtilityProjectDto","description":"scanConversionUtilityProjectDto","required":true,"schema":{"$ref":"#/definitions/ScanConversionUtilityProjectDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanConversionUtilityProject"}}},"deprecated":false}},"/webapi/scan-format-conversion/{id}":{"get":{"tags":["scan-format-conversion-controller"],"summary":"getScanConversionTask","operationId":"getScanConversionTaskUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-format-conversion/{id}/completed":{"patch":{"tags":["scan-format-conversion-controller"],"summary":"setScanConversionCompleted","operationId":"setScanConversionCompletedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ScanFormatConversionStatusDto"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-format-conversion/{id}/copied":{"patch":{"tags":["scan-format-conversion-controller"],"summary":"setScanCopied","operationId":"setScanCopiedUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/StatusDto"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-format-conversion/{id}/retry-count/{task}":{"patch":{"tags":["scan-format-conversion-controller"],"summary":"incrementJobRetryCount","operationId":"incrementJobRetryCountUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"task","in":"path","description":"task","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan-format-conversion/{id}/split":{"patch":{"tags":["scan-format-conversion-controller"],"summary":"setScanSplit","operationId":"setScanSplitUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ScanSplitResponseDto"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanFormatConversionBatchDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scan_target_link/{linkId}/updated":{"patch":{"tags":["survey-coordinates-controller"],"summary":"updateScanTargetLink","operationId":"updateScanTargetLinkUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ScanTargetLinkPost"}},{"name":"linkId","in":"path","description":"linkId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanTargetLinkDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scans/update-coarse-registration":{"post":{"tags":["scan-controller"],"summary":"updateCoarseRegistration","operationId":"updateCoarseRegistrationUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/UpdateManualRegistrationPost"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CoarseRegistrationUpdatedDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scans/{scanId}/bubble-texture":{"get":{"tags":["survey-coordinates-controller"],"summary":"getBubbleViewTexture","operationId":"getBubbleViewTextureUsingGET","produces":["application/json"],"parameters":[{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BubbleViewTextureDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scans/{scanId}/exported-scan-zipped":{"patch":{"tags":["scan-controller"],"summary":"setExportedScanZipped","operationId":"setExportedScanZippedUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ZipExportedScansJobProgressDto"}},{"name":"scanId","in":"path","description":"scanId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/scantargetlinks/{linkId}":{"put":{"tags":["scan-target-link-controller"],"summary":"updateScanTargetLink","operationId":"updateScanTargetLinkUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"link","description":"link","required":true,"schema":{"$ref":"#/definitions/ScanTargetLinkDto"}},{"name":"linkId","in":"path","description":"linkId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}}},"deprecated":false},"delete":{"tags":["scan-target-link-controller"],"summary":"deleteScanTargetLink","operationId":"deleteScanTargetLinkUsingDELETE","produces":["application/json"],"parameters":[{"name":"linkId","in":"path","description":"linkId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/storages/{storageId}/delete":{"delete":{"tags":["file-storage-controller"],"summary":"deletePaths","operationId":"deletePathsUsingDELETE","produces":["application/json"],"parameters":[{"in":"body","name":"selected","description":"selected","required":true,"schema":{"$ref":"#/definitions/SelectedPathsDto"}},{"name":"storageId","in":"path","description":"storageId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK"},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/storages/{storageId}/download":{"get":{"tags":["file-storage-controller"],"summary":"downLoadFile","operationId":"downLoadFileUsingGET","produces":["application/json"],"parameters":[{"name":"path","in":"query","description":"path","required":false,"type":"string"},{"name":"storageId","in":"path","description":"storageId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileDownloadDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/storages/{storageId}/folders":{"post":{"tags":["file-storage-controller"],"summary":"createStorageFolder","operationId":"createStorageFolderUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/CreateStorageFolderPost"}},{"name":"storageId","in":"path","description":"storageId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FolderDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/storages/{storageId}/ls":{"get":{"tags":["file-storage-controller"],"summary":"listStorage","operationId":"listStorageUsingGET","produces":["application/json"],"parameters":[{"name":"path","in":"query","description":"path","required":false,"type":"string"},{"name":"storageId","in":"path","description":"storageId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FolderDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/survey-coordinates-jobs/{id}":{"delete":{"tags":["job-controller"],"summary":"cancelSurveyCoordinatesJob","operationId":"cancelSurveyCoordinatesJobUsingDELETE","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/surveytargets/{targetId}":{"put":{"tags":["survey-target-controller"],"summary":"updateSurveyTarget","operationId":"updateSurveyTargetUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"target","description":"target","required":true,"schema":{"$ref":"#/definitions/SurveyTargetDto"}},{"name":"targetId","in":"path","description":"targetId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/Errors"}}},"deprecated":false},"delete":{"tags":["survey-target-controller"],"summary":"deleteSurveyTarget","operationId":"deleteSurveyTargetUsingDELETE","produces":["application/json"],"parameters":[{"name":"targetId","in":"path","description":"targetId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/users/{id}/projects":{"get":{"tags":["project-controller"],"summary":"getUserProjects","operationId":"getUserProjectsUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/RegistrationProjectDto"}}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false},"post":{"tags":["project-controller"],"summary":"createProject","operationId":"createProjectUsingPOST_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/ProjectPost"}},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationProjectDto"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}},"/webapi/utility-tasks/{id}/status":{"get":{"tags":["utility-task-controller"],"summary":"getUtilityTaskStatus","operationId":"getUtilityTaskStatusUsingGET","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"400":{"description":"[Bad Request] The data sent to the API is incorrect. More information within the body.","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"[Unauthorized] The API token is either absent, expired or invalid."},"403":{"description":"[Forbidden] Your API token is valid, but you are not allowed to perform this operation, or the entity requested doesn't exist."},"500":{"description":"[Internal Server Error] Unexpected problem. Please try again later or contact support."}},"deprecated":false}}},"securityDefinitions":{"API access key":{"type":"apiKey","name":"Authorization","in":"header","x-testvendor":"valuevendor"}},"definitions":{"AbstractRegistrationOptionsDto":{"type":"object","required":["mode","qa"],"discriminator":"mode","properties":{"mode":{"type":"string","enum":["EDGE_FEATURES","PLAN_VIEW"]},"qa":{"$ref":"#/definitions/QAOptions"}},"title":"AbstractRegistrationOptionsDto","description":"Use one of the subtypes"},"AbstractRemoteStorageDto":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"AbstractRemoteStorageDto"},"AccountingInfo":{"type":"object","required":["creditLimitCents","currentBalanceCents"],"properties":{"creditLimitCents":{"type":"integer","format":"int32","description":"Credit limit in cents"},"currentBalanceCents":{"type":"integer","format":"int32","description":"Current balance in cents"}},"title":"AccountingInfo"},"Actions":{"type":"object","required":["signupLoad","signupSubmit"],"properties":{"signupLoad":{"type":"string","description":"When signup form loads"},"signupSubmit":{"type":"string","description":"When signup form is submitted"}},"title":"Actions"},"ActivateEmailNewTokenRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"integer","format":"int64","description":"Unique identifier of the user requiring a new activation token"}},"title":"ActivateEmailNewTokenRequest"},"ActivateEmailRequest":{"type":"object","required":["token","userId"],"properties":{"token":{"type":"string","description":"E-mail activation token received by the user"},"userId":{"type":"integer","format":"int64","description":"Unique identifier of the user being activated"}},"title":"ActivateEmailRequest"},"AdminPreference":{"type":"object","properties":{"balance":{"description":"Balance change notification config","$ref":"#/definitions/Optional«TokenBalanceConfig»"}},"title":"AdminPreference"},"AdminPreferenceDto":{"type":"object","properties":{"balance":{"$ref":"#/definitions/TokenBalanceConfigDto"}},"title":"AdminPreferenceDto"},"ApiAccessKeyCreatedDto":{"type":"object","properties":{"accessKey":{"type":"string"}},"title":"ApiAccessKeyCreatedDto"},"ApiAccessKeyDto":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"expireAt":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"lastUsed":{"type":"string","format":"date-time"},"startTime":{"type":"string","format":"date-time"}},"title":"ApiAccessKeyDto"},"AppScanGrapherUploadCompleted":{"type":"object","required":["errorMessage"],"properties":{"companyId":{"type":"integer","format":"int64"},"context":{"$ref":"#/definitions/MessageContext"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"exceptionTrace":{"$ref":"#/definitions/Throwable"},"username":{"type":"string"},"zipFile":{"type":"string"}},"title":"AppScanGrapherUploadCompleted"},"AppScanGrapherUploadDto":{"type":"object","properties":{"password":{"type":"string"},"projectName":{"type":"string"},"username":{"type":"string"},"zipFileBase64EncodedString":{"type":"string"}},"title":"AppScanGrapherUploadDto"},"AutoRegistrationRunCreateRequest":{"type":"object","required":["graphNetwork","groupName","options","pointClouds"],"properties":{"graphNetwork":{"$ref":"#/definitions/GraphNetworkDto"},"groupName":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/definitions/AbstractRegistrationOptionsDto"},"pointClouds":{"type":"object","additionalProperties":{"$ref":"#/definitions/PointCloudRef"}}},"title":"AutoRegistrationRunCreateRequest"},"AutoRegistrationRunOutputsDto":{"type":"object","properties":{"estimatedSensorLocations":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}},"numberOfPoints":{"type":"integer","format":"int64"},"pairwiseResults":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/definitions/ChildTransformationMatrix"}}},"pointCloudsTransformation":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}}},"title":"AutoRegistrationRunOutputsDto"},"BoundingBox":{"type":"object","properties":{"xMax":{"type":"number","format":"double"},"xMin":{"type":"number","format":"double"},"xmax":{"type":"number","format":"double"},"xmin":{"type":"number","format":"double"},"yMax":{"type":"number","format":"double"},"yMin":{"type":"number","format":"double"},"ymax":{"type":"number","format":"double"},"ymin":{"type":"number","format":"double"},"zMax":{"type":"number","format":"double"},"zMin":{"type":"number","format":"double"},"zmax":{"type":"number","format":"double"},"zmin":{"type":"number","format":"double"}},"title":"BoundingBox"},"BrowserAccess":{"type":"object","properties":{"cookieId":{"type":"string","description":"Cookie id"},"path":{"type":"string","description":"File or folder path"}},"title":"BrowserAccess"},"BrowserUploadCompleteRequest":{"type":"object","required":["uploadRequests"],"properties":{"folderId":{"description":"The folderId files were uploaded to. Must match value provided in storageUploadPOST request. If not provided, files will be uploaded to the root","$ref":"#/definitions/Optional«string»"},"uploadRequests":{"type":"object","description":"Files that were successfully uploaded","additionalProperties":{"$ref":"#/definitions/PutObjectRequest"}}},"title":"BrowserUploadCompleteRequest"},"BrowserUploadDto":{"type":"object","required":["errors","uploadRequests"],"properties":{"errors":{"type":"object","description":"Files that failed validation with corresponding error codes","additionalProperties":{"type":"string"}},"uploadRequests":{"type":"object","description":"Files that passed validation with upload information","additionalProperties":{"$ref":"#/definitions/PutObjectRequest"}}},"title":"BrowserUploadDto"},"BrowserUploadRequest":{"type":"object","required":["files"],"properties":{"files":{"type":"array","description":"List of file paths that will be uploaded","items":{"type":"string"}},"folderId":{"description":"The folder to upload to. If not provided, files will be uploaded to the root","$ref":"#/definitions/Optional«string»"}},"title":"BrowserUploadRequest"},"BubbleViewTextureDto":{"type":"object","properties":{"imageData64":{"type":"string"},"imageFormat":{"type":"string"},"scanId":{"type":"integer","format":"int64"}},"title":"BubbleViewTextureDto"},"ChildTransformationMatrix":{"type":"object","properties":{"childTransformationMatrix":{"type":"array","items":{"type":"number","format":"double"}}},"title":"ChildTransformationMatrix"},"ChildTransformationMatrixDto":{"type":"object","required":["childTransformationMatrix"],"properties":{"childTransformationMatrix":{"type":"array","items":{"type":"number","format":"double","minimum":16,"maximum":16}}},"title":"ChildTransformationMatrixDto"},"ClassDescriptor":{"type":"object","properties":{"instances":{"$ref":"#/definitions/ClassInstances"},"lazClassCode":{"type":"integer","format":"int32"}},"title":"ClassDescriptor"},"ClassInstances":{"type":"object","properties":{"numberOfInstances":{"type":"integer","format":"int64"}},"title":"ClassInstances"},"CoarseRegistrationJob":{"type":"object","required":["createdDate","status"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"CoarseRegistrationJob"},"CoarseRegistrationJobDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"CoarseRegistrationJobDto"},"CoarseRegistrationParameters":{"type":"object","required":["algorithm","maxDistanceToScanner","metresPerPixel","numAzimuthAngles"],"properties":{"algorithm":{"type":"string","enum":["EDGE_FEATURES","PLAN_VIEW"]},"id":{"type":"integer","format":"int64"},"maxDistanceToScanner":{"type":"number","format":"double"},"metresPerPixel":{"type":"number","format":"double"},"numAzimuthAngles":{"type":"number","format":"double"}},"title":"CoarseRegistrationParameters"},"CoarseRegistrationParametersDto":{"type":"object","properties":{"environmentType":{"type":"string","enum":["MAN_MADE","NATURAL"]},"id":{"type":"integer","format":"int64"},"maxDistanceToScanner":{"type":"number","format":"double"},"metresPerPixel":{"type":"number","format":"double"},"numAzimuthAngles":{"type":"number","format":"double"}},"title":"CoarseRegistrationParametersDto"},"CoarseRegistrationParametersPostDto":{"type":"object","properties":{"environmentType":{"type":"string","enum":["MAN_MADE","NATURAL"]}},"title":"CoarseRegistrationParametersPostDto"},"CoarseRegistrationUpdatedDto":{"type":"object","properties":{"completed":{"type":"boolean"},"globalTransformations":{"type":"array","items":{"$ref":"#/definitions/ScanTransformationMatrixBase64Dto"}},"inputsHash":{"type":"integer","format":"int32"},"iterations":{"type":"integer","format":"int32"}},"title":"CoarseRegistrationUpdatedDto"},"CompanyDto":{"type":"object","required":["id","info"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier"},"info":{"$ref":"#/definitions/CompanyInfo"}},"title":"CompanyDto"},"CompanyInfo":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name"}},"title":"CompanyInfo"},"CompanyTransactionDto":{"type":"object","properties":{"balanceCentsAmendment":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date-time"},"details":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"revertId":{"type":"integer","format":"int64"},"transactionType":{"type":"string","enum":["INIT","ACTIVATE","V2SR","V2SC","JOB","TOKEN_PURCHASE","RESET_BALANCE","API_JOB","BALANCE_AMENDMENT","BALANCE_RESET"]}},"title":"CompanyTransactionDto"},"CompanyUpdateRequest":{"type":"object","properties":{"name":{"description":"Company name","$ref":"#/definitions/Optional«string»"}},"title":"CompanyUpdateRequest"},"CompanyUserCreateRequest":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"User email address"},"password":{"description":"User password","$ref":"#/definitions/Optional«string»"}},"title":"CompanyUserCreateRequest"},"CompanyUserUpdateRequest":{"type":"object","properties":{"companyAdmin":{"description":"Indicator if user is company admin","$ref":"#/definitions/Optional«boolean»"},"firstName":{"description":"User first name","$ref":"#/definitions/Optional«string»"},"lastName":{"description":"User last name","$ref":"#/definitions/Optional«string»"},"locked":{"description":"Indicator if user is locked","$ref":"#/definitions/Optional«boolean»"},"phoneNumber":{"description":"User phone number","$ref":"#/definitions/Optional«string»"},"readOnly":{"description":"Indicator if user is read only","$ref":"#/definitions/Optional«boolean»"}},"title":"CompanyUserUpdateRequest"},"CorrevateProject«object,object»":{"type":"object","required":["createdDate","lastAccessed","name"],"properties":{"coarseRegistrationJob":{"$ref":"#/definitions/CoarseRegistrationJob"},"config":{"$ref":"#/definitions/VercatorConfig"},"createdDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"exportJob":{"$ref":"#/definitions/ExportJob"},"exportJobs":{"type":"array","items":{"$ref":"#/definitions/ExportJob"}},"fineRegistrationJob":{"$ref":"#/definitions/FineRegistrationJob"},"id":{"type":"integer","format":"int64"},"lastAccessed":{"type":"string","format":"date-time"},"levels":{"type":"array","items":{"$ref":"#/definitions/ScanGrapherLevel"}},"name":{"type":"string"},"pairs":{"type":"array","items":{"type":"object"}},"preProcessingJob":{"$ref":"#/definitions/PreProcessingJob"},"projectTransformation":{"$ref":"#/definitions/ProjectTransformation"},"scans":{"type":"array","items":{"type":"object"}},"surveyCoordinatesJob":{"$ref":"#/definitions/SurveyCoordinatesJob"},"targetLinks":{"type":"array","items":{"$ref":"#/definitions/ScanTargetLink"}},"targets":{"type":"array","items":{"$ref":"#/definitions/SurveyTarget"}},"zipExportedScansJob":{"$ref":"#/definitions/ZipExportedScansJob"}},"title":"CorrevateProject«object,object»"},"CreateFolderRequest":{"type":"object","required":["name"],"properties":{"folderId":{"description":"The folderId where the new folder will be created. If not provided, the new folder will be created in the root","$ref":"#/definitions/Optional«string»"},"name":{"type":"string","description":"Folder name","pattern":"^((?!/).)*$"}},"title":"CreateFolderRequest"},"CreateStorageFolderPost":{"type":"object","properties":{"name":{"type":"string"}},"title":"CreateStorageFolderPost"},"CreatedUserKeyDto":{"type":"object","required":["createdKey","secret"],"properties":{"createdKey":{"description":"Created Access Key information","$ref":"#/definitions/UserKeyDto"},"secret":{"type":"string","description":"Secret Access Key"}},"title":"CreatedUserKeyDto"},"CropPointsLazyOperation":{"title":"CropPointsLazyOperation","allOf":[{"$ref":"#/definitions/LazyOperation"},{"type":"object","properties":{"cropBounds":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"updatedBounds":{"$ref":"#/definitions/BoundingBox"}},"title":"CropPointsLazyOperation"}]},"DataDto":{"type":"object","required":["id","type"],"properties":{"browserAccess":{"description":"Information required to obtain access cookie","$ref":"#/definitions/BrowserAccess"},"folderId":{"type":"string","description":"Id of the containing folder. Null if it is the root folder"},"id":{"type":"string","description":"File or folder id"},"isUploading":{"type":"boolean","description":"True if file upload is in progress"},"name":{"type":"string","description":"File or folder name"},"size":{"type":"integer","format":"int64","description":"File size"},"type":{"type":"string","description":"File or folder","enum":["folder","file"]}},"title":"DataDto"},"DataRef":{"type":"object","properties":{"id":{"type":"string"},"remoteStorageId":{"type":"integer","format":"int64"}},"title":"DataRef"},"Dropbox":{"type":"object","properties":{"clientId":{"type":"string"}},"title":"Dropbox"},"DropboxConfigurationDto":{"type":"object","properties":{"clientId":{"type":"string"}},"title":"DropboxConfigurationDto"},"EdgeFeaturesModeDto":{"title":"EdgeFeaturesModeDto","allOf":[{"$ref":"#/definitions/AbstractRegistrationOptionsDto"},{"type":"object","required":["mode","modeOptions","qa"],"properties":{"mode":{"type":"string","enum":["EDGE_FEATURES","PLAN_VIEW"]},"modeOptions":{"$ref":"#/definitions/EdgeFeaturesModeOptionsDto"},"qa":{"$ref":"#/definitions/QAOptions"}},"title":"EdgeFeaturesModeDto"}]},"ErrorDetails":{"type":"object","properties":{"code":{"type":"string","example":"VALUE__IS_EMPTY","description":"Error Code"},"field":{"type":"string","example":"id","description":"Field on which the error happened. Can be related to a field within the body of the request or in the request path/parameters."},"message":{"type":"string","example":"The project doesn't exist.","description":"Human readable message explaining the problem."}},"title":"ErrorDetails"},"Errors":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors which happened during the API call.","items":{"$ref":"#/definitions/ErrorDetails"}},"requestId":{"type":"string","description":"Unique request ID generated during the API call."}},"title":"Errors"},"ExportAsTilesOptions":{"type":"object","required":["octreeDepth"],"properties":{"octreeDepth":{"type":"integer","format":"int32","minimum":0.0,"exclusiveMinimum":false}},"title":"ExportAsTilesOptions"},"ExportJob":{"type":"object","required":["createdDate","status"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"exportDirectory":{"type":"string"},"exportParameters":{"$ref":"#/definitions/ExportParameters"},"exportedScans":{"type":"array","items":{"$ref":"#/definitions/ExportJobScans"}},"id":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]},"zipExportedScansJob":{"$ref":"#/definitions/ZipExportedScansJob"}},"title":"ExportJob"},"ExportJobDto":{"type":"object","required":["exportParameters","exportedScans"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"exportDirectory":{"type":"string"},"exportParameters":{"$ref":"#/definitions/ExportJobParametersDto"},"exportedScans":{"type":"array","items":{"$ref":"#/definitions/ExportJobScansDto"}},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"ExportJobDto"},"ExportJobParametersDto":{"type":"object","required":["deleteZippedScans","format","scanIds","zipExportedScans"],"properties":{"deleteZippedScans":{"type":"boolean"},"format":{"type":"string"},"scanIds":{"type":"array","items":{"type":"integer","format":"int64"}},"zipExportedScans":{"type":"boolean"}},"title":"ExportJobParametersDto"},"ExportJobScans":{"type":"object","required":["exportError","exported","exportedScanDeleted","scanId","zipped"],"properties":{"exportError":{"type":"string"},"exportJob":{"$ref":"#/definitions/ExportJob"},"exported":{"type":"boolean"},"exportedScanDeleted":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"scanId":{"type":"integer","format":"int64"},"scanName":{"type":"string"},"zipped":{"type":"boolean"}},"title":"ExportJobScans"},"ExportJobScansDto":{"type":"object","properties":{"exportError":{"type":"string"},"exported":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"link":{"type":"string"},"scanId":{"type":"integer","format":"int64"},"scanName":{"type":"string"},"zipError":{"type":"string"},"zipped":{"type":"boolean"}},"title":"ExportJobScansDto"},"ExportParameters":{"type":"object","required":["deleteZippedScans","zipExportedScans"],"properties":{"deleteZippedScans":{"type":"boolean"},"exportJob":{"$ref":"#/definitions/ExportJob"},"format":{"type":"string","enum":["XYZ","PLY","PTS","LAS","LAZ","E57","RCS"]},"id":{"type":"integer","format":"int64"},"zipExportedScans":{"type":"boolean"}},"title":"ExportParameters"},"ExportParametersPostDto":{"type":"object","required":["format"],"properties":{"format":{"type":"string","example":"E57","description":"The output scan format","enum":["XYZ","PLY","E57","PTS","LAS","LAZ","RCS"]}},"title":"ExportParametersPostDto"},"ExportRunCreateRequest":{"type":"object","required":["destinationFolder","groupName","options","pointCloud"],"properties":{"destinationFileName":{"type":"string"},"destinationFolder":{"$ref":"#/definitions/DataRef"},"groupName":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/definitions/Options"},"pointCloud":{"$ref":"#/definitions/PointCloudRef"}},"title":"ExportRunCreateRequest"},"ExportRunOutputsDto":{"type":"object","properties":{"exportedPointClouds":{"type":"array","items":{"$ref":"#/definitions/DataRef"}},"numberOfPoints":{"type":"integer","format":"int64"}},"title":"ExportRunOutputsDto"},"ExportsSharedDto":{"type":"object","properties":{"emailAddresses":{"type":"array","items":{"type":"string"}},"error":{"type":"string"},"signedUrls":{"type":"array","items":{"$ref":"#/definitions/URL"}}},"title":"ExportsSharedDto"},"FileCopyJob":{"type":"object","required":["batchTaskId","createdDate","inputPath","outputPath","status"],"properties":{"batchTaskId":{"type":"integer","format":"int64"},"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"id":{"type":"integer","format":"int64"},"inputPath":{"type":"string"},"outputPath":{"type":"string"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"FileCopyJob"},"FileCopyJobDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"inputPath":{"type":"string"},"outputPath":{"type":"string"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"FileCopyJobDto"},"FileDownloadDto":{"type":"object","properties":{"url":{"type":"string"}},"title":"FileDownloadDto"},"FileDto":{"type":"object","properties":{"name":{"type":"string"},"size":{"type":"integer","format":"int64"}},"title":"FileDto"},"FileStorageDto":{"type":"object","properties":{"accessKey":{"type":"string"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"path":{"type":"string"},"type":{"type":"string","enum":["S3","AZURE","HOSTED_COMPANY","DROPBOX"]}},"title":"FileStorageDto"},"FileStoragePost":{"type":"object","required":["type"],"properties":{"accessKey":{"type":"string"},"name":{"type":"string"},"path":{"type":"string"},"secretKey":{"type":"string"},"type":{"type":"string","enum":["S3","AZURE","HOSTED_COMPANY","DROPBOX"]}},"title":"FileStoragePost"},"FilterPointsLazyOperation":{"title":"FilterPointsLazyOperation","allOf":[{"$ref":"#/definitions/LazyOperation"},{"type":"object","properties":{"excludedClassIds":{"type":"array","items":{"type":"string"}},"includedClassIds":{"type":"array","items":{"type":"string"}}},"title":"FilterPointsLazyOperation"}]},"FineRegistrationCompletedDto":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"},"maxPointSearchDistance":{"type":"number","format":"double"},"maxScanToScanDistance":{"type":"number","format":"double"},"meanRMSPoint2Plane":{"type":"number","format":"double"},"meanRMSPoint2Point":{"type":"number","format":"double"},"projectId":{"type":"integer","format":"int64"}},"title":"FineRegistrationCompletedDto"},"FineRegistrationJob":{"type":"object","required":["createdDate","status"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"currentIteration":{"type":"integer","format":"int64"},"currentScanInFineRegistrationReport":{"type":"integer","format":"int64"},"currentScanInGraphBuilder":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"maxIteration":{"type":"integer","format":"int64"},"maxPointSearchDistance":{"type":"number","format":"double"},"maxScan":{"type":"integer","format":"int64"},"maxScanToScanDistance":{"type":"number","format":"double"},"meanRMSPoint2Plane":{"type":"number","format":"double"},"meanRMSPoint2Point":{"type":"number","format":"double"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"FineRegistrationJob"},"FineRegistrationJobDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"currentIteration":{"type":"integer","format":"int64"},"currentScanInFineRegistrationReport":{"type":"integer","format":"int64"},"currentScanInGraphBuilder":{"type":"integer","format":"int64"},"maxIteration":{"type":"integer","format":"int64"},"maxScan":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"FineRegistrationJobDto"},"FineRegistrationMatricesCsvUrl":{"type":"object","properties":{"csvUrl":{"type":"string"}},"title":"FineRegistrationMatricesCsvUrl"},"FineRegistrationParameters":{"type":"object","required":["fineRegistrationMethod","globalIcpParameters","pairwiseIcpParameters"],"properties":{"fineRegistrationMethod":{"type":"string"},"globalIcpParameters":{"$ref":"#/definitions/GlobalIcpParameters"},"id":{"type":"integer","format":"int64"},"pairwiseIcpParameters":{"$ref":"#/definitions/PairwiseIcpParameters"}},"title":"FineRegistrationParameters"},"FineRegistrationParametersDto":{"type":"object","properties":{"fineRegistrationMethod":{"type":"string"},"globalIcpParameters":{"$ref":"#/definitions/GlobalIcpParametersDto"},"id":{"type":"integer","format":"int64"},"pairwiseIcpParameters":{"$ref":"#/definitions/PairwiseIcpParametersDto"}},"title":"FineRegistrationParametersDto"},"FineRegistrationParametersPostDto":{"type":"object","required":["globalIcpParameters"],"properties":{"globalIcpParameters":{"$ref":"#/definitions/GlobalIcpParametersPostDto"}},"title":"FineRegistrationParametersPostDto"},"FineRegistrationReportCsvUrl":{"type":"object","properties":{"csvUrl":{"type":"string"}},"title":"FineRegistrationReportCsvUrl"},"FineRegistrationReportData":{"type":"object","properties":{"maximumPointSearchDistance":{"type":"number","format":"double"},"maximumScanToScanDistance":{"type":"number","format":"double"},"meanPointToPlaneError":{"type":"number","format":"double"},"meanPointToPointError":{"type":"number","format":"double"}},"title":"FineRegistrationReportData"},"FineRegistrationReportParameters":{"type":"object","required":["maxPointSearchRadius"],"properties":{"id":{"type":"integer","format":"int64"},"maxPointSearchRadius":{"type":"number","format":"double"}},"title":"FineRegistrationReportParameters"},"FineRegistrationReportParametersDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"maxPointSearchRadius":{"type":"number","format":"double"}},"title":"FineRegistrationReportParametersDto"},"FolderDto":{"type":"object","properties":{"complete":{"type":"boolean"},"files":{"type":"array","items":{"$ref":"#/definitions/FileDto"}},"folders":{"type":"array","items":{"$ref":"#/definitions/FolderDto"}},"name":{"type":"string"}},"title":"FolderDto"},"GeoReferencingRunCreateRequest":{"type":"object","required":["geoRefResultTransformation","groupName","pointClouds"],"properties":{"geoRefResultTransformation":{"type":"array","items":{"type":"number","format":"double","minimum":16,"maximum":16}},"groupName":{"type":"string"},"name":{"type":"string"},"pointClouds":{"type":"object","additionalProperties":{"$ref":"#/definitions/PointCloudInfo"}},"uiPayload":{"type":"string"}},"title":"GeoReferencingRunCreateRequest"},"GeoReferencingRunOutputsDto":{"type":"object","properties":{"numberOfPoints":{"type":"integer","format":"int64"}},"title":"GeoReferencingRunOutputsDto"},"GlobalIcpParameters":{"type":"object","required":["maxScanSeparationMetres","minScanOverlapFraction"],"properties":{"maxScanSeparationMetres":{"type":"number","format":"double"},"minScanOverlapFraction":{"type":"number","format":"double"}},"title":"GlobalIcpParameters"},"GlobalIcpParametersDto":{"type":"object","properties":{"maxScanSeparationMetres":{"type":"number","format":"double"},"minScanOverlapFraction":{"type":"number","format":"double"}},"title":"GlobalIcpParametersDto"},"GlobalIcpParametersPostDto":{"type":"object","required":["maxScanSeparationMetres","minScanOverlapFraction"],"properties":{"maxScanSeparationMetres":{"type":"number","format":"double","example":15.0,"description":"The maximum distance to search for connections between scans. Minumum should be the shortest distance between scan positions"},"minScanOverlapFraction":{"type":"number","format":"double","example":0.2,"description":"The minimum overlap between scans to consider solving the fine registration between scans","minimum":0.0,"maximum":1.0,"exclusiveMinimum":false,"exclusiveMaximum":false}},"title":"GlobalIcpParametersPostDto"},"GraphGenerationOptions":{"type":"object","required":["maxScanSeparationMetres","minOverlapThreshold"],"properties":{"maxScanSeparationMetres":{"type":"number","format":"double"},"minOverlapThreshold":{"type":"number","format":"double"}},"title":"GraphGenerationOptions"},"GraphNetworkDto":{"type":"object","required":["links"],"properties":{"links":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"name":{"type":"string"},"rootId":{"type":"string"},"uiPayload":{"type":"string"}},"title":"GraphNetworkDto"},"IcpParameters":{"type":"object","required":["maxNumSubset","minNorm","orientedSurface"],"properties":{"maxNumSubset":{"type":"integer","format":"int64"},"minNorm":{"type":"number","format":"double"},"orientedSurface":{"type":"boolean"}},"title":"IcpParameters"},"IcpParametersDto":{"type":"object","properties":{"maxNumSubset":{"type":"integer","format":"int64"},"minNorm":{"type":"integer","format":"int64"},"orientedSurface":{"type":"boolean"}},"title":"IcpParametersDto"},"ImportJobConfigs":{"type":"object","required":["maxNumberOfPoints","maxScanSize"],"properties":{"maxNumberOfPoints":{"type":"integer","format":"int64","description":"Max number of points that is supported"},"maxScanSize":{"type":"integer","format":"int64","description":"Max scan size (in bytes) that is supported"}},"title":"ImportJobConfigs"},"ImportJobPointCloudRef":{"title":"ImportJobPointCloudRef","allOf":[{"$ref":"#/definitions/PointCloudRef"},{"type":"object","required":["ref"],"properties":{"ref":{"description":"Point Cloud Reference Information","$ref":"#/definitions/PointCloudReference"}},"title":"ImportJobPointCloudRef"}]},"ImportJobs":{"type":"object","required":["defaultConfig"],"properties":{"defaultConfig":{"description":"Default configuration of import job","$ref":"#/definitions/ImportJobConfigs"},"maxNumberOfPointsByExtensions":{"type":"object","description":"Max number of points limit by file extension","additionalProperties":{"type":"integer","format":"int64"}},"maxScanSizeByExtensions":{"type":"object","description":"Max scan size in bytes limit by file extension","additionalProperties":{"type":"integer","format":"int64"}}},"title":"ImportJobs"},"ImportPointCloudDto":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Point cloud name"}},"title":"ImportPointCloudDto"},"ImportRunCreateRequest":{"type":"object","required":["groupName","importData"],"properties":{"groupName":{"type":"string"},"importData":{"$ref":"#/definitions/DataRef"},"name":{"type":"string"}},"title":"ImportRunCreateRequest"},"ImportRunOutputsDto":{"type":"object","properties":{"graphNetworks":{"type":"array","items":{"$ref":"#/definitions/GraphNetworkDto"}},"numberOfPoints":{"type":"integer","format":"int64"},"pointClouds":{"type":"object","additionalProperties":{"$ref":"#/definitions/PointCloudDto"}}},"title":"ImportRunOutputsDto"},"ImportRunSummaryDto":{"type":"object","required":["id","name","projectId","startedAt","startedBy","status"],"properties":{"finishedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been finished"},"groupName":{"type":"string","description":"Job Group Name"},"id":{"type":"string","description":"Unique identifier"},"name":{"type":"string","description":"Job Name"},"pointClouds":{"type":"array","description":"Point clouds information of finished job","items":{"$ref":"#/definitions/ImportPointCloudDto"}},"projectId":{"type":"integer","format":"int64","description":"Project Id that is associated with the job"},"startedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been started"},"startedBy":{"type":"integer","format":"int64","description":"User Id started the job"},"status":{"type":"string","description":"Status of the job","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}},"title":"ImportRunSummaryDto"},"InputPointCloud":{"type":"object","required":["id"],"properties":{"id":{"$ref":"#/definitions/PointCloudRef"},"transformation":{"type":"array","items":{"type":"number","format":"double","minimum":16,"maximum":16}}},"title":"InputPointCloud"},"JobDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"JobDto"},"JobFailureStatusDto":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"jobId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"}},"title":"JobFailureStatusDto"},"JobNotificationInfo":{"type":"object","required":["complete"],"properties":{"complete":{"type":"boolean","description":"Complete"}},"title":"JobNotificationInfo"},"JobPost":{"type":"object","required":["type"],"properties":{"exportJobParameters":{"$ref":"#/definitions/ExportJobParametersDto"},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"JobPost"},"JobProgress":{"type":"object","properties":{"currentIteration":{"type":"integer","format":"int64"},"currentScanInFineRegistrationReport":{"type":"integer","format":"int64"},"currentScanInGraphBuilder":{"type":"integer","format":"int64"},"maxIteration":{"type":"integer","format":"int64"},"maxScan":{"type":"integer","format":"int64"}},"title":"JobProgress"},"Jobs":{"type":"object","properties":{"autoregistration":{"description":"Auto Registration Job","$ref":"#/definitions/JobNotificationInfo"},"export":{"description":"Export Job","$ref":"#/definitions/JobNotificationInfo"},"import":{"description":"Import Job","$ref":"#/definitions/JobNotificationInfo"},"merge":{"description":"Merge Job","$ref":"#/definitions/JobNotificationInfo"},"optimiseregistration":{"description":"Optimise Registration Job","$ref":"#/definitions/JobNotificationInfo"},"segmentation":{"description":"Segmentation Job","$ref":"#/definitions/JobNotificationInfo"}},"title":"Jobs"},"LazyOperation":{"type":"object","discriminator":"opType","title":"LazyOperation"},"LevelDto":{"type":"object","properties":{"floorPlan":{"type":"string"},"id":{"type":"integer","format":"int64"},"levelName":{"type":"string"}},"title":"LevelDto"},"LevelPost":{"type":"object","required":["levelName","projectId"],"properties":{"floorPlan":{"type":"string"},"levelName":{"type":"string"},"projectId":{"type":"integer","format":"int64"}},"title":"LevelPost"},"LoginDto":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"The user's JWT token that should be used when calling any endpoint that requires user authorization"}},"title":"LoginDto","description":"Returns information about the login"},"LoginRequest":{"type":"object","required":["password","username"],"properties":{"password":{"type":"string","description":"User password"},"username":{"type":"string","description":"User email address"}},"title":"LoginRequest"},"ManualRegistrationOptions":{"type":"object","required":["qa"],"properties":{"qa":{"$ref":"#/definitions/QAOptions"}},"title":"ManualRegistrationOptions"},"ManualRegistrationRunCreateRequest":{"type":"object","required":["graphNetwork","groupName","pairwiseResults","pointClouds","pointCloudsTransformation"],"properties":{"estimatedSensorLocations":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}},"graphNetwork":{"$ref":"#/definitions/GraphNetworkDto"},"groupName":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/definitions/ManualRegistrationOptions"},"pairwiseResults":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/definitions/ChildTransformationMatrixDto"}}},"pointClouds":{"type":"object","additionalProperties":{"$ref":"#/definitions/PointCloudRef"}},"pointCloudsTransformation":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}}},"title":"ManualRegistrationRunCreateRequest"},"ManualRegistrationRunOutputsDto":{"type":"object","properties":{"numberOfPoints":{"type":"integer","format":"int64"}},"title":"ManualRegistrationRunOutputsDto"},"Map«string,ChildTransformationMatrixDto»":{"type":"object","title":"Map«string,ChildTransformationMatrixDto»","additionalProperties":{"$ref":"#/definitions/ChildTransformationMatrixDto"}},"Map«string,ChildTransformationMatrix»":{"type":"object","title":"Map«string,ChildTransformationMatrix»","additionalProperties":{"$ref":"#/definitions/ChildTransformationMatrix"}},"Map«string,PairwiseStatsItem»":{"type":"object","title":"Map«string,PairwiseStatsItem»","additionalProperties":{"$ref":"#/definitions/PairwiseStatsItem"}},"MergeJobPointCloudRef":{"title":"MergeJobPointCloudRef","allOf":[{"$ref":"#/definitions/PointCloudRef"},{"type":"object","required":["ref"],"properties":{"ref":{"description":"Point Cloud Reference Information","$ref":"#/definitions/PointCloudReference"}},"title":"MergeJobPointCloudRef"}]},"MergeRunCreateRequest":{"type":"object","required":["groupName","pointClouds"],"properties":{"groupName":{"type":"string"},"name":{"type":"string"},"pointClouds":{"type":"array","items":{"$ref":"#/definitions/InputPointCloud"}}},"title":"MergeRunCreateRequest"},"MergeRunOutputsDto":{"type":"object","properties":{"numberOfPoints":{"type":"integer","format":"int64"},"pointCloud":{"$ref":"#/definitions/PointCloudDto"}},"title":"MergeRunOutputsDto"},"MessageContext":{"type":"object","properties":{"initialJobId":{"type":"integer","format":"int64"},"jobId":{"type":"integer","format":"int64"},"pairId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"scanId":{"type":"integer","format":"int64"},"scanName":{"type":"string"},"utilityTaskId":{"type":"integer","format":"int64"}},"title":"MessageContext"},"Notifications":{"type":"object","required":["projects"],"properties":{"admin":{"description":"Admin preference config","$ref":"#/definitions/AdminPreferenceDto"},"projects":{"description":"Projects","$ref":"#/definitions/Projects"}},"title":"Notifications"},"OctreeInfo":{"type":"object","properties":{"bounds":{"$ref":"#/definitions/BoundingBox"},"depth":{"type":"integer","format":"int32"},"span":{"type":"integer","format":"int32"}},"title":"OctreeInfo"},"OptimiseRegistrationOptions":{"type":"object","required":["graphGeneration","preProcessing","qa"],"properties":{"graphGeneration":{"$ref":"#/definitions/GraphGenerationOptions"},"preProcessing":{"$ref":"#/definitions/RegistrationPreProcessingOptions"},"qa":{"$ref":"#/definitions/QAOptions"}},"title":"OptimiseRegistrationOptions"},"OptimiseRegistrationRunCreateRequest":{"type":"object","required":["options","pointClouds"],"properties":{"groupName":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/definitions/OptimiseRegistrationOptions"},"pointClouds":{"type":"object","additionalProperties":{"$ref":"#/definitions/PointCloudRef"}},"preRegistration":{"$ref":"#/definitions/PreRegistrationData"}},"title":"OptimiseRegistrationRunCreateRequest"},"OptimiseRegistrationRunOutputsDto":{"type":"object","properties":{"estimatedSensorLocations":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}},"numberOfPoints":{"type":"integer","format":"int64"},"pointCloudsTransformation":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}}},"title":"OptimiseRegistrationRunOutputsDto"},"Optional«AdminPreference»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«AdminPreference»"},"Optional«JobNotificationInfo»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«JobNotificationInfo»"},"Optional«Jobs»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«Jobs»"},"Optional«Notifications»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«Notifications»"},"Optional«Projects»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«Projects»"},"Optional«TokenBalanceConfig»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«TokenBalanceConfig»"},"Optional«boolean»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«boolean»"},"Optional«int»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«int»"},"Optional«string»":{"type":"object","properties":{"empty":{"type":"boolean"},"present":{"type":"boolean"}},"title":"Optional«string»"},"Options":{"type":"object","required":["qa"],"properties":{"preProcessing":{"$ref":"#/definitions/RegistrationPreProcessingOptions"},"qa":{"$ref":"#/definitions/QAOptions"}},"title":"Options"},"PageResponse":{"type":"object","required":["limit","nextCursor"],"properties":{"limit":{"type":"integer","format":"int32","description":"Maximum number of results to return"},"nextCursor":{"type":"string","description":"Identifies the next item that would be returned by the query. Should be used to set the 'cursor' parameter on a new request to fetch additional results."}},"title":"PageResponse"},"Paginated«AbstractRemoteStorageDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/AbstractRemoteStorageDto"}}},"title":"Paginated«AbstractRemoteStorageDto»"},"Paginated«CompanyTransactionDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/CompanyTransactionDto"}}},"title":"Paginated«CompanyTransactionDto»"},"Paginated«DataDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/DataDto"}}},"title":"Paginated«DataDto»"},"Paginated«ImportRunSummaryDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/ImportRunSummaryDto"}}},"title":"Paginated«ImportRunSummaryDto»"},"Paginated«PointCloudClassInstanceDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/PointCloudClassInstanceDto"}}},"title":"Paginated«PointCloudClassInstanceDto»"},"Paginated«ProjectDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/ProjectDto"}}},"title":"Paginated«ProjectDto»"},"Paginated«RemoteDataDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/RemoteDataDto"}}},"title":"Paginated«RemoteDataDto»"},"Paginated«RunSummaryDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/RunSummaryDto"}}},"title":"Paginated«RunSummaryDto»"},"Paginated«SegmentationRunDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/SegmentationRunDto"}}},"title":"Paginated«SegmentationRunDto»"},"Paginated«UserAdminDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/UserAdminDto"}}},"title":"Paginated«UserAdminDto»"},"Paginated«UserKeyDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/UserKeyDto"}}},"title":"Paginated«UserKeyDto»"},"Paginated«UserPublicDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/UserPublicDto"}}},"title":"Paginated«UserPublicDto»"},"Paginated«VisualisationDto»":{"type":"object","required":["paging","results"],"properties":{"paging":{"description":"Info about paging","$ref":"#/definitions/PageResponse"},"results":{"type":"array","description":"List of entities","items":{"$ref":"#/definitions/VisualisationDto"}}},"title":"Paginated«VisualisationDto»"},"PairwiseExecutionResult":{"type":"object","properties":{"completed":{"type":"boolean"},"iteration":{"type":"integer","format":"int32"},"resumeState":{"type":"string"}},"title":"PairwiseExecutionResult"},"PairwiseIcpParameters":{"type":"object","required":["icpParameters","minOctreeNodeSize"],"properties":{"icpParameters":{"$ref":"#/definitions/IcpParameters"},"minOctreeNodeSize":{"type":"number","format":"double"}},"title":"PairwiseIcpParameters"},"PairwiseIcpParametersDto":{"type":"object","properties":{"icpParameters":{"$ref":"#/definitions/IcpParametersDto"},"minOctreeNodeSize":{"type":"integer","format":"int64"}},"title":"PairwiseIcpParametersDto"},"PairwiseStatsItem":{"type":"object","properties":{"cO":{"type":"integer","format":"int64"},"cRMS":{"type":"number","format":"double"},"cT":{"type":"integer","format":"int64"},"pO":{"type":"integer","format":"int64"},"pRMS":{"type":"number","format":"double"},"pT":{"type":"integer","format":"int64"}},"title":"PairwiseStatsItem"},"PasswordResetNewTokenRequest":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email address of the user"}},"title":"PasswordResetNewTokenRequest"},"PasswordResetRequest":{"type":"object","required":["password","token","userId"],"properties":{"password":{"type":"string","description":"New user's password to be set. Must follow the following rules:\n* At least 8 characters long\n* Must contain at least 1 number\n* Must contain at least 1 lower case letter\n* Must contain at least 1 upper case letter\n* Must contain at least 1 symbol\n"},"token":{"type":"string","description":"Reset password token received by the user"},"userId":{"type":"integer","format":"int64","description":"Unique identifier of the user"}},"title":"PasswordResetRequest"},"PlanViewModeDto":{"title":"PlanViewModeDto","allOf":[{"$ref":"#/definitions/AbstractRegistrationOptionsDto"},{"type":"object","required":["mode","qa"],"properties":{"mode":{"type":"string","enum":["EDGE_FEATURES","PLAN_VIEW"]},"modeOptions":{"$ref":"#/definitions/PlanViewModeOptionsDto"},"qa":{"$ref":"#/definitions/QAOptions"}},"title":"PlanViewModeDto"}]},"PlanviewParameters":{"type":"object","required":["maxDistanceToScanner","maxZThreshold","metresPerPixel"],"properties":{"maxDistanceToScanner":{"type":"number","format":"double"},"maxZThreshold":{"type":"number","format":"double"},"metresPerPixel":{"type":"number","format":"double"}},"title":"PlanviewParameters"},"PlanviewParametersDto":{"type":"object","properties":{"maxDistanceToScanner":{"type":"number","format":"double"},"maxZThreshold":{"type":"number","format":"double"},"metresPerPixel":{"type":"number","format":"double"}},"title":"PlanviewParametersDto"},"PointClassifications":{"type":"object","properties":{"classes":{"type":"object","additionalProperties":{"$ref":"#/definitions/ClassDescriptor"}},"modelId":{"type":"string"}},"title":"PointClassifications"},"PointCloud":{"type":"object","properties":{"classes":{"type":"object","additionalProperties":{"$ref":"#/definitions/SegmentationOutputClass"}},"url":{"type":"string"}},"title":"PointCloud"},"PointCloudClassInstanceDto":{"type":"object","properties":{"boundingBox":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"centroid":{"type":"array","items":{"type":"number","format":"double"}},"confidence":{"type":"number","format":"double"},"id":{"type":"string"}},"title":"PointCloudClassInstanceDto"},"PointCloudDto":{"type":"object","required":["ept","id","jobRef","metadata","name"],"properties":{"ept":{"description":"Browser access details","$ref":"#/definitions/BrowserAccess"},"id":{"type":"string","description":"Unique identifier"},"jobRef":{"description":"Job outputs reference","$ref":"#/definitions/PointCloudRef"},"lazyOps":{"type":"array","items":{"$ref":"#/definitions/LazyOperation"}},"metadata":{"description":"Point cloud metadata","$ref":"#/definitions/PointCloudMetadata"},"name":{"type":"string","description":"Point cloud name"}},"title":"PointCloudDto"},"PointCloudFeatures":{"type":"object","properties":{"octree":{"$ref":"#/definitions/OctreeInfo"},"sensorLocation":{"$ref":"#/definitions/SensorLocation"}},"title":"PointCloudFeatures"},"PointCloudInfo":{"type":"object","required":["pointCloudRef"],"properties":{"pointCloudRef":{"$ref":"#/definitions/PointCloudRef"},"sensorLocation":{"type":"array","items":{"type":"number","format":"double","minimum":3,"maximum":3}},"transformation":{"type":"array","items":{"type":"number","format":"double","minimum":16,"maximum":16}}},"title":"PointCloudInfo"},"PointCloudMetadata":{"type":"object","properties":{"features":{"$ref":"#/definitions/PointCloudFeatures"},"points":{"$ref":"#/definitions/Points"}},"title":"PointCloudMetadata"},"PointCloudRef":{"type":"object","discriminator":"type","title":"PointCloudRef","description":"Use one of the subtypes"},"PointFeatures":{"type":"object","properties":{"classification":{"$ref":"#/definitions/PointClassifications"},"color":{"type":"boolean"},"intensity":{"type":"boolean"},"numberOfReturns":{"type":"boolean"},"pointSourceId":{"type":"boolean"}},"title":"PointFeatures"},"Points":{"type":"object","properties":{"bounds":{"$ref":"#/definitions/BoundingBox"},"features":{"$ref":"#/definitions/PointFeatures"},"numberOfPoints":{"type":"integer","format":"int64"}},"title":"Points"},"PreProcessingJob":{"type":"object","required":["createdDate","status"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"PreProcessingJob"},"PreProcessingJobDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"PreProcessingJobDto"},"PreProcessingParameterDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"knearestNeighbours":{"type":"integer","format":"int32"},"maxDistanceThreshold":{"type":"number","format":"double"},"resampleSpacing":{"type":"number","format":"double"}},"title":"PreProcessingParameterDto"},"PreProcessingParameters":{"type":"object","required":["maxDistanceThreshold","resampleSpacing"],"properties":{"id":{"type":"integer","format":"int64"},"knearestNeighbours":{"type":"integer","format":"int32"},"maxDistanceThreshold":{"type":"number","format":"double"},"resampleSpacing":{"type":"number","format":"double"}},"title":"PreProcessingParameters"},"PreRegistrationData":{"type":"object","required":["pointCloudsTransformation"],"properties":{"estimatedSensorLocations":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}},"graphNetwork":{"$ref":"#/definitions/GraphNetworkDto"},"pointCloudsTransformation":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}}},"title":"PreRegistrationData"},"PreprocessingCompletedMessage":{"type":"object","required":["errorMessage"],"properties":{"context":{"$ref":"#/definitions/MessageContext"},"decimatedPointsCount":{"type":"integer","format":"int64"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"exceptionTrace":{"$ref":"#/definitions/Throwable"},"initialPointsCount":{"type":"integer","format":"int64"},"path":{"type":"string"}},"title":"PreprocessingCompletedMessage"},"PreprocessingParametersPostDto":{"type":"object","required":["maxDistanceThreshold","resampleSpacing"],"properties":{"maxDistanceThreshold":{"type":"number","format":"double","example":20.0,"description":"The maximum point distance from the scanner to use in registration"},"resampleSpacing":{"type":"number","format":"double","example":0.025,"description":"The minimum distance between points to preserve. Smaller value increases processing time"}},"title":"PreprocessingParametersPostDto"},"ProcessPairwiseRegistrationsDto":{"type":"object","properties":{"executionResult":{"$ref":"#/definitions/PairwiseExecutionResult"},"pointCloudsTransformation":{"type":"object","additionalProperties":{"type":"array","items":{"type":"number","format":"double"}}}},"title":"ProcessPairwiseRegistrationsDto"},"ProcessPairwiseRegistrationsRequest":{"type":"object","required":["graphNetwork","pairwiseResults"],"properties":{"graphNetwork":{"$ref":"#/definitions/GraphNetworkDto"},"pairwiseResults":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/definitions/ChildTransformationMatrixDto"}}},"resumeState":{"type":"string"}},"title":"ProcessPairwiseRegistrationsRequest"},"ProfileDto":{"type":"object","required":["accountingInfo","companyInfo","emailAddress","signupInfo","userId","userInfo","userRoles"],"properties":{"accountingInfo":{"$ref":"#/definitions/AccountingInfo"},"companyInfo":{"$ref":"#/definitions/CompanyInfo"},"emailAddress":{"type":"string","description":"Email address"},"signupInfo":{"$ref":"#/definitions/SignupInfo"},"userId":{"type":"integer","format":"int64","description":"User ID"},"userInfo":{"$ref":"#/definitions/UserInfo"},"userRoles":{"$ref":"#/definitions/UserRoles"}},"title":"ProfileDto"},"ProjectApiDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18371},"name":{"type":"string","example":"Project Alignment"},"preProcessingJob":{"example":{"completedDate": "2019-09-04T09:47:08.386Z", "createdDate": "2019-09-04T09:47:08.386Z", "startedDate": "2019-09-04T09:47:08.386Z", "status": "COMPLETED"},"$ref":"#/definitions/JobDto"},"coarseRegistrationJob":{"example":{"completedDate": null, "createdDate": "2019-09-04T10:11:09.121Z", "startedDate": "2019-09-04T10:11:09.121Z", "status": "STARTED"},"$ref":"#/definitions/JobDto"},"fineRegistrationJob":{"example":"null","$ref":"#/definitions/JobDto"},"exportJob":{"example":"null","$ref":"#/definitions/ExportJobDto"}},"title":"ProjectApiDto"},"ProjectApiPost":{"type":"object","required":["config","name","pairs","scans"],"properties":{"name":{"type":"string","example":"Project Alignment","description":"The project's name"},"scans":{"description":"The scans definition","$ref":"#/definitions/WebScansPost"},"pairs":{"type":"array","example":[{"parentName": "scan1.ptx", "childName": "scan1.ptx"}, {"parentName": "scan1.ptx", "childName": "scan2.ptx"}],"description":"The scans pairing","items":{"$ref":"#/definitions/ScanPairApiPost"}},"config":{"description":"The project configuration","$ref":"#/definitions/VercatorConfigPostDto"}},"title":"ProjectApiPost"},"ProjectConfigs":{"type":"object","required":["importJobs"],"properties":{"importJobs":{"description":"Import jobs related settings","$ref":"#/definitions/ImportJobs"}},"title":"ProjectConfigs"},"ProjectCreateRequest":{"type":"object","properties":{"description":{"$ref":"#/definitions/Optional«string»"},"name":{"type":"string"}},"title":"ProjectCreateRequest"},"ProjectDto":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Time when project was created"},"description":{"type":"string","description":"Description of project"},"id":{"type":"integer","format":"int64","description":"Id of project"},"name":{"type":"string","description":"Name of project"},"ownerId":{"type":"integer","format":"int64","description":"Owner Id of project"},"starred":{"type":"boolean","description":"Flag if project is starred"}},"title":"ProjectDto"},"ProjectPost":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"ProjectPost"},"ProjectTransformation":{"type":"object","required":["projectMatrixCalculated"],"properties":{"id":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"projectMatrixCalculated":{"type":"boolean"},"projectTransformationMatrix":{"type":"array","items":{"type":"number","format":"double"}}},"title":"ProjectTransformation"},"ProjectUpdateRequest":{"type":"object","properties":{"description":{"$ref":"#/definitions/Optional«string»"},"name":{"$ref":"#/definitions/Optional«string»"}},"title":"ProjectUpdateRequest"},"ProjectUserSettingsRequest":{"type":"object","required":["starred"],"properties":{"starred":{"type":"boolean","description":"Flag if project is starred"}},"title":"ProjectUserSettingsRequest"},"Projects":{"type":"object","required":["jobs"],"properties":{"jobs":{"description":"Jobs","$ref":"#/definitions/Jobs"}},"title":"Projects"},"PublicLinkApiDto":{"type":"object","properties":{"url":{"type":"string","example":"https://vercator.cloud/files/companies/1/scan1.pts"}},"title":"PublicLinkApiDto"},"PublicLinkListApiDto":{"type":"object","properties":{"urls":{"type":"array","example":[ "https://vercator.cloud/files/companies/1/scan1.pts","https://vercator.cloud/files/companies/1/scan2.pts","https://vercator.cloud/files/companies/1/scan3.pts" ],"items":{"type":"string"}},"failed":{"type":"object","example":{ "https://original.scan.url/failed/scan.ptx": "Failed due to some error" },"additionalProperties":{"type":"string"}},"notCompleted":{"type":"array","example":[ "https://original.scan.url/not/completed/scan.ptx" ],"items":{"type":"string"}}},"title":"PublicLinkListApiDto"},"PutObjectRequest":{"type":"object","required":["ACL","Bucket","Key"],"properties":{"ACL":{"type":"string","description":"ACL name"},"Bucket":{"type":"string","description":"Bucket name(currently not in use)"},"Key":{"type":"string","description":"File key inside the bucket"}},"title":"PutObjectRequest"},"QAOptions":{"type":"object","required":["maxOverlapSearchDistance"],"properties":{"maxOverlapSearchDistance":{"type":"number","format":"double","minimum":0.0,"exclusiveMinimum":false}},"title":"QAOptions"},"RecaptchaV3":{"type":"object","required":["actions","siteKey"],"properties":{"actions":{"description":"Support action names based on screen and behaviour.","$ref":"#/definitions/Actions"},"siteKey":{"type":"string","description":"Site key"}},"title":"RecaptchaV3"},"RegistrationJob":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["AUTO_REGISTRATION","MANUAL_REGISTRATION","OPTIMISE_REGISTRATION"]}},"title":"RegistrationJob"},"RegistrationPreProcessingOptions":{"type":"object","required":["maxDistanceToScanner","resamplingSpacing"],"properties":{"maxDistanceToScanner":{"type":"number","format":"double"},"resamplingSpacing":{"type":"number","format":"double","minimum":0.0,"exclusiveMinimum":false}},"title":"RegistrationPreProcessingOptions"},"RegistrationProjectDto":{"type":"object","properties":{"coarseRegistrationJob":{"$ref":"#/definitions/CoarseRegistrationJobDto"},"config":{"$ref":"#/definitions/VercatorConfigDto"},"createdDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"exportJob":{"$ref":"#/definitions/ExportJobDto"},"fineRegistrationJob":{"$ref":"#/definitions/FineRegistrationJobDto"},"id":{"type":"integer","format":"int64"},"lastAccessed":{"type":"string","format":"date-time"},"levels":{"type":"array","items":{"$ref":"#/definitions/LevelDto"}},"name":{"type":"string"},"pairs":{"type":"array","items":{"$ref":"#/definitions/ScanPairDto"}},"preProcessingJob":{"$ref":"#/definitions/PreProcessingJobDto"},"scans":{"type":"array","items":{"$ref":"#/definitions/ScanDto"}},"surveyCoordinatesJob":{"$ref":"#/definitions/SurveyCoordinatesJobDto"},"targetLinks":{"type":"array","items":{"$ref":"#/definitions/ScanTargetLinkDto"}},"targets":{"type":"array","items":{"$ref":"#/definitions/SurveyTargetDto"}}},"title":"RegistrationProjectDto"},"RegistrationQARunCreateRequest":{"type":"object","required":["options","registrationJob"],"properties":{"groupName":{"type":"string"},"name":{"type":"string"},"options":{"$ref":"#/definitions/Options"},"registrationJob":{"$ref":"#/definitions/RegistrationJob"}},"title":"RegistrationQARunCreateRequest"},"RegistrationQARunOutputsDto":{"type":"object","properties":{"pairwiseStats":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/definitions/PairwiseStatsItem"}}}},"title":"RegistrationQARunOutputsDto"},"RegistrationReportParameters":{"type":"object","required":["maxDistance","octreeNodeSize"],"properties":{"id":{"type":"integer","format":"int64"},"maxDistance":{"type":"number","format":"double"},"octreeNodeSize":{"type":"number","format":"double"}},"title":"RegistrationReportParameters"},"RegistrationReportParametersDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"maxDistance":{"type":"number","format":"double"},"octreeNodeSize":{"type":"number","format":"double"}},"title":"RegistrationReportParametersDto"},"RegistrationReportParametersPostDto":{"type":"object","required":["maxDistance"],"properties":{"maxDistance":{"type":"number","format":"double","example":0.1,"description":"The maximum distance to search between scan pairs for a matching point","minimum":0.0,"exclusiveMinimum":false}},"title":"RegistrationReportParametersPostDto"},"RemoteDataDto":{"type":"object","required":["id","type"],"properties":{"folderId":{"type":"string","description":"Id of the containing folder. Null if it is the root folder"},"id":{"type":"string","description":"File or folder id"},"name":{"type":"string","description":"File or folder name"},"size":{"type":"integer","format":"int64","description":"File size"},"type":{"type":"string","description":"File or folder","enum":["folder","file"]}},"title":"RemoteDataDto"},"RemoteStorageCreateAzureRequest":{"title":"RemoteStorageCreateAzureRequest","allOf":[{"$ref":"#/definitions/RemoteStorageCreateRequest"},{"type":"object","required":["name","secrets","settings","type"],"properties":{"name":{"type":"string","description":"Remote storage name"},"secrets":{"description":"Azure storage secrets","$ref":"#/definitions/AzureSecrets"},"settings":{"description":"Azure storage settings","$ref":"#/definitions/AzureSettings"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageCreateAzureRequest"}]},"RemoteStorageCreateDropboxRequest":{"title":"RemoteStorageCreateDropboxRequest","allOf":[{"$ref":"#/definitions/RemoteStorageCreateRequest"},{"type":"object","required":["name","secrets","settings","type"],"properties":{"name":{"type":"string","description":"Remote storage name"},"secrets":{"description":"Dropbox secrets","$ref":"#/definitions/DropboxSecrets"},"settings":{"description":"Dropbox settings are always empty","$ref":"#/definitions/DropboxSettings"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageCreateDropboxRequest"}]},"RemoteStorageCreateRequest":{"type":"object","required":["name","type"],"discriminator":"type","properties":{"name":{"type":"string","description":"Remote storage name"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageCreateRequest","description":"Use one of the subtypes"},"RemoteStorageCreateS3Request":{"title":"RemoteStorageCreateS3Request","allOf":[{"$ref":"#/definitions/RemoteStorageCreateRequest"},{"type":"object","required":["name","secrets","settings","type"],"properties":{"name":{"type":"string","description":"Remote storage name"},"secrets":{"description":"S3 storage secrets","$ref":"#/definitions/S3Secrets"},"settings":{"description":"S3 storage settings","$ref":"#/definitions/S3Settings"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageCreateS3Request"}]},"RemoteStorageUpdateAzureRequest":{"title":"RemoteStorageUpdateAzureRequest","allOf":[{"$ref":"#/definitions/RemoteStorageUpdateRequest"},{"type":"object","required":["name","secrets","settings","type"],"properties":{"name":{"description":"Remote storage name","$ref":"#/definitions/Optional«string»"},"secrets":{"description":"Azure storage secrets","$ref":"#/definitions/Optional«AzureSecrets»"},"settings":{"description":"Azure storage settings","$ref":"#/definitions/Optional«AzureSettings»"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageUpdateAzureRequest"}]},"RemoteStorageUpdateDropboxRequest":{"title":"RemoteStorageUpdateDropboxRequest","allOf":[{"$ref":"#/definitions/RemoteStorageUpdateRequest"},{"type":"object","required":["name","secrets","settings","type"],"properties":{"name":{"description":"Remote storage name","$ref":"#/definitions/Optional«string»"},"secrets":{"description":"Dropbox secrets","$ref":"#/definitions/Optional«DropboxSecrets»"},"settings":{"description":"Dropbox settings are always empty","$ref":"#/definitions/Optional«DropboxSettings»"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageUpdateDropboxRequest"}]},"RemoteStorageUpdateRequest":{"type":"object","required":["name","type"],"discriminator":"type","properties":{"name":{"description":"Remote storage name","$ref":"#/definitions/Optional«string»"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageUpdateRequest","description":"Use one of the subtypes"},"RemoteStorageUpdateS3Request":{"title":"RemoteStorageUpdateS3Request","allOf":[{"$ref":"#/definitions/RemoteStorageUpdateRequest"},{"type":"object","required":["name","secrets","settings","type"],"properties":{"name":{"description":"Remote storage name","$ref":"#/definitions/Optional«string»"},"secrets":{"description":"S3 storage secrets","$ref":"#/definitions/Optional«S3Secrets»"},"settings":{"description":"S3 storage settings","$ref":"#/definitions/Optional«S3Settings»"},"type":{"type":"string","enum":["S3","AZURE","DROPBOX"]}},"title":"RemoteStorageUpdateS3Request"}]},"RemoteStorages":{"type":"object","required":["dropbox"],"properties":{"dropbox":{"description":"Dropbox settings","$ref":"#/definitions/Dropbox"}},"title":"RemoteStorages"},"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"statusCodeValue":{"type":"integer","format":"int32"}},"title":"ResponseEntity"},"RunStatusDto":{"type":"object","required":["id","name","projectId","startedAt","startedBy","status"],"properties":{"finishedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been finished"},"groupName":{"type":"string","description":"Job Group Name"},"id":{"type":"string","description":"Unique identifier"},"name":{"type":"string","description":"Job Name"},"progress":{"type":"array","description":"Progress history items","items":{"$ref":"#/definitions/StageProgressDto"}},"projectId":{"type":"integer","format":"int64","description":"Project Id that is associated with the job"},"startedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been started"},"startedBy":{"type":"integer","format":"int64","description":"User Id started the job"},"status":{"type":"string","description":"Status of the job","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]},"statusError":{"description":"Error Status Information","$ref":"#/definitions/StatusError"}},"title":"RunStatusDto"},"RunSummaryDto":{"type":"object","required":["id","name","projectId","startedAt","startedBy","status"],"properties":{"finishedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been finished"},"groupName":{"type":"string","description":"Job Group Name"},"id":{"type":"string","description":"Unique identifier"},"name":{"type":"string","description":"Job Name"},"projectId":{"type":"integer","format":"int64","description":"Project Id that is associated with the job"},"startedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been started"},"startedBy":{"type":"integer","format":"int64","description":"User Id started the job"},"status":{"type":"string","description":"Status of the job","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}},"title":"RunSummaryDto"},"ScanConversionUiScans":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"path":{"type":"string"},"scanConversionUtilityProjectId":{"type":"integer","format":"int64"},"storageId":{"type":"integer","format":"int64"}},"title":"ScanConversionUiScans"},"ScanConversionUtilityProject":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"format":{"type":"string"},"id":{"type":"integer","format":"int64"},"job":{"$ref":"#/definitions/ScanFormatConversionBatchTask"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"scans":{"type":"array","items":{"$ref":"#/definitions/ScanConversionUiScans"}},"userId":{"type":"integer","format":"int64"}},"title":"ScanConversionUtilityProject"},"ScanConversionUtilityProjectDto":{"type":"object","properties":{"description":{"type":"string"},"format":{"type":"string"},"job":{"$ref":"#/definitions/ScanFormatConversionBatchTask"},"name":{"type":"string"},"scans":{"type":"array","items":{"$ref":"#/definitions/ScanConversionUiScans"}}},"title":"ScanConversionUtilityProjectDto"},"ScanConverterScan":{"type":"object","required":["batchTaskId","splitScanTaskId"],"properties":{"batchTaskId":{"type":"integer","format":"int64"},"formatConversionTaskId":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"},"path":{"type":"string"},"splitScanTaskId":{"type":"integer","format":"int64"}},"title":"ScanConverterScan"},"ScanDescriptorParameters":{"type":"object","required":["minOctreeNodeSize","orientedSurfaces","planViewParameters"],"properties":{"id":{"type":"integer","format":"int64"},"minOctreeNodeSize":{"type":"number","format":"double"},"orientedSurfaces":{"type":"boolean"},"planViewParameters":{"$ref":"#/definitions/PlanviewParameters"},"zhistogramBinWidth":{"type":"number","format":"double"}},"title":"ScanDescriptorParameters"},"ScanDescriptorParametersDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"minOctreeNodeSize":{"type":"number","format":"double"},"orientedSurfaces":{"type":"boolean"},"planViewParameters":{"$ref":"#/definitions/PlanviewParametersDto"},"zhistogramBinWidth":{"type":"number","format":"double"}},"title":"ScanDescriptorParametersDto"},"ScanDto":{"type":"object","properties":{"accounted":{"type":"boolean"},"coarseGlobalConversionError":{"type":"string"},"coarseGlobalConverted":{"type":"boolean"},"coarseGlobalTransformationMatrix":{"type":"array","items":{"type":"number","format":"double"}},"convertedBeforePreprocessing":{"type":"boolean"},"convertedBeforePreprocessingError":{"type":"string"},"copied":{"type":"boolean"},"copyError":{"type":"string"},"exportError":{"type":"string"},"exported":{"type":"boolean"},"exportedPath":{"type":"string"},"fineGlobalTransformationMatrix":{"type":"array","items":{"type":"number","format":"double"}},"fineRegistered":{"type":"boolean"},"fineRegistrationError":{"type":"string"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"path":{"type":"string"},"potreeConversionError":{"type":"string"},"potreeConverted":{"type":"boolean"},"preprocessed":{"type":"boolean"},"preprocessingError":{"type":"string"},"scanGrapherIsRootScan":{"type":"boolean"},"scanGrapherLevelId":{"type":"integer","format":"int64"},"scanGrapherX":{"type":"number","format":"double"},"scanGrapherY":{"type":"number","format":"double"}},"title":"ScanDto"},"ScanFormatConversionBatchDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"fileCopyJobs":{"type":"array","items":{"$ref":"#/definitions/FileCopyJobDto"}},"format":{"type":"string"},"id":{"type":"integer","format":"int64"},"locationType":{"type":"string"},"mergeResults":{"type":"boolean"},"scanFormatConversionTasks":{"type":"array","items":{"$ref":"#/definitions/ScanFormatConversionDto"}},"splitScanTasks":{"type":"array","items":{"$ref":"#/definitions/SplitScanDto"}},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]},"totalConvertedPointsCount":{"type":"integer","format":"int64"}},"title":"ScanFormatConversionBatchDto"},"ScanFormatConversionBatchPost":{"type":"object","required":["format","paths","type"],"properties":{"paths":{"type":"array","example":["https://bucket.s3.eu-west-2.amazonaws.com/scan1.ptx", "https://bucket.s3.eu-west-2.amazonaws.com/scan2.ptx", "https://bucket.s3.eu-west-2.amazonaws.com/scan3.ptx"],"description":"The paths to the scans. Allowed extensions: ptx, pts, e57, fls, zfs, rdbx, ply, las, laz.","items":{"type":"string"}},"type":{"type":"string","example":"HTTP","description":"Optional value which specifies whether a URL should be followed to reach the scan or it resides in the user's hosted storage.","enum":["HTTP","HTTPS","HOSTED_STORAGE"]},"mergeResults":{"type":"boolean","example":false,"description":"Optional value which specifies whether we want (or don't want) to merge all the points of a multiscan into a single scan. There should be a single element in the 'paths' list."},"format":{"type":"string","example":"RCS","description":"The output scan format","enum":["XYZ","PLY","E57","PTS","LAS","LAZ","RCS"]}},"title":"ScanFormatConversionBatchPost"},"ScanFormatConversionBatchTask":{"type":"object","required":["createdDate","fileCopyJobs","format","retryCount","scanConverterScans","scanFormatConversionTasks","splitScanTasks","status","totalConvertedPointsCount"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"fileCopyJobs":{"type":"array","items":{"$ref":"#/definitions/FileCopyJob"}},"format":{"type":"string"},"id":{"type":"integer","format":"int64"},"inputFilesCount":{"type":"integer","format":"int32"},"locationType":{"type":"string"},"mergeResults":{"type":"boolean"},"retryCount":{"type":"integer","format":"int32"},"scanConverterScans":{"type":"array","items":{"$ref":"#/definitions/ScanConverterScan"}},"scanFormatConversionTasks":{"type":"array","items":{"$ref":"#/definitions/ScanFormatConversionTask"}},"splitScanTasks":{"type":"array","items":{"$ref":"#/definitions/SplitScanTask"}},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"totalConvertedPointsCount":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]},"userId":{"type":"integer","format":"int64"}},"title":"ScanFormatConversionBatchTask"},"ScanFormatConversionDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"outputPath":{"type":"string"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"ScanFormatConversionDto"},"ScanFormatConversionStatusDto":{"type":"object","required":["errorMessage"],"properties":{"context":{"$ref":"#/definitions/MessageContext"},"convertedPointsCount":{"type":"integer","format":"int64"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"exceptionTrace":{"$ref":"#/definitions/Throwable"}},"title":"ScanFormatConversionStatusDto"},"ScanFormatConversionTask":{"type":"object","required":["batchTaskId","convertedPointsCount","createdDate","outputPath","retryCount","status"],"properties":{"batchTaskId":{"type":"integer","format":"int64"},"completedDate":{"type":"string","format":"date-time"},"convertedPointsCount":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"id":{"type":"integer","format":"int64"},"outputPath":{"type":"string"},"retryCount":{"type":"integer","format":"int32"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"ScanFormatConversionTask"},"ScanGrapherDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"scanGrapherIsRootScan":{"type":"boolean"},"scanGrapherLevelId":{"type":"integer","format":"int64"},"scanGrapherX":{"type":"number","format":"double"},"scanGrapherY":{"type":"number","format":"double"}},"title":"ScanGrapherDto"},"ScanGrapherLevel":{"type":"object","required":["levelName"],"properties":{"floorPlan":{"type":"string"},"id":{"type":"integer","format":"int64"},"levelName":{"type":"string"},"project":{"$ref":"#/definitions/CorrevateProject«object,object»"}},"title":"ScanGrapherLevel"},"ScanGrapherPost":{"type":"object","required":["scans"],"properties":{"scans":{"type":"array","items":{"$ref":"#/definitions/ScanGrapherDto"}}},"title":"ScanGrapherPost"},"ScanPairApiPost":{"type":"object","required":["childName","parentName"],"properties":{"parentName":{"type":"string","description":"Name of the parent scan of the pair. Must match a scan within the 'scans' field"},"childName":{"type":"string","description":"Name of the child scan of the pair. Must match a scan within the 'scans' field"}},"title":"ScanPairApiPost"},"ScanPairDto":{"type":"object","required":["coarseRegistered","coarseRegistrationError"],"properties":{"child":{"$ref":"#/definitions/ScanDto"},"childParentTransformationMatrix":{"type":"array","items":{"type":"number","format":"double"}},"coarseRegistered":{"type":"boolean"},"coarseRegistrationError":{"type":"string"},"id":{"type":"integer","format":"int64"},"overlapFraction":{"type":"number","format":"double"},"parent":{"$ref":"#/definitions/ScanDto"},"visibilityFraction":{"type":"number","format":"double"}},"title":"ScanPairDto"},"ScanPairPost":{"type":"object","required":["childId","parentId"],"properties":{"childId":{"type":"integer","format":"int64"},"parentId":{"type":"integer","format":"int64"}},"title":"ScanPairPost"},"ScanPairRegistrationStatisticsDto":{"type":"object","properties":{"scanOverlapFraction":{"type":"number","format":"double"},"scanVisibilityFraction":{"type":"number","format":"double"}},"title":"ScanPairRegistrationStatisticsDto"},"ScanPairsPost":{"type":"object","required":["pairs"],"properties":{"pairs":{"type":"array","items":{"$ref":"#/definitions/ScanPairPost"}}},"title":"ScanPairsPost"},"ScanSplitResponseDto":{"type":"object","properties":{"error":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"splitScanPaths":{"type":"array","items":{"type":"string"}}},"title":"ScanSplitResponseDto"},"ScanTargetLink":{"type":"object","required":["linkLocationConversionError","linkLocationConverted","localTargetAzimuthAngle","localTargetPolarAngle","localTargetX","localTargetY","localTargetZ","scanId","targetId"],"properties":{"id":{"type":"integer","format":"int64"},"linkLocationConversionError":{"type":"string"},"linkLocationConverted":{"type":"boolean"},"localTargetAzimuthAngle":{"type":"number","format":"double"},"localTargetPolarAngle":{"type":"number","format":"double"},"localTargetX":{"type":"number","format":"double"},"localTargetY":{"type":"number","format":"double"},"localTargetZ":{"type":"number","format":"double"},"project":{"$ref":"#/definitions/CorrevateProject«object,object»"},"scanId":{"type":"integer","format":"int64"},"targetId":{"type":"integer","format":"int64"}},"title":"ScanTargetLink"},"ScanTargetLinkDto":{"type":"object","required":["linkLocationConverted","localTargetAzimuthAngle","localTargetPolarAngle","localTargetX","localTargetY","localTargetZ","scanId","targetId"],"properties":{"id":{"type":"integer","format":"int64"},"linkLocationConverted":{"type":"boolean"},"localTargetAzimuthAngle":{"type":"number","format":"double"},"localTargetPolarAngle":{"type":"number","format":"double"},"localTargetX":{"type":"number","format":"double"},"localTargetY":{"type":"number","format":"double"},"localTargetZ":{"type":"number","format":"double"},"scanId":{"type":"integer","format":"int64"},"targetId":{"type":"integer","format":"int64"}},"title":"ScanTargetLinkDto"},"ScanTargetLinkPost":{"type":"object","properties":{"error":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"scanTargetLinkDto":{"$ref":"#/definitions/ScanTargetLinkDto"}},"title":"ScanTargetLinkPost"},"ScanTransformationMatrixBase64Dto":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"},"matrixBase64":{"type":"string"}},"title":"ScanTransformationMatrixBase64Dto"},"ScanTransformationMatrixDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"matrix":{"type":"array","items":{"type":"number","format":"double"}}},"title":"ScanTransformationMatrixDto"},"ScansDeletePost":{"type":"object","required":["scans"],"properties":{"scans":{"type":"array","items":{"type":"integer","format":"int64"}}},"title":"ScansDeletePost"},"SegmentationApiRunCreateRequest":{"type":"object","properties":{"model":{"type":"string"},"name":{"type":"string"},"pointCloudUrl":{"type":"string"}},"title":"SegmentationApiRunCreateRequest"},"SegmentationApiRunOutputsDto":{"type":"object","properties":{"pointCloud":{"$ref":"#/definitions/PointCloud"}},"title":"SegmentationApiRunOutputsDto"},"SegmentationApiRunStatusDto":{"type":"object","required":["id","name","startedAt","startedByApiKey","status"],"properties":{"finishedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been finished"},"id":{"type":"string","description":"Unique identifier"},"name":{"type":"string","description":"Job Name"},"progress":{"type":"array","description":"Progress history items","items":{"$ref":"#/definitions/StageProgressDto"}},"startedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been started"},"startedByApiKey":{"type":"integer","format":"int64","description":"User Id started the job"},"status":{"type":"string","description":"Status of the job","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]},"statusError":{"description":"Error Status Information","$ref":"#/definitions/StatusError"}},"title":"SegmentationApiRunStatusDto"},"SegmentationJobPointCloudRef":{"title":"SegmentationJobPointCloudRef","allOf":[{"$ref":"#/definitions/PointCloudRef"},{"type":"object","required":["ref"],"properties":{"ref":{"description":"Point Cloud Reference Information","$ref":"#/definitions/PointCloudReference"}},"title":"SegmentationJobPointCloudRef"}]},"SegmentationOutputClass":{"type":"object","properties":{"instances":{"type":"array","items":{"$ref":"#/definitions/SegmentationOutputInstance"}},"lazClassCode":{"type":"integer","format":"int32"}},"title":"SegmentationOutputClass"},"SegmentationOutputInstance":{"type":"object","properties":{"boundingBox":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}},"centroid":{"type":"array","items":{"type":"number","format":"double"}},"confidence":{"type":"number","format":"double"},"id":{"type":"string"}},"title":"SegmentationOutputInstance"},"SegmentationRunCreateRequest":{"type":"object","required":["pointCloud"],"properties":{"groupName":{"$ref":"#/definitions/Optional«string»"},"model":{"type":"string"},"name":{"type":"string"},"pointCloud":{"$ref":"#/definitions/PointCloudRef"}},"title":"SegmentationRunCreateRequest"},"SegmentationRunDto":{"type":"object","required":["id","name","startedAt","startedByApiKey","status"],"properties":{"finishedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been finished"},"id":{"type":"string","description":"Unique identifier"},"name":{"type":"string","description":"Job Name"},"startedAt":{"type":"string","format":"date-time","description":"Time in UTC (ISO8601) when the job has been started"},"startedByApiKey":{"type":"integer","format":"int64","description":"API key Id used to start the job"},"status":{"type":"string","description":"Status of the job","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]}},"title":"SegmentationRunDto"},"SegmentationRunOutputsDto":{"type":"object","properties":{"legacyClassInstances":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/SegmentationOutputInstance"}}},"numberOfPoints":{"type":"integer","format":"int64"},"pointCloud":{"$ref":"#/definitions/PointCloudDto"}},"title":"SegmentationRunOutputsDto"},"SelectedPathsDto":{"type":"object","properties":{"paths":{"type":"array","items":{"type":"string"}}},"title":"SelectedPathsDto"},"SensorLocation":{"type":"object","properties":{"position":{"type":"array","items":{"type":"number","format":"double"}}},"title":"SensorLocation"},"ShareExportsDto":{"type":"object","required":["emailAddresses"],"properties":{"emailAddresses":{"type":"array","items":{"type":"string"}}},"title":"ShareExportsDto"},"SignupInfo":{"type":"object","required":["emailActivationMissing","industryDetailsMissing","userDetailsMissing"],"properties":{"emailActivationMissing":{"type":"boolean","description":"True if user hasn't yet activated the e-mail"},"industryDetailsMissing":{"type":"boolean","description":"True if user hasn't set company details (ex: name)"},"userDetailsMissing":{"type":"boolean","description":"True if user hasn't set details (ex: first / last name, phone number...)"}},"title":"SignupInfo"},"SignupRequest":{"type":"object","required":["captcha","email","password"],"properties":{"captcha":{"type":"string","description":"Valid Recaptcha V3 token generated by the frontend"},"email":{"type":"string","description":"Unique email address for the admin user"},"password":{"type":"string","description":"Password for the admin user. Must follow the following rules:\n* At least 8 characters long\n* Must contain at least 1 number\n* Must contain at least 1 lower case letter\n* Must contain at least 1 upper case letter\n* Must contain at least 1 symbol\n"}},"title":"SignupRequest"},"SplitScanDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"inputPath":{"type":"string"},"outputPaths":{"type":"array","items":{"type":"string"}},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"SplitScanDto"},"SplitScanTask":{"type":"object","required":["batchTaskId","createdDate","inputPath","retryCount","status"],"properties":{"batchTaskId":{"type":"integer","format":"int64"},"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"errorMessage":{"type":"string"},"id":{"type":"integer","format":"int64"},"inputPath":{"type":"string"},"retryCount":{"type":"integer","format":"int32"},"scanConverterScans":{"type":"array","items":{"$ref":"#/definitions/ScanConverterScan"}},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"SplitScanTask"},"StackTraceElement":{"type":"object","properties":{"classLoaderName":{"type":"string"},"className":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"methodName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"nativeMethod":{"type":"boolean"}},"title":"StackTraceElement"},"StageProgressDto":{"type":"object","required":["progress","stageCode","status"],"properties":{"progress":{"type":"integer","format":"int32","description":"Progress"},"stageCode":{"type":"string","description":"Stage code"},"status":{"type":"string","description":"Status of the stage","enum":["PENDING","IN_PROGRESS","FAILED","DONE","DELETE_IN_PROGRESS","DELETE_FAILED"]},"statusErrorCode":{"type":"string","description":"Set only if status is set to FAILED. Contains the error code associated with the failure"}},"title":"StageProgressDto"},"StatusDto":{"type":"object","properties":{"error":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"matrix":{"type":"array","items":{"type":"number","format":"double"}}},"title":"StatusDto"},"StatusError":{"type":"object","required":["canResume","code"],"properties":{"canResume":{"type":"boolean","description":"Flag if job can be resumed after failure"},"code":{"type":"string","description":"Error code"}},"title":"StatusError"},"StorageDataDeleteRequest":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of a file or folder to delete"}},"title":"StorageDataDeleteRequest"},"SurveyCoordinateReportTxtUrl":{"type":"object","properties":{"txtUrl":{"type":"string"}},"title":"SurveyCoordinateReportTxtUrl"},"SurveyCoordinatesJob":{"type":"object","required":["completedLinkSearch","createdDate","maxLinkSearch","status"],"properties":{"completedDate":{"type":"string","format":"date-time"},"completedLinkSearch":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"maxLinkSearch":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]}},"title":"SurveyCoordinatesJob"},"SurveyCoordinatesJobDto":{"type":"object","properties":{"completedDate":{"type":"string","format":"date-time"},"completedLinkSearch":{"type":"integer","format":"int64"},"createdDate":{"type":"string","format":"date-time"},"maxLinkSearch":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","PARTIALLY_FAILED"]}},"title":"SurveyCoordinatesJobDto"},"SurveyTarget":{"type":"object","required":["autoCheckerBoardCentreFinder","globalTargetX","globalTargetY","globalTargetZ","targetName"],"properties":{"autoCheckerBoardCentreFinder":{"type":"boolean"},"globalTargetX":{"type":"number","format":"double"},"globalTargetY":{"type":"number","format":"double"},"globalTargetZ":{"type":"number","format":"double"},"id":{"type":"integer","format":"int64"},"project":{"$ref":"#/definitions/CorrevateProject«object,object»"},"scanTargetLinks":{"type":"array","items":{"$ref":"#/definitions/ScanTargetLink"}},"targetName":{"type":"string"}},"title":"SurveyTarget"},"SurveyTargetDto":{"type":"object","required":["autoCheckerBoardCentreFinder","globalTargetX","globalTargetY","globalTargetZ","targetName"],"properties":{"autoCheckerBoardCentreFinder":{"type":"boolean"},"globalTargetX":{"type":"number","format":"double"},"globalTargetY":{"type":"number","format":"double"},"globalTargetZ":{"type":"number","format":"double"},"id":{"type":"integer","format":"int64"},"targetName":{"type":"string"}},"title":"SurveyTargetDto"},"SurveyTargetsPost":{"type":"object","required":["surveyTargets"],"properties":{"surveyTargets":{"type":"array","items":{"$ref":"#/definitions/SurveyTargetDto"}}},"title":"SurveyTargetsPost"},"Throwable":{"type":"object","properties":{"cause":{"$ref":"#/definitions/Throwable"},"localizedMessage":{"type":"string"},"message":{"type":"string"},"stackTrace":{"type":"array","items":{"$ref":"#/definitions/StackTraceElement"}},"suppressed":{"type":"array","items":{"$ref":"#/definitions/Throwable"}}},"title":"Throwable"},"TokenBalanceConfig":{"type":"object","required":["belowThreshold","empty"],"properties":{"belowThreshold":{"description":"The threshold config when number of token is too low. Null to indicates off notification.","$ref":"#/definitions/Optional«int»"},"empty":{"description":"Indicate if send notification when number of token is 0","$ref":"#/definitions/Optional«boolean»"}},"title":"TokenBalanceConfig"},"TokenBalanceConfigDto":{"type":"object","properties":{"belowThreshold":{"type":"integer","format":"int32","description":"The threshold config when number of token is too low. Null to indicates off notification."},"empty":{"type":"boolean","description":"Indicate if send notification when number of token is 0"}},"title":"TokenBalanceConfigDto"},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}},"title":"URL"},"UpdateManualRegistrationPost":{"type":"object","required":["pairs"],"properties":{"initialTransformations":{"type":"array","items":{"$ref":"#/definitions/ScanTransformationMatrixBase64Dto"}},"inputsHash":{"type":"integer","format":"int32"},"iteration":{"type":"integer","format":"int32"},"pairs":{"type":"array","items":{"$ref":"#/definitions/ScanTransformationMatrixDto"}}},"title":"UpdateManualRegistrationPost"},"UserAdminDto":{"type":"object","required":["companyAdmin","createdAt","emailAddress","firstName","id","lastName","locked","phoneNumber","readOnly"],"properties":{"companyAdmin":{"type":"boolean","description":"If user is a Company Administrator"},"createdAt":{"type":"string","format":"date-time","description":"Time when user was created"},"emailAddress":{"type":"string","description":"Email address"},"firstName":{"type":"string","description":"First name"},"id":{"type":"integer","format":"int64","description":"Unique identifier"},"lastName":{"type":"string","description":"Last name"},"locked":{"type":"boolean","description":"If user is locked"},"phoneNumber":{"type":"string","description":"Phone number"},"readOnly":{"type":"boolean","description":"If user is read only"}},"title":"UserAdminDto"},"UserChangePasswordRequest":{"type":"object","required":["newPassword","oldPassword"],"properties":{"newPassword":{"type":"string","description":"User new password. Must follow the following rules:\n* At least 8 characters long\n* Must contain at least 1 number\n* Must contain at least 1 lower case letter\n* Must contain at least 1 upper case letter\n* Must contain at least 1 symbol\n"},"oldPassword":{"type":"string","description":"User old password"}},"title":"UserChangePasswordRequest"},"UserDto":{"type":"object","required":["companyId","emailAddress","id","info","roles"],"properties":{"companyId":{"type":"integer","format":"int64","description":"Company identifier associated with the user"},"emailAddress":{"type":"string","description":"Email address"},"id":{"type":"integer","format":"int64","description":"Unique identifier"},"info":{"$ref":"#/definitions/UserInfo"},"notifications":{"$ref":"#/definitions/Notifications"},"roles":{"$ref":"#/definitions/UserRoles"}},"title":"UserDto"},"UserInfo":{"type":"object","required":["firstName","lastName","phoneNumber"],"properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"phoneNumber":{"type":"string","description":"Phone number"}},"title":"UserInfo"},"UserKeyCreateRequest":{"type":"object","properties":{"label":{"type":"string","description":"Info about created key"}},"title":"UserKeyCreateRequest"},"UserKeyDto":{"type":"object","required":["createdAt","id"],"properties":{"createdAt":{"type":"string","format":"date-time","description":"Time when access key was created"},"expireAt":{"type":"string","format":"date-time","description":"Time when access key will be expired"},"id":{"type":"integer","format":"int64","description":"Unique identifier"},"label":{"type":"string","description":"Description of access key"},"lastUsed":{"type":"string","format":"date-time","description":"Time when access key was last used"}},"title":"UserKeyDto"},"UserPublicDto":{"type":"object","required":["firstName","id","lastName"],"properties":{"firstName":{"type":"string","description":"First name"},"id":{"type":"integer","format":"int64","description":"Unique identifier"},"lastName":{"type":"string","description":"Last name"}},"title":"UserPublicDto"},"UserRoles":{"type":"object","required":["companyAdmin","superUser"],"properties":{"companyAdmin":{"type":"boolean","description":"If user is a Company Administrator"},"superUser":{"type":"boolean","description":"If user is a Super User"}},"title":"UserRoles"},"UserUpdateRequest":{"type":"object","properties":{"firstName":{"description":"User first name","$ref":"#/definitions/Optional«string»"},"lastName":{"description":"User last name","$ref":"#/definitions/Optional«string»"},"notifications":{"description":"User Notifications","$ref":"#/definitions/Optional«Notifications»"},"phoneNumber":{"description":"User phone number","$ref":"#/definitions/Optional«string»"}},"title":"UserUpdateRequest"},"VercatorConfig":{"type":"object","required":["addSurveyCoordinates","emailNotification","skipCoarseResultChecking","threadCount"],"properties":{"addSurveyCoordinates":{"type":"boolean"},"applyProjectTransformationMatrix":{"type":"boolean"},"coarseRegistrationParameters":{"$ref":"#/definitions/CoarseRegistrationParameters"},"emailNotification":{"type":"boolean"},"exportParameters":{"$ref":"#/definitions/ExportParameters"},"fineRegistrationParameters":{"$ref":"#/definitions/FineRegistrationParameters"},"fineRegistrationReportParameters":{"$ref":"#/definitions/FineRegistrationReportParameters"},"id":{"type":"integer","format":"int64"},"preProcessingParameters":{"$ref":"#/definitions/PreProcessingParameters"},"registrationReportParameters":{"$ref":"#/definitions/RegistrationReportParameters"},"scanDescriptorsParameters":{"$ref":"#/definitions/ScanDescriptorParameters"},"skipCoarseResultChecking":{"type":"boolean"},"threadCount":{"type":"integer","format":"int32","minimum":1.0,"exclusiveMinimum":false}},"title":"VercatorConfig"},"VercatorConfigDto":{"type":"object","properties":{"addSurveyCoordinates":{"type":"boolean"},"applyProjectTransformationMatrix":{"type":"boolean"},"coarseRegistrationParameters":{"$ref":"#/definitions/CoarseRegistrationParametersDto"},"emailNotification":{"type":"boolean"},"fineRegistrationParameters":{"$ref":"#/definitions/FineRegistrationParametersDto"},"fineRegistrationReportParameters":{"$ref":"#/definitions/FineRegistrationReportParametersDto"},"preProcessingParameters":{"$ref":"#/definitions/PreProcessingParameterDto"},"registrationReportParameters":{"$ref":"#/definitions/RegistrationReportParametersDto"},"scanDescriptorsParameters":{"$ref":"#/definitions/ScanDescriptorParametersDto"},"skipCoarseResultChecking":{"type":"boolean"},"threadCount":{"type":"integer","format":"int32"}},"title":"VercatorConfigDto"},"VercatorConfigPostDto":{"type":"object","required":["coarseRegistrationParameters","emailNotification","exportParameters","fineRegistrationParameters","preProcessingParameters","registrationReportParameters","skipCoarseResultChecking"],"properties":{"applyProjectTransformationMatrix":{"type":"boolean"},"skipCoarseResultChecking":{"type":"boolean","example":true,"description":"true if you would like to continue after coarse registration stage"},"emailNotification":{"type":"boolean","example":false,"description":"true if you would like to receive emails when the coarse registration and fine registration jobs finish"},"preProcessingParameters":{"$ref":"#/definitions/PreprocessingParametersPostDto"},"coarseRegistrationParameters":{"$ref":"#/definitions/CoarseRegistrationParametersPostDto"},"registrationReportParameters":{"$ref":"#/definitions/RegistrationReportParametersPostDto"},"fineRegistrationParameters":{"$ref":"#/definitions/FineRegistrationParametersPostDto"},"exportParameters":{"$ref":"#/definitions/ExportParametersPostDto"}},"title":"VercatorConfigPostDto"},"VisualisationCreateRequest":{"type":"object","required":["pointCloud","projectId"],"properties":{"expiresAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"pointCloud":{"$ref":"#/definitions/PointCloudRef"},"projectId":{"type":"integer","format":"int64"}},"title":"VisualisationCreateRequest"},"VisualisationDataDto":{"type":"object","required":["pointCloud","visualisationName"],"properties":{"pointCloud":{"description":"Point cloud data","$ref":"#/definitions/PointCloudDto"},"visualisationName":{"type":"string","description":"Visualisation name"}},"title":"VisualisationDataDto"},"VisualisationDto":{"type":"object","required":["accessToken","id","lastAccessedAt","name","pointCloud","projectId","projectName"],"properties":{"accessToken":{"type":"string","description":"Access token"},"expiresAt":{"type":"string","format":"date-time","description":"Visualisation expiry time in UTC (ISO8601)"},"id":{"type":"string","description":"Unique identifier"},"lastAccessedAt":{"type":"string","format":"date-time","description":"Last access date time in UTC (ISO8601)"},"name":{"type":"string","description":"Visualisation name"},"pointCloud":{"description":"Visualised point cloud","$ref":"#/definitions/PointCloudRef"},"projectId":{"type":"integer","format":"int64","description":"Project Id that is associated with the visualised job"},"projectName":{"type":"string","description":"Project name that is associated with the visualised job"}},"title":"VisualisationDto"},"VisualisationLoginRequest":{"type":"object","required":["accessToken","visualisationId"],"properties":{"accessToken":{"type":"string","description":"Visualisation access token"},"visualisationId":{"type":"string","description":"Visualisation id"}},"title":"VisualisationLoginRequest"},"VisualisationTokenDto":{"type":"object","required":["token"],"properties":{"token":{"type":"string","description":"JWT Token"}},"title":"VisualisationTokenDto"},"WebApiInfoDto":{"type":"object","required":["projects","recaptchaV3","remoteStorages","siteKey"],"properties":{"env":{"type":"string"},"projects":{"description":"V3 Projects settings","$ref":"#/definitions/ProjectConfigs"},"recaptchaV3":{"description":"Recaptcha V3 settings","$ref":"#/definitions/RecaptchaV3"},"remoteStorages":{"description":"Remote storage settings","$ref":"#/definitions/RemoteStorages"},"siteKey":{"type":"string","description":"Recaptcha V2 site key"},"version":{"type":"string"}},"title":"WebApiInfoDto"},"WebProjectDto":{"type":"object","properties":{"coarseRegistrationJob":{"$ref":"#/definitions/CoarseRegistrationJobDto"},"config":{"$ref":"#/definitions/VercatorConfigDto"},"createdDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"exportJob":{"$ref":"#/definitions/ExportJobDto"},"fineRegistrationJob":{"$ref":"#/definitions/FineRegistrationJobDto"},"id":{"type":"integer","format":"int64"},"lastAccessed":{"type":"string","format":"date-time"},"levels":{"type":"array","items":{"$ref":"#/definitions/LevelDto"}},"name":{"type":"string"},"pairs":{"type":"array","items":{"$ref":"#/definitions/ScanPairDto"}},"preProcessingJob":{"$ref":"#/definitions/PreProcessingJobDto"},"scans":{"type":"array","items":{"$ref":"#/definitions/ScanDto"}},"surveyCoordinatesJob":{"$ref":"#/definitions/SurveyCoordinatesJobDto"},"targetLinks":{"type":"array","items":{"$ref":"#/definitions/ScanTargetLinkDto"}},"targets":{"type":"array","items":{"$ref":"#/definitions/SurveyTargetDto"}}},"title":"WebProjectDto"},"WebScansPost":{"type":"object","required":["scans"],"properties":{"scans":{"type":"array","example":["https://bucket.s3.eu-west-2.amazonaws.com/scan1.ptx","https://bucket.s3.eu-west-2.amazonaws.com/scan2.ptx"],"description":"Scan paths. Must be unique.","items":{"type":"string"}},"storageId":{"type":"integer","format":"int64","example":"null","description":"Optional storage identifier where scan are stored. Leave empty for HTTP/S scans."}},"title":"WebScansPost"},"ZipExportedScansJob":{"type":"object","required":["createdDate","exportJob","maxScansToZip","scansZippedCount","status","zipFileName"],"properties":{"completedDate":{"type":"string","format":"date-time"},"createdDate":{"type":"string","format":"date-time"},"exportJob":{"$ref":"#/definitions/ExportJob"},"id":{"type":"integer","format":"int64"},"maxScansToZip":{"type":"integer","format":"int64"},"scansZippedCount":{"type":"integer","format":"int64"},"startedDate":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["STARTED","FAILED","COMPLETED","CANCELLED","PARTIALLY_FAILED","DELETED"]},"type":{"type":"string","enum":["PREPROCESSING","COARSE_REGISTRATION","FINE_REGISTRATION","EXPORT","ZIP_FILES","SURVEY_COORDINATES","SCAN_FORMAT_CONVERSION_TASK","SCAN_FORMAT_CONVERSION_BATCH_TASK","FILE_COPY_JOB","SPLIT_SCAN_TASK","MERGING_SCAN_FORMAT_CONVERSION_TASK"]},"zipFileName":{"type":"string"}},"title":"ZipExportedScansJob"},"ZipExportedScansJobProgressDto":{"type":"object","properties":{"exportedScanDeleted":{"type":"boolean"},"exportedScanZipped":{"type":"boolean"}},"title":"ZipExportedScansJobProgressDto"}}}