Cancel a job.
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
Job id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.
Response 200 OK
OK
{ "job": { "id": "5e315451-564e-4e8b-a952-45b14e6a9c90", "state": "TerminatingOnCancel", "userId": "3a8670f9-b69f-4a60-b958-f103d580755f", "executionInfo": { "createdDateTime": "2025-08-05T14:04:56.0000000+00:00" }, "specifications": { "inputs": { "photos": "40a8142e-3277-4c65-922f-e1f3759b904b", "photoObjectDetector": "3879d57e-3387-4082-80d7-9bc94f974c7c" }, "outputs": { "objects2D": "f4cc6131-a9c8-4833-8d2a-cd0a11b8b778" } }, "name": "Objects2D Job", "type": "Objects2D", "iTwinId": "ce54f773-67db-4b4f-a98b-368329107429" } }
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified job was not found.
{ "error": { "code": "JobNotFound", "message": "Requested job is not available." } }
Response 422 Unprocessable Entity
The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)
{ "error": { "code": "InvalidRealityAnalysisRequest", "message": "Invalid request to Reality Analysis.", "details": [{ "code": "InvalidChange", "message": "The job is about to complete. It is saving the data. Cancellation is not allowed during this period.", "target": "" }] } }
Response 429 Too many requests
This response indicates that the client sent more requests than allowed by this API for the current tier of the client.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Job
Job information.
Unique id of the job.
Name of the job.
Identifier of the user that created the job.
iTwin Id for the job.
List of inputs, outputs and options for the job, must be in sync with the type.
{ "type": "object", "title": "Job", "required": [ "iTwinId", "specifications", "type", "executionInfo", "id", "state", "userId" ], "properties": { "id": { "type": "string", "description": "Unique id of the job." }, "name": { "type": "string", "default": null, "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$", "nullable": true, "maxLength": 256, "minLength": 3, "description": "Name of the job." }, "type": { "$ref": "#/components/schemas/JobTypes" }, "state": { "$ref": "#/components/schemas/JobState" }, "userId": { "type": "string", "description": "Identifier of the user that created the job." }, "iTwinId": { "type": "string", "description": "iTwin Id for the job." }, "executionInfo": { "$ref": "#/components/schemas/ExecutionInformation" }, "specifications": { "anyOf": [ { "$ref": "#/components/schemas/Objects2DSpecifications" }, { "$ref": "#/components/schemas/Segmentation2DSpecifications" }, { "$ref": "#/components/schemas/Segmentation3DSpecifications" }, { "$ref": "#/components/schemas/SegmentationOrthophotoSpecifications" }, { "$ref": "#/components/schemas/ChangeDetectionSpecifications" }, { "$ref": "#/components/schemas/EvalO2DSpecifications" }, { "$ref": "#/components/schemas/EvalO3DSpecifications" }, { "$ref": "#/components/schemas/EvalS2DSpecifications" }, { "$ref": "#/components/schemas/EvalS3DSpecifications" }, { "$ref": "#/components/schemas/EvalSOrthoSpecifications" }, { "$ref": "#/components/schemas/ClearanceSpecifications" } ], "description": "List of inputs, outputs and options for the job, must be in sync with the type." } }, "description": "Job information.", "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
The target of the error.
A human-readable representation of the error.
{ "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "target": { "type": "string", "nullable": true, "description": "The target of the error." }, "message": { "type": "string", "description": "A human-readable representation of the error." } }, "description": "Contains error information.", "additionalProperties": true }
Job State
Job current state.
{ "enum": [ "Queued", "Active", "TerminatingOnCancel", "TerminatingOnFailure", "Cancelled", "Failed", "Success" ], "type": "string", "title": "Job State", "description": "Job current state." }
Job type
Supported job types
{ "enum": [ "Objects2D", "Segmentation2D", "Segmentation3D", "SegmentationOrthophoto", "ChangeDetection", "EvalO2D", "EvalO3D", "EvalS2D", "EvalS3D", "EvalSOrtho", "ClearanceCalculation" ], "title": "Job type", "description": "Supported job types" }
Job Response
{ "type": "object", "title": "Job Response", "required": [ "job" ], "properties": { "job": { "$ref": "#/components/schemas/Job" } }, "additionalProperties": false }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "required": [ "error" ], "properties": { "error": { "$ref": "#/components/schemas/Error", "description": "Error information." } }, "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "additionalProperties": false }
Eval Objects 2D Inputs
Following are the different inputs for the job.
Reality data id of ContextScene annotated with embedded 2D object references.
Reality data id of ContextScene annotated with embedded 2D object predictions.
{ "type": "object", "title": "Eval Objects 2D Inputs", "required": [ "prediction", "reference" ], "properties": { "reference": { "type": "string", "description": "Reality data id of ContextScene annotated with embedded 2D object references." }, "prediction": { "type": "string", "description": "Reality data id of ContextScene annotated with embedded 2D object predictions." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Eval Objects 3D Inputs
Following are the different inputs for the job.
Reality data id of ContextScene annotated with embedded 3D object references.
Reality data id of ContextScene annotated with embedded 3D object predictions.
{ "type": "object", "title": "Eval Objects 3D Inputs", "required": [ "prediction", "reference" ], "properties": { "reference": { "type": "string", "description": "Reality data id of ContextScene annotated with embedded 3D object references." }, "prediction": { "type": "string", "description": "Reality data id of ContextScene annotated with embedded 3D object predictions." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Eval Segmentation 2D Inputs
Following are the different inputs for the job.
Reality data id of ContextScene, pointing to segmented photos reference.
Reality data id of ContextScene pointing to segmented photos prediction.
{ "type": "object", "title": "Eval Segmentation 2D Inputs", "required": [ "prediction", "reference" ], "properties": { "reference": { "type": "string", "description": "Reality data id of ContextScene, pointing to segmented photos reference." }, "prediction": { "type": "string", "description": "Reality data id of ContextScene pointing to segmented photos prediction." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Eval Segmentation 3D Inputs
Following are the different inputs for the job.
Reality data id of ContextScene, pointing to segmented point cloud reference.
Reality data id of ContextScene pointing to segmented point cloud prediction.
{ "type": "object", "title": "Eval Segmentation 3D Inputs", "required": [ "prediction", "reference" ], "properties": { "reference": { "type": "string", "description": "Reality data id of ContextScene, pointing to segmented point cloud reference." }, "prediction": { "type": "string", "description": "Reality data id of ContextScene pointing to segmented point cloud prediction." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Eval Objects 2D Options
Options for Eval Objects 2D job.
Intersection over union threshold.
{ "type": "object", "title": "Eval Objects 2D Options", "properties": { "thresholdIOU": { "type": "number", "default": null, "nullable": true, "description": "Intersection over union threshold." } }, "description": "Options for Eval Objects 2D job.", "additionalProperties": false }
Eval Objects 2D Outputs
Following are the different output types for the job.
Path in Bucket of json report with binary classification.
Reality data id of ContextScene annotated with classified embedded 2D objects.
{ "type": "object", "title": "Eval Objects 2D Outputs", "properties": { "report": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in Bucket of json report with binary classification." }, "objects2d": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with classified embedded 2D objects." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
Eval Objects 3D Options
Options for Eval Objects 3D job.
Intersection over union threshold.
{ "type": "object", "title": "Eval Objects 3D Options", "properties": { "thresholdIOU": { "type": "number", "default": null, "nullable": true, "description": "Intersection over union threshold." } }, "description": "Options for Eval Objects 3D job.", "additionalProperties": false }
Eval Objects 3D Outputs
Following are the different output types for the job.
Path in Bucket of json report with binary classification.
Reality data id of ContextScene annotated with classified embedded 3D objects.
{ "type": "object", "title": "Eval Objects 3D Outputs", "properties": { "report": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in Bucket of json report with binary classification." }, "objects3d": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with classified embedded 3D objects." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
Eval Segmentation 2D Outputs
Following are the different output types for the job.
Path in Bucket of json report with confusion matrix.
Reality data id of ContextScene, pointing to segmented photos.
Reality data id of segmented photos, annotated with confusion matrix index.
{ "type": "object", "title": "Eval Segmentation 2D Outputs", "properties": { "report": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in Bucket of json report with confusion matrix." }, "segmentation2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene, pointing to segmented photos." }, "segmentedPhotos": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of segmented photos, annotated with confusion matrix index." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
Eval Segmentation 3D Outputs
Following are the different output types for the job.
Path in Bucket of json report with confusion matrix.
Reality data id of ContextScene pointing to segmented point cloud.
Reality data id of segmented point cloud annotated with confusion matrix index.
{ "type": "object", "title": "Eval Segmentation 3D Outputs", "properties": { "report": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in Bucket of json report with confusion matrix." }, "segmentation3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to segmented point cloud." }, "segmentedPointCloud": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of segmented point cloud annotated with confusion matrix index." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
Clearance Calculation Inputs
Following are the different inputs for the job.
Reality data id of a point cloud.
Reality data id of building footprints.
{ "type": "object", "title": "Clearance Calculation Inputs", "required": [ "clearanceFootprint", "model3D" ], "properties": { "model3D": { "type": "string", "description": "Reality data id of a point cloud." }, "clearanceFootprint": { "type": "string", "description": "Reality data id of building footprints." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Objects2D Inputs
Following are the different inputs for the job.
Reality data id of ContextScene pointing to the photos to process.
Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.
Reality data id of ContextScene annotated with embedded 2D objects. This input replaces the photoObjectDetector input.
Reality data id of photo object detector or photo object detector identifier from the Detector Library.
{ "type": "object", "title": "Objects2D Inputs", "required": [ "photos" ], "properties": { "photos": { "type": "string", "description": "Reality data id of ContextScene pointing to the photos to process." }, "model3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh." }, "objects2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 2D objects. This input replaces the `photoObjectDetector` input." }, "photoObjectDetector": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of photo object detector or photo object detector identifier from the Detector Library." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Clearance Calculation Outputs
Following are the different output types.
Reality data id of OVF Clearance Areas.
Reality data id of OVF Clearance Lines.
Reality data id of OVF Clearance Points.
{ "type": "object", "title": "Clearance Calculation Outputs", "properties": { "ovfAreas": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of OVF Clearance Areas." }, "ovfLines": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of OVF Clearance Lines." }, "ovfPoints": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of OVF Clearance Points." } }, "description": "Following are the different output types.", "additionalProperties": false }
Eval Segmentation Orthophoto Inputs
Following are the different inputs for the job.
Reality data id of ContextScene pointing to segmented photos reference.
Reality data id of ContextScene pointing to segmented photos prediction.
{ "type": "object", "title": "Eval Segmentation Orthophoto Inputs", "required": [ "prediction", "reference" ], "properties": { "reference": { "type": "string", "description": "Reality data id of ContextScene pointing to segmented photos reference." }, "prediction": { "type": "string", "description": "Reality data id of ContextScene pointing to segmented photos prediction." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Objects2D Options
Options for Objects2D job.
CRS used by locations3DAsSHP outputs.
Maximum distance between photos and 3D objects.
Minimum number of 2D objects to generate a 3D object.
Improve detection using tie points in oriented photos.
{ "type": "object", "title": "Objects2D Options", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "CRS used by `locations3DAsSHP` outputs." }, "maxDist": { "type": "number", "default": null, "nullable": true, "description": "Maximum distance between photos and 3D objects." }, "minPhotos": { "type": "integer", "default": null, "nullable": true, "description": "Minimum number of 2D objects to generate a 3D object." }, "useTiePoints": { "type": "boolean", "default": null, "nullable": true, "description": "Improve detection using tie points in oriented photos." } }, "description": "Options for Objects2D job.", "additionalProperties": false }
Objects2D Outputs
Following are the different output types for the job.
Reality data id of ContextScene, annotated with embedded 2D objects.
Reality data id of ContextScene, annotated with embedded 3D objects.
Reality data id of 3D objects locations as SHP file, objects3d output must be defined.
Reality data id of 3D objects as 3D Tiles file, objects3d output must be defined.
Reality data id of 3D objects as GeoJSON file, objects3d output must be defined.
Reality data id of 3D objects locations as GeoJSON file, objects3d output must be defined.
{ "type": "object", "title": "Objects2D Outputs", "properties": { "objects2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene, annotated with embedded 2D objects." }, "objects3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene, annotated with embedded 3D objects." }, "locations3DAsSHP": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects locations as SHP file, `objects3d` output must be defined." }, "objects3DAs3DTiles": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects as 3D Tiles file, `objects3d` output must be defined." }, "objects3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects as GeoJSON file, `objects3d` output must be defined." }, "locations3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects locations as GeoJSON file, `objects3d` output must be defined." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
Eval Segmentation Orthophoto Outputs
Following are the different output types.
Path in Bucket of json report with confusion matrix.
Reality data id of ContextScene pointing to segmented photos.
Reality data id of segmented photos annotated with confusion matrix index.
{ "type": "object", "title": "Eval Segmentation Orthophoto Outputs", "properties": { "report": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in Bucket of json report with confusion matrix." }, "segmentation2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to segmented photos." }, "segmentedPhotos": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of segmented photos annotated with confusion matrix index." } }, "description": "Following are the different output types.", "additionalProperties": false }
Execution Information
Execution information of a job.
End time of the job.
Creation time of the job.
The number of processing units consumed by the job.
Start time of the job.
{ "type": "object", "title": "Execution Information", "required": [ "createdDateTime" ], "properties": { "endedDateTime": { "type": "string", "format": "date-time", "default": null, "nullable": true, "description": "End time of the job." }, "createdDateTime": { "type": "string", "format": "date-time", "description": "Creation time of the job." }, "processingUnits": { "type": "number", "default": null, "nullable": true, "description": "The number of processing units consumed by the job." }, "startedDateTime": { "type": "string", "format": "date-time", "default": null, "nullable": true, "description": "Start time of the job." } }, "description": "Execution information of a job.", "additionalProperties": false }
Segmentation2D Inputs
Following are the different inputs for the job.
Reality data id of the ContextScene pointing to the photos to process.
Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.
Reality data id of ContextScene pointing to segmented photos. This input replaces photoSegmentationDetector input.
Either reality data id of photo segmentation detector or photo segmentation detector identifier from the Detectors Library.
{ "type": "object", "title": "Segmentation2D Inputs", "required": [ "photos" ], "properties": { "photos": { "type": "string", "description": "Reality data id of the ContextScene pointing to the photos to process." }, "model3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh." }, "segmentation2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to segmented photos. This input replaces `photoSegmentationDetector` input." }, "photoSegmentationDetector": { "type": "string", "default": null, "nullable": true, "description": "Either reality data id of photo segmentation detector or photo segmentation detector identifier from the Detectors Library." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Segmentation3D Inputs
Following are the different inputs for the job.
Path in the bucket of the clipping polygon to apply.
Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.
Reality data id of ContextScene pointing to a segmented point cloud, this input replaces pointCloudSegmentationDetector and model3D inputs.
Either reality data id of point cloud segmentation detector or point cloud segmentation detector identifier from the Detectors Library.
{ "type": "object", "title": "Segmentation3D Inputs", "properties": { "extent": { "type": "string", "default": null, "pattern": "^bkt:.+", "nullable": true, "description": "Path in the bucket of the clipping polygon to apply." }, "model3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh." }, "segmentation3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to a segmented point cloud, this input replaces `pointCloudSegmentationDetector` and `model3D` inputs." }, "pointCloudSegmentationDetector": { "type": "string", "default": null, "nullable": true, "description": "Either reality data id of point cloud segmentation detector or point cloud segmentation detector identifier from the Detectors Library." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
ChangeDetection Inputs
Following are the different inputs for the job.
Reality data id of ContextScene, point cloud or mesh.
Reality data id of ContextScene, point cloud or mesh.
{ "type": "object", "title": "ChangeDetection Inputs", "required": [ "model3dA", "model3dB" ], "properties": { "model3dA": { "type": "string", "description": "Reality data id of ContextScene, point cloud or mesh." }, "model3dB": { "type": "string", "description": "Reality data id of ContextScene, point cloud or mesh." } }, "description": "Following are the different inputs for the job.", "additionalProperties": false }
Eval Objects 2D Specifications
Specifications for Eval Objects 2D job.
{ "type": "object", "title": "Eval Objects 2D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/EvalO2DInputs" }, "options": { "$ref": "#/components/schemas/EvalO2DOptions" }, "outputs": { "$ref": "#/components/schemas/EvalO2DOutputs" } }, "description": "Specifications for Eval Objects 2D job.", "additionalProperties": false }
Eval Objects 3D Specifications
Specifications for Eval Objects 3D job.
{ "type": "object", "title": "Eval Objects 3D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/EvalO3DInputs" }, "options": { "$ref": "#/components/schemas/EvalO3DOptions" }, "outputs": { "$ref": "#/components/schemas/EvalO3DOutputs" } }, "description": "Specifications for Eval Objects 3D job.", "additionalProperties": false }
Eval Segmentation 2D Specifications
Specifications for Eval Segmentation 2D job.
{ "type": "object", "title": "Eval Segmentation 2D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/EvalS2DInputs" }, "outputs": { "$ref": "#/components/schemas/EvalS2DOutputs" } }, "description": "Specifications for Eval Segmentation 2D job.", "additionalProperties": false }
Eval Segmentation 3D Specifications
Specifications for Eval Segmentation 3D job.
{ "type": "object", "title": "Eval Segmentation 3D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/EvalS3DInputs" }, "outputs": { "$ref": "#/components/schemas/EvalS3DOutputs" } }, "description": "Specifications for Eval Segmentation 3D job.", "additionalProperties": false }
Segmentation2D Options
Options for Segmentation2D job.
Minimum number of 2D detection to generate a 3D detection.
Estimation 3D line width at each vertex.
Remove 3D lines with total length smaller than this value.
{ "type": "object", "title": "Segmentation2D Options", "properties": { "minPhotos": { "type": "integer", "default": null, "nullable": true, "description": "Minimum number of 2D detection to generate a 3D detection." }, "computeLineWidth": { "type": "boolean", "default": null, "nullable": true, "description": "Estimation 3D line width at each vertex." }, "removeSmallLines": { "type": "number", "default": null, "nullable": true, "description": "Remove 3D lines with total length smaller than this value." } }, "description": "Options for Segmentation2D job.", "additionalProperties": false }
Segmentation2D Outputs
Following are the different output types.
Reality data id of ContextScene, annotated with embedded 3D lines.
Reality data id of ContextScene annotated with embedded 3D polygons.
Reality data id of ContextScene pointing to segmented photos.
Reality data id of segmented photos.
Reality data id of 3D lines as 3D Tiles file, lines3d output must be defined.
Reality data id of 3D lines as GeoJSON file, lines3d output must be defined.
Reality data id of 3D polygons as 3D Tiles file, polygons3d output must be defined.
Reality data id of 3D polygons as GeoJSON file, polygons3d output must be defined.
{ "type": "object", "title": "Segmentation2D Outputs", "properties": { "lines3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene, annotated with embedded 3D lines." }, "polygons3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 3D polygons." }, "segmentation2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to segmented photos." }, "segmentedPhotos": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of segmented photos." }, "lines3DAs3DTiles": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D lines as 3D Tiles file, `lines3d` output must be defined." }, "lines3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D lines as GeoJSON file, `lines3d` output must be defined." }, "polygons3DAs3DTiles": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D polygons as 3D Tiles file, `polygons3d` output must be defined." }, "polygons3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D polygons as GeoJSON file, `polygons3d` output must be defined." } }, "description": "Following are the different output types.", "additionalProperties": false }
Segmentation3D Options
Options for Segmentation3D job.
CRS used by POD, LAS, LAZ, PLY and SHP outputs.
Save confidence in 3D segmentation.
Estimation 3D line width at each vertex.
To make segmentation 3D output exact same point input.
Remove 3D lines with total length smaller than this value.
{ "type": "object", "title": "Segmentation3D Options", "properties": { "crs": { "type": "string", "default": null, "nullable": true, "description": "CRS used by POD, LAS, LAZ, PLY and SHP outputs." }, "saveConfidence": { "type": "boolean", "default": null, "nullable": true, "description": "Save confidence in 3D segmentation." }, "computeLineWidth": { "type": "boolean", "default": null, "nullable": true, "description": "Estimation 3D line width at each vertex." }, "keepInputResolution": { "type": "boolean", "default": null, "nullable": true, "description": "To make segmentation 3D output exact same point input." }, "removeSmallComponents": { "type": "number", "default": null, "nullable": true, "description": "Remove 3D lines with total length smaller than this value." } }, "description": "Options for Segmentation3D job.", "additionalProperties": false }
Segmentation3D Outputs
Following are the different output types for the job.
Reality data id of ContextScene annotated with embedded 3D lines.
Reality data id of ContextScene annotated with embedded 3D objects.
Reality data id of ContextScene annotated with embedded 3D polygons.
Reality data id of ContextScene pointing to the segmented point cloud.
Reality data id of 3D lines as 3D Tiles file, lines3d output must be defined.
Reality data id of 3D lines as GeoJSON file, lines3d output must be defined.
Reality data id of 3D objects locations as SHP file, objects3d output must be defined.
Reality data id of 3D objects as 3D Tiles file, objects3d output must be defined.
Reality data id of 3D objects as GeoJSON file, objects3d output must be defined.
Reality data id of 3D polygons as 3D Tiles file, polygons3d output must be defined.
Reality data id of 3D polygons as GeoJSON file, polygons3d output must be defined.
Reality data id of the segmented point cloud as LAS file, segmentation3D output must be defined.
Reality data id of the segmented point cloud as LAZ file, segmentation3D output must be defined.
Reality data id of the segmented point cloud as PLY file, segmentation3D output must be defined.
Reality data id of the segmented point cloud as POD file, segmentation3D output must be defined.
Reality data id of the 3D segmentation as OPC file.
Reality data id of 3D objects locations as GeoJSON file, objects3d output must be defined.
{ "type": "object", "title": "Segmentation3D Outputs", "properties": { "lines3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 3D lines." }, "objects3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 3D objects." }, "polygons3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 3D polygons." }, "segmentation3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene pointing to the segmented point cloud." }, "lines3DAs3DTiles": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D lines as 3D Tiles file, `lines3d` output must be defined." }, "lines3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D lines as GeoJSON file, `lines3d` output must be defined." }, "locations3DAsSHP": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects locations as SHP file, `objects3d` output must be defined." }, "objects3DAs3DTiles": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects as 3D Tiles file, `objects3d` output must be defined." }, "objects3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects as GeoJSON file, `objects3d` output must be defined." }, "polygons3DAs3DTiles": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D polygons as 3D Tiles file, `polygons3d` output must be defined." }, "polygons3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D polygons as GeoJSON file, `polygons3d` output must be defined." }, "segmentation3DAsLAS": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of the segmented point cloud as LAS file, `segmentation3D` output must be defined." }, "segmentation3DAsLAZ": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of the segmented point cloud as LAZ file, `segmentation3D` output must be defined." }, "segmentation3DAsPLY": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of the segmented point cloud as PLY file, `segmentation3D` output must be defined." }, "segmentation3DAsPOD": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of the segmented point cloud as POD file, `segmentation3D` output must be defined." }, "segmentedPointCloud": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of the 3D segmentation as OPC file." }, "locations3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects locations as GeoJSON file, `objects3d` output must be defined." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
ChangeDetection Options
Options for ChangeDetection job.
CRS used by locations3DAsSHP output.
High threshold to detect spatial changes (hysteresis detection).
Low threshold to detect spatial changes (hysteresis detection).
Minimum number of points in a region to be considered as a change.
Target point cloud resolution when starting from meshes.
{ "type": "object", "title": "ChangeDetection Options", "properties": { "outputCrs": { "type": "string", "default": null, "nullable": true, "description": "CRS used by `locations3DAsSHP` output." }, "threshold": { "type": "number", "default": null, "nullable": true, "description": "High threshold to detect spatial changes (hysteresis detection)." }, "filterThreshold": { "type": "number", "default": null, "nullable": true, "description": "Low threshold to detect spatial changes (hysteresis detection)." }, "minPointsPerChange": { "type": "integer", "default": null, "nullable": true, "description": "Minimum number of points in a region to be considered as a change." }, "meshSamplingResolution": { "type": "number", "default": null, "nullable": true, "description": "Target point cloud resolution when starting from meshes." } }, "description": "Options for ChangeDetection job.", "additionalProperties": false }
ChangeDetection Outputs
Following are the different output types for the job.
Reality data id of ContextScene annotated with embedded 3D objects.
Points in A not in B as OPC.
Points in B not in A as OPC.
Reality data id of 3D objects locations as SHP format.
Reality data id of 3D objects locations as GeoJSON file.
{ "type": "object", "title": "ChangeDetection Outputs", "properties": { "objects3D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 3D objects." }, "changesInModelA": { "type": "string", "default": null, "nullable": true, "description": "Points in A not in B as OPC." }, "changesInModelB": { "type": "string", "default": null, "nullable": true, "description": "Points in B not in A as OPC." }, "locations3DAsSHP": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects locations as SHP format." }, "locations3DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 3D objects locations as GeoJSON file." } }, "description": "Following are the different output types for the job.", "additionalProperties": false }
Clearance Calculation Specifications
Specifications for Clearance Calculation job.
{ "type": "object", "title": "Clearance Calculation Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/ClearanceInputs" }, "outputs": { "$ref": "#/components/schemas/ClearanceOutputs" } }, "description": "Specifications for Clearance Calculation job.", "additionalProperties": false }
Objects2D Specifications
Specifications for Objects2D job.
{ "type": "object", "title": "Objects2D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/Objects2DInputs" }, "options": { "$ref": "#/components/schemas/Objects2DOptions" }, "outputs": { "$ref": "#/components/schemas/Objects2DOutputs" } }, "description": "Specifications for Objects2D job.", "additionalProperties": false }
Eval Segmentation Orthophoto Specifications
Specifications for Eval Segmentation Orthophoto job.
{ "type": "object", "title": "Eval Segmentation Orthophoto Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/EvalSOrthoInputs" }, "outputs": { "$ref": "#/components/schemas/EvalSOrthoOutputs" } }, "description": "Specifications for Eval Segmentation Orthophoto job.", "additionalProperties": false }
Segmentation2D Specifications
Specifications for Segmentation2D job.
{ "type": "object", "title": "Segmentation2D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/Segmentation2DInputs" }, "options": { "$ref": "#/components/schemas/Segmentation2DOptions" }, "outputs": { "$ref": "#/components/schemas/Segmentation2DOutputs" } }, "description": "Specifications for Segmentation2D job.", "additionalProperties": false }
Segmentation3D Specifications
Specifications for Segmentation3D job.
{ "type": "object", "title": "Segmentation3D Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/Segmentation3DInputs" }, "options": { "$ref": "#/components/schemas/Segmentation3DOptions" }, "outputs": { "$ref": "#/components/schemas/Segmentation3DOutputs" } }, "description": "Specifications for Segmentation3D job.", "additionalProperties": false }
SegmentationOrthophoto Inputs
Following are the different inputs for job.
Reality data id of ContextScene pointing to orthophotos to process.
Either reality data id of orthophoto segmentation detector or orthophoto segmentation detector identifier from the Detectors Library.
{ "type": "object", "title": "SegmentationOrthophoto Inputs", "required": [ "orthophoto", "orthophotoSegmentationDetector" ], "properties": { "orthophoto": { "type": "string", "description": "Reality data id of ContextScene pointing to orthophotos to process." }, "orthophotoSegmentationDetector": { "type": "string", "description": "Either reality data id of orthophoto segmentation detector or orthophoto segmentation detector identifier from the Detectors Library." } }, "description": "Following are the different inputs for job.", "additionalProperties": false }
ChangeDetection Specifications
Specifications for ChangeDetection job.
{ "type": "object", "title": "ChangeDetection Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/ChangeDetectionInputs" }, "options": { "$ref": "#/components/schemas/ChangeDetectionOptions" }, "outputs": { "$ref": "#/components/schemas/ChangeDetectionOutputs" } }, "description": "Specifications for ChangeDetection job.", "additionalProperties": false }
SegmentationOrthophoto Outputs
Following are the different output types.
Reality data id of ContextScene annotated with embedded 2D lines.
Reality data id of ContextScene annotated with embedded 2D polygons.
Reality data id of 2D lines as SHP file, lines2d output must be defined.
Reality data id of ContextScene, pointing to segmented orthophotos.
Reality data id of 2D polygons as SHP file, polygons2d output must be defined.
Reality data id of segmented orthophotos.
Reality data id of 2D lines as GeoJSON file, lines2d output must be defined.
Reality data id of 2D polygons as GeoJSON file, polygons2d output must be defined.
{ "type": "object", "title": "SegmentationOrthophoto Outputs", "properties": { "lines2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 2D lines." }, "polygons2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene annotated with embedded 2D polygons." }, "lines2DAsSHP": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 2D lines as SHP file, `lines2d` output must be defined." }, "segmentation2D": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of ContextScene, pointing to segmented orthophotos." }, "polygons2DAsSHP": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 2D polygons as SHP file, `polygons2d` output must be defined." }, "segmentedPhotos": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of segmented orthophotos." }, "lines2DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 2D lines as GeoJSON file, `lines2d` output must be defined." }, "polygons2DAsGeoJSON": { "type": "string", "default": null, "nullable": true, "description": "Reality data id of 2D polygons as GeoJSON file, `polygons2d` output must be defined." } }, "description": "Following are the different output types.", "additionalProperties": false }
SegmentationOrthophoto Specifications
Specifications for SegmentationOrthophoto job.
{ "type": "object", "title": "SegmentationOrthophoto Specifications", "required": [ "inputs", "outputs" ], "properties": { "inputs": { "$ref": "#/components/schemas/SegmentationOrthophotoInputs" }, "outputs": { "$ref": "#/components/schemas/SegmentationOrthophotoOutputs" } }, "description": "Specifications for SegmentationOrthophoto job.", "additionalProperties": false }
Was this page helpful?