Create job - Reality Analysis

Reality Analysis

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Create job

POST https://qa-api.bentley.com/reality-analysis/jobs

Create a new 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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Job Creation

specifications

Any of: Objects2DSpecificationsCreate Segmentation2DSpecificationsCreate Segmentation3DSpecificationsCreate SegmentationOrthophotoSpecificationsCreate ChangeDetectionSpecificationsCreate EvalO2DSpecificationsCreate EvalO3DSpecificationsCreate EvalS2DSpecificationsCreate EvalS3DSpecificationsCreate EvalSOrthoSpecificationsCreate ClearanceSpecificationsCreate

Yes

List of inputs, outputs and options for the job, must be in sync with type.

name

String, null

Name of the job.

type

JobTypes

Yes

iTwinId

String

Yes

iTwin Id for the job.

Example

json

{
    "specifications": {
        "inputs": {
            "photos": "df091f39-377c-48fb-a9c9-9fd0998e151a",
            "photoObjectDetector": "9a125f8a-da72-41d8-8482-2f7b179d732e"
        },
        "outputs": ["Objects2D"],
        "options": {
            "maxDist": 2,
            "useTiePoints": true
        }
    },
    "name": "My first Objects2D job",
    "type": "Objects2D",
    "iTwinId": "019b18b4-e4c1-4211-b8bb-1bd26b8e955e"
}

Response 201 Created

Created

json

{
    "job": {
        "id": "86e93558-7dbd-40da-8604-245ed345c57a",
        "state": "Active",
        "userId": "654e3c44-9a1a-4c72-8f8c-e1245bfcebf3",
        "executionInfo": {
            "createdDateTime": "2025-08-04T01:57:24Z"
        },
        "specifications": {
            "inputs": {
                "photos": "df091f39-377c-48fb-a9c9-9fd0998e151a",
                "photoObjectDetector": "9a125f8a-da72-41d8-8482-2f7b179d732e"
            },
            "outputs": {
                "objects2D": "407f2733-75cf-4aa3-bd3d-3cb85221ac43"
            },
            "options": {
                "useTiePoints": true,
                "maxDist": 2
            }
        },
        "name": "My first Objects2D job",
        "type": "Objects2D",
        "iTwinId": "019b18b4-e4c1-4211-b8bb-1bd26b8e955e"
    }
}

Response 400 Bad Request

The 400 (Bad Request) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

{
    "error": {
        "code": "InvalidRealityAnalysisRequest",
        "message": "Invalid request to Reality Analysis.",
        "details": [{
            "code": "InvalidProperty",
            "message": "Invalid value 'Objects2D1' for property 'type', line 15, position 34.",
            "target": "type"
        }]
    }
}

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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the requested operation or resource could not be found.

json

{
    "error": {
        "code": "ResourceNotFound",
        "message": "The requested resource was not found. Verify the API URL and the Accept header.",
        "details": [{
            "code": "OperationNotFound",
            "message": "Unable to match incoming request to an operation."
        }]
    }
}

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.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "description": "Contains error information."
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

json

{
    "required": [
        "code",
        "message",
        "details"
    ],
    "type": "object",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        }
    },
    "description": "Contains error information and an array of more specific errors."
}

Detailed 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.

error

DetailedError

json

{
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "additionalProperties": false,
    "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."
}

Error Response

error

Error

json

{
    "title": "Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error"
        }
    },
    "additionalProperties": false,
    "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."
}

Job State

Job current state.

Queued

String

Active

String

TerminatingOnCancel

String

TerminatingOnFailure

String

Cancelled

String

Failed

String

Success

String

json

{
    "title": "Job State",
    "enum": [
        "Queued",
        "Active",
        "TerminatingOnCancel",
        "TerminatingOnFailure",
        "Cancelled",
        "Failed",
        "Success"
    ],
    "type": "string",
    "description": "Job current state."
}

Execution Information

Execution information of a job.

createdDateTime

Date-time

Creation time of the job.

startedDateTime

Date-time, null

Start time of the job.

endedDateTime

Date-time, null

End time of the job.

processingUnits

Number, null

The number of processing units consumed by the job.

json

{
    "title": "Execution Information",
    "required": [
        "createdDateTime"
    ],
    "type": "object",
    "properties": {
        "createdDateTime": {
            "type": "string",
            "description": "Creation time of the job.",
            "format": "date-time"
        },
        "startedDateTime": {
            "type": "string",
            "description": "Start time of the job.",
            "format": "date-time",
            "default": null,
            "nullable": true
        },
        "endedDateTime": {
            "type": "string",
            "description": "End time of the job.",
            "format": "date-time",
            "default": null,
            "nullable": true
        },
        "processingUnits": {
            "type": "number",
            "description": "The number of processing units consumed by the job.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Execution information of a job."
}

Objects2D Inputs

Following are the different inputs for the job.

model3D

String, null

Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.

objects2D

String, null

Reality data id of ContextScene annotated with embedded 2D objects. This input replaces the photoObjectDetector input.

photoObjectDetector

String, null

Reality data id of photo object detector or photo object detector identifier from the Detector Library.

photos

String

Reality data id of ContextScene pointing to the photos to process.

json

{
    "title": "Objects2D Inputs",
    "required": [
        "photos"
    ],
    "type": "object",
    "properties": {
        "model3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.",
            "default": null,
            "nullable": true
        },
        "objects2D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D objects. This input replaces the `photoObjectDetector` input.",
            "default": null,
            "nullable": true
        },
        "photoObjectDetector": {
            "type": "string",
            "description": "Reality data id of photo object detector or photo object detector identifier from the Detector Library.",
            "default": null,
            "nullable": true
        },
        "photos": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to the photos to process."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Objects2D Outputs

Following are the different output types for the job.

locations3DAsGeoJSON

String, null

Reality data id of 3D objects locations as GeoJSON file, objects3d output must be defined.

locations3DAsSHP

String, null

Reality data id of 3D objects locations as SHP file, objects3d output must be defined.

objects2D

String, null

Reality data id of ContextScene, annotated with embedded 2D objects.

objects3D

String, null

Reality data id of ContextScene, annotated with embedded 3D objects.

objects3DAs3DTiles

String, null

Reality data id of 3D objects as 3D Tiles file, objects3d output must be defined.

objects3DAsGeoJSON

String, null

Reality data id of 3D objects as GeoJSON file, objects3d output must be defined.

json

{
    "title": "Objects2D Outputs",
    "type": "object",
    "properties": {
        "locations3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D objects locations as GeoJSON file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "locations3DAsSHP": {
            "type": "string",
            "description": "Reality data id of 3D objects locations as SHP file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "objects2D": {
            "type": "string",
            "description": "Reality data id of ContextScene, annotated with embedded 2D objects.",
            "default": null,
            "nullable": true
        },
        "objects3D": {
            "type": "string",
            "description": "Reality data id of ContextScene, annotated with embedded 3D objects.",
            "default": null,
            "nullable": true
        },
        "objects3DAs3DTiles": {
            "type": "string",
            "description": "Reality data id of 3D objects as 3D Tiles file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "objects3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D objects as GeoJSON file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

Objects2D Options

Options for Objects2D job.

crs

String, null

CRS used by locations3DAsSHP outputs.

maxDist

Number, null

Maximum distance between photos and 3D objects.

minPhotos

Integer, null

Minimum number of 2D objects to generate a 3D object.

useTiePoints

Boolean, null

Improve detection using tie points in oriented photos.

json

{
    "title": "Objects2D Options",
    "type": "object",
    "properties": {
        "crs": {
            "type": "string",
            "description": "CRS used by `locations3DAsSHP` outputs.",
            "default": null,
            "nullable": true
        },
        "maxDist": {
            "type": "number",
            "description": "Maximum distance between photos and 3D objects.",
            "default": null,
            "nullable": true
        },
        "minPhotos": {
            "type": "integer",
            "description": "Minimum number of 2D objects to generate a 3D object.",
            "default": null,
            "nullable": true
        },
        "useTiePoints": {
            "type": "boolean",
            "description": "Improve detection using tie points in oriented photos.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Options for Objects2D job."
}

Objects2D Specifications

Specifications for Objects2D job.

inputs

Objects2DInputs

outputs

Objects2DOutputs

options

Objects2DOptions

json

{
    "title": "Objects2D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Objects2DInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/Objects2DOutputs"
        },
        "options": {
            "$ref": "#/components/schemas/Objects2DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Objects2D job."
}

Segmentation2D Inputs

Following are the different inputs for the job.

model3D

String, null

Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.

segmentation2D

String, null

Reality data id of ContextScene pointing to segmented photos. This input replaces photoSegmentationDetector input.

photoSegmentationDetector

String, null

Either reality data id of photo segmentation detector or photo segmentation detector identifier from the Detectors Library.

photos

String

Reality data id of the ContextScene pointing to the photos to process.

json

{
    "title": "Segmentation2D Inputs",
    "required": [
        "photos"
    ],
    "type": "object",
    "properties": {
        "model3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.",
            "default": null,
            "nullable": true
        },
        "segmentation2D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos. This input replaces `photoSegmentationDetector` input.",
            "default": null,
            "nullable": true
        },
        "photoSegmentationDetector": {
            "type": "string",
            "description": "Either reality data id of photo segmentation detector or photo segmentation detector identifier from the Detectors Library.",
            "default": null,
            "nullable": true
        },
        "photos": {
            "type": "string",
            "description": "Reality data id of the ContextScene pointing to the photos to process."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Segmentation2D Outputs

Following are the different output types.

segmentation2D

String, null

Reality data id of ContextScene pointing to segmented photos.

segmentedPhotos

String, null

Reality data id of segmented photos.

lines3D

String, null

Reality data id of ContextScene, annotated with embedded 3D lines.

lines3DAs3DTiles

String, null

Reality data id of 3D lines as 3D Tiles file, lines3d output must be defined.

lines3DAsGeoJSON

String, null

Reality data id of 3D lines as GeoJSON file, lines3d output must be defined.

polygons3D

String, null

Reality data id of ContextScene annotated with embedded 3D polygons.

polygons3DAs3DTiles

String, null

Reality data id of 3D polygons as 3D Tiles file, polygons3d output must be defined.

polygons3DAsGeoJSON

String, null

Reality data id of 3D polygons as GeoJSON file, polygons3d output must be defined.

json

{
    "title": "Segmentation2D Outputs",
    "type": "object",
    "properties": {
        "segmentation2D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos.",
            "default": null,
            "nullable": true
        },
        "segmentedPhotos": {
            "type": "string",
            "description": "Reality data id of segmented photos.",
            "default": null,
            "nullable": true
        },
        "lines3D": {
            "type": "string",
            "description": "Reality data id of ContextScene, annotated with embedded 3D lines.",
            "default": null,
            "nullable": true
        },
        "lines3DAs3DTiles": {
            "type": "string",
            "description": "Reality data id of 3D lines as 3D Tiles file, `lines3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "lines3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D lines as GeoJSON file, `lines3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "polygons3D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D polygons.",
            "default": null,
            "nullable": true
        },
        "polygons3DAs3DTiles": {
            "type": "string",
            "description": "Reality data id of 3D polygons as 3D Tiles file, `polygons3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "polygons3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D polygons as GeoJSON file, `polygons3d` output must be defined.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types."
}

Segmentation2D Options

Options for Segmentation2D job.

computeLineWidth

Boolean, null

Estimation 3D line width at each vertex.

removeSmallLines

Number, null

Remove 3D lines with total length smaller than this value.

minPhotos

Integer, null

Minimum number of 2D detection to generate a 3D detection.

json

{
    "title": "Segmentation2D Options",
    "type": "object",
    "properties": {
        "computeLineWidth": {
            "type": "boolean",
            "description": "Estimation 3D line width at each vertex.",
            "default": null,
            "nullable": true
        },
        "removeSmallLines": {
            "type": "number",
            "description": "Remove 3D lines with total length smaller than this value.",
            "default": null,
            "nullable": true
        },
        "minPhotos": {
            "type": "integer",
            "description": "Minimum number of 2D detection to generate a 3D detection.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Options for Segmentation2D job."
}

Segmentation2D Specifications

Specifications for Segmentation2D job.

inputs

Segmentation2DInputs

outputs

Segmentation2DOutputs

options

Segmentation2DOptions

json

{
    "title": "Segmentation2D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Segmentation2DInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/Segmentation2DOutputs"
        },
        "options": {
            "$ref": "#/components/schemas/Segmentation2DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Segmentation2D job."
}

Segmentation3D Inputs

Following are the different inputs for the job.

extent

String, null

Path in the bucket of the clipping polygon to apply.

model3D

String, null

Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.

pointCloudSegmentationDetector

String, null

Either reality data id of point cloud segmentation detector or point cloud segmentation detector identifier from the Detectors Library.

segmentation3D

String, null

Reality data id of ContextScene pointing to a segmented point cloud, this input replaces pointCloudSegmentationDetector and model3D inputs.

json

{
    "title": "Segmentation3D Inputs",
    "type": "object",
    "properties": {
        "extent": {
            "pattern": "^bkt:.+",
            "type": "string",
            "description": "Path in the bucket of the clipping polygon to apply.",
            "default": null,
            "nullable": true
        },
        "model3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a collection of point clouds/meshes to process, or a point cloud, or a mesh.",
            "default": null,
            "nullable": true
        },
        "pointCloudSegmentationDetector": {
            "type": "string",
            "description": "Either reality data id of point cloud segmentation detector or point cloud segmentation detector identifier from the Detectors Library.",
            "default": null,
            "nullable": true
        },
        "segmentation3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to a segmented point cloud, this input replaces `pointCloudSegmentationDetector` and `model3D` inputs.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Segmentation3D Options

Options for Segmentation3D job.

computeLineWidth

Boolean, null

Estimation 3D line width at each vertex.

crs

String, null

CRS used by POD, LAS, LAZ, PLY and SHP outputs.

keepInputResolution

Boolean, null

To make segmentation 3D output exact same point input.

removeSmallComponents

Number, null

Remove 3D lines with total length smaller than this value.

saveConfidence

Boolean, null

Save confidence in 3D segmentation.

json

{
    "title": "Segmentation3D Options",
    "type": "object",
    "properties": {
        "computeLineWidth": {
            "type": "boolean",
            "description": "Estimation 3D line width at each vertex.",
            "default": null,
            "nullable": true
        },
        "crs": {
            "type": "string",
            "description": "CRS used by POD, LAS, LAZ, PLY and SHP outputs.",
            "default": null,
            "nullable": true
        },
        "keepInputResolution": {
            "type": "boolean",
            "description": "To make segmentation 3D output exact same point input.",
            "default": null,
            "nullable": true
        },
        "removeSmallComponents": {
            "type": "number",
            "description": "Remove 3D lines with total length smaller than this value.",
            "default": null,
            "nullable": true
        },
        "saveConfidence": {
            "type": "boolean",
            "description": "Save confidence in 3D segmentation.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Options for Segmentation3D job."
}

Segmentation3D Outputs

Following are the different output types for the job.

lines3D

String, null

Reality data id of ContextScene annotated with embedded 3D lines.

lines3DAs3DTiles

String, null

Reality data id of 3D lines as 3D Tiles file, lines3d output must be defined.

lines3DAsGeoJSON

String, null

Reality data id of 3D lines as GeoJSON file, lines3d output must be defined.

locations3DAsGeoJSON

String, null

Reality data id of 3D objects locations as GeoJSON file, objects3d output must be defined.

locations3DAsSHP

String, null

Reality data id of 3D objects locations as SHP file, objects3d output must be defined.

objects3D

String, null

Reality data id of ContextScene annotated with embedded 3D objects.

objects3DAs3DTiles

String, null

Reality data id of 3D objects as 3D Tiles file, objects3d output must be defined.

objects3DAsGeoJSON

String, null

Reality data id of 3D objects as GeoJSON file, objects3d output must be defined.

polygons3D

String, null

Reality data id of ContextScene annotated with embedded 3D polygons.

polygons3DAs3DTiles

String, null

Reality data id of 3D polygons as 3D Tiles file, polygons3d output must be defined.

polygons3DAsGeoJSON

String, null

Reality data id of 3D polygons as GeoJSON file, polygons3d output must be defined.

segmentation3D

String, null

Reality data id of ContextScene pointing to the segmented point cloud.

segmentation3DAsLAS

String, null

Reality data id of the segmented point cloud as LAS file, segmentation3D output must be defined.

segmentation3DAsLAZ

String, null

Reality data id of the segmented point cloud as LAZ file, segmentation3D output must be defined.

segmentation3DAsPLY

String, null

Reality data id of the segmented point cloud as PLY file, segmentation3D output must be defined.

segmentation3DAsPOD

String, null

Reality data id of the segmented point cloud as POD file, segmentation3D output must be defined.

segmentedPointCloud

String, null

Reality data id of the 3D segmentation as OPC file.

json

{
    "title": "Segmentation3D Outputs",
    "type": "object",
    "properties": {
        "lines3D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D lines.",
            "default": null,
            "nullable": true
        },
        "lines3DAs3DTiles": {
            "type": "string",
            "description": "Reality data id of 3D lines as 3D Tiles file, `lines3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "lines3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D lines as GeoJSON file, `lines3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "locations3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D objects locations as GeoJSON file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "locations3DAsSHP": {
            "type": "string",
            "description": "Reality data id of 3D objects locations as SHP file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "objects3D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D objects.",
            "default": null,
            "nullable": true
        },
        "objects3DAs3DTiles": {
            "type": "string",
            "description": "Reality data id of 3D objects as 3D Tiles file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "objects3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D objects as GeoJSON file, `objects3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "polygons3D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D polygons.",
            "default": null,
            "nullable": true
        },
        "polygons3DAs3DTiles": {
            "type": "string",
            "description": "Reality data id of 3D polygons as 3D Tiles file, `polygons3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "polygons3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D polygons as GeoJSON file, `polygons3d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "segmentation3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to the segmented point cloud.",
            "default": null,
            "nullable": true
        },
        "segmentation3DAsLAS": {
            "type": "string",
            "description": "Reality data id of the segmented point cloud as LAS file, `segmentation3D` output must be defined.",
            "default": null,
            "nullable": true
        },
        "segmentation3DAsLAZ": {
            "type": "string",
            "description": "Reality data id of the segmented point cloud as LAZ file, `segmentation3D` output must be defined.",
            "default": null,
            "nullable": true
        },
        "segmentation3DAsPLY": {
            "type": "string",
            "description": "Reality data id of the segmented point cloud as PLY file, `segmentation3D` output must be defined.",
            "default": null,
            "nullable": true
        },
        "segmentation3DAsPOD": {
            "type": "string",
            "description": "Reality data id of the segmented point cloud as POD file, `segmentation3D` output must be defined.",
            "default": null,
            "nullable": true
        },
        "segmentedPointCloud": {
            "type": "string",
            "description": "Reality data id of the 3D segmentation as OPC file.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

Segmentation3D Specifications

Specifications for Segmentation3D job.

inputs

Segmentation3DInputs

options

Segmentation3DOptions

outputs

Segmentation3DOutputs

json

{
    "title": "Segmentation3D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Segmentation3DInputs"
        },
        "options": {
            "$ref": "#/components/schemas/Segmentation3DOptions"
        },
        "outputs": {
            "$ref": "#/components/schemas/Segmentation3DOutputs"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Segmentation3D job."
}

SegmentationOrthophoto Inputs

Following are the different inputs for job.

orthophoto

String

Reality data id of ContextScene pointing to orthophotos to process.

orthophotoSegmentationDetector

String

Either reality data id of orthophoto segmentation detector or orthophoto segmentation detector identifier from the Detectors Library.

json

{
    "title": "SegmentationOrthophoto Inputs",
    "required": [
        "orthophoto",
        "orthophotoSegmentationDetector"
    ],
    "type": "object",
    "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."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for job."
}

SegmentationOrthophoto Outputs

Following are the different output types.

segmentation2D

String, null

Reality data id of ContextScene, pointing to segmented orthophotos.

segmentedPhotos

String, null

Reality data id of segmented orthophotos.

polygons2D

String, null

Reality data id of ContextScene annotated with embedded 2D polygons.

polygons2DAsSHP

String, null

Reality data id of 2D polygons as SHP file, polygons2d output must be defined.

polygons2DAsGeoJSON

String, null

Reality data id of 2D polygons as GeoJSON file, polygons2d output must be defined.

lines2D

String, null

Reality data id of ContextScene annotated with embedded 2D lines.

lines2DAsSHP

String, null

Reality data id of 2D lines as SHP file, lines2d output must be defined.

lines2DAsGeoJSON

String, null

Reality data id of 2D lines as GeoJSON file, lines2d output must be defined.

json

{
    "title": "SegmentationOrthophoto Outputs",
    "type": "object",
    "properties": {
        "segmentation2D": {
            "type": "string",
            "description": "Reality data id of ContextScene, pointing to segmented orthophotos.",
            "default": null,
            "nullable": true
        },
        "segmentedPhotos": {
            "type": "string",
            "description": "Reality data id of segmented orthophotos.",
            "default": null,
            "nullable": true
        },
        "polygons2D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D polygons.",
            "default": null,
            "nullable": true
        },
        "polygons2DAsSHP": {
            "type": "string",
            "description": "Reality data id of 2D polygons as SHP file, `polygons2d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "polygons2DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 2D polygons as GeoJSON file, `polygons2d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "lines2D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D lines.",
            "default": null,
            "nullable": true
        },
        "lines2DAsSHP": {
            "type": "string",
            "description": "Reality data id of 2D lines as SHP file, `lines2d` output must be defined.",
            "default": null,
            "nullable": true
        },
        "lines2DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 2D lines as GeoJSON file, `lines2d` output must be defined.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types."
}

SegmentationOrthophoto Specifications

Specifications for SegmentationOrthophoto job.

inputs

SegmentationOrthophotoInputs

outputs

SegmentationOrthophotoOutputs

json

{
    "title": "SegmentationOrthophoto Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/SegmentationOrthophotoInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/SegmentationOrthophotoOutputs"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for SegmentationOrthophoto job."
}

ChangeDetection Inputs

Following are the different inputs for the job.

model3dA

String

Reality data id of ContextScene, point cloud or mesh.

model3dB

String

Reality data id of ContextScene, point cloud or mesh.

json

{
    "title": "ChangeDetection Inputs",
    "required": [
        "model3dA",
        "model3dB"
    ],
    "type": "object",
    "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."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

ChangeDetection Outputs

Following are the different output types for the job.

changesInModelA

String, null

Points in A not in B as OPC.

changesInModelB

String, null

Points in B not in A as OPC.

locations3DAsGeoJSON

String, null

Reality data id of 3D objects locations as GeoJSON file.

locations3DAsSHP

String, null

Reality data id of 3D objects locations as SHP format.

objects3D

String, null

Reality data id of ContextScene annotated with embedded 3D objects.

json

{
    "title": "ChangeDetection Outputs",
    "type": "object",
    "properties": {
        "changesInModelA": {
            "type": "string",
            "description": "Points in A not in B as OPC.",
            "default": null,
            "nullable": true
        },
        "changesInModelB": {
            "type": "string",
            "description": "Points in B not in A as OPC.",
            "default": null,
            "nullable": true
        },
        "locations3DAsGeoJSON": {
            "type": "string",
            "description": "Reality data id of 3D objects locations as GeoJSON file.",
            "default": null,
            "nullable": true
        },
        "locations3DAsSHP": {
            "type": "string",
            "description": "Reality data id of 3D objects locations as SHP format.",
            "default": null,
            "nullable": true
        },
        "objects3D": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D objects.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

ChangeDetection Options

Options for ChangeDetection job.

filterThreshold

Number, null

Low threshold to detect spatial changes (hysteresis detection).

meshSamplingResolution

Number, null

Target point cloud resolution when starting from meshes.

minPointsPerChange

Integer, null

Minimum number of points in a region to be considered as a change.

outputCrs

String, null

CRS used by locations3DAsSHP output.

threshold

Number, null

High threshold to detect spatial changes (hysteresis detection).

json

{
    "title": "ChangeDetection Options",
    "type": "object",
    "properties": {
        "filterThreshold": {
            "type": "number",
            "description": "Low threshold to detect spatial changes (hysteresis detection).",
            "default": null,
            "nullable": true
        },
        "meshSamplingResolution": {
            "type": "number",
            "description": "Target point cloud resolution when starting from meshes.",
            "default": null,
            "nullable": true
        },
        "minPointsPerChange": {
            "type": "integer",
            "description": "Minimum number of points in a region to be considered as a change.",
            "default": null,
            "nullable": true
        },
        "outputCrs": {
            "type": "string",
            "description": "CRS used by `locations3DAsSHP` output.",
            "default": null,
            "nullable": true
        },
        "threshold": {
            "type": "number",
            "description": "High threshold to detect spatial changes (hysteresis detection).",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Options for ChangeDetection job."
}

ChangeDetection Specifications

Specifications for ChangeDetection job.

inputs

ChangeDetectionInputs

outputs

ChangeDetectionOutputs

options

ChangeDetectionOptions

json

{
    "title": "ChangeDetection Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/ChangeDetectionInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/ChangeDetectionOutputs"
        },
        "options": {
            "$ref": "#/components/schemas/ChangeDetectionOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for ChangeDetection job."
}

Eval Objects 2D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene annotated with embedded 2D object predictions.

reference

String

Reality data id of ContextScene annotated with embedded 2D object references.

json

{
    "title": "Eval Objects 2D Inputs",
    "required": [
        "prediction",
        "reference"
    ],
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D object predictions."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 2D object references."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Eval Objects 2D Outputs

Following are the different output types for the job.

objects2d

String, null

Reality data id of ContextScene annotated with classified embedded 2D objects.

report

String, null

Path in Bucket of json report with binary classification.

json

{
    "title": "Eval Objects 2D Outputs",
    "type": "object",
    "properties": {
        "objects2d": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with classified embedded 2D objects.",
            "default": null,
            "nullable": true
        },
        "report": {
            "pattern": "^bkt:.+",
            "type": "string",
            "description": "Path in Bucket of json report with binary classification.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

Eval Objects 2D Options

Options for Eval Objects 2D job.

thresholdIOU

Number, null

Intersection over union threshold.

json

{
    "title": "Eval Objects 2D Options",
    "type": "object",
    "properties": {
        "thresholdIOU": {
            "type": "number",
            "description": "Intersection over union threshold.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Options for Eval Objects 2D job."
}

Eval Objects 2D Specifications

Specifications for Eval Objects 2D job.

inputs

EvalO2DInputs

outputs

EvalO2DOutputs

options

EvalO2DOptions

json

{
    "title": "Eval Objects 2D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalO2DInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalO2DOutputs"
        },
        "options": {
            "$ref": "#/components/schemas/EvalO2DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Objects 2D job."
}

Eval Objects 3D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene annotated with embedded 3D object predictions.

reference

String

Reality data id of ContextScene annotated with embedded 3D object references.

json

{
    "title": "Eval Objects 3D Inputs",
    "required": [
        "prediction",
        "reference"
    ],
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D object predictions."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with embedded 3D object references."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Eval Objects 3D Outputs

Following are the different output types for the job.

objects3d

String, null

Reality data id of ContextScene annotated with classified embedded 3D objects.

report

String, null

Path in Bucket of json report with binary classification.

json

{
    "title": "Eval Objects 3D Outputs",
    "type": "object",
    "properties": {
        "objects3d": {
            "type": "string",
            "description": "Reality data id of ContextScene annotated with classified embedded 3D objects.",
            "default": null,
            "nullable": true
        },
        "report": {
            "pattern": "^bkt:.+",
            "type": "string",
            "description": "Path in Bucket of json report with binary classification.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

Eval Objects 3D Options

Options for Eval Objects 3D job.

thresholdIOU

Number, null

Intersection over union threshold.

json

{
    "title": "Eval Objects 3D Options",
    "type": "object",
    "properties": {
        "thresholdIOU": {
            "type": "number",
            "description": "Intersection over union threshold.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Options for Eval Objects 3D job."
}

Eval Objects 3D Specifications

Specifications for Eval Objects 3D job.

inputs

EvalO3DInputs

outputs

EvalO3DOutputs

options

EvalO3DOptions

json

{
    "title": "Eval Objects 3D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalO3DInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalO3DOutputs"
        },
        "options": {
            "$ref": "#/components/schemas/EvalO3DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Objects 3D job."
}

Eval Segmentation 2D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene pointing to segmented photos prediction.

reference

String

Reality data id of ContextScene, pointing to segmented photos reference.

json

{
    "title": "Eval Segmentation 2D Inputs",
    "required": [
        "prediction",
        "reference"
    ],
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos prediction."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene, pointing to segmented photos reference."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Eval Segmentation 2D Outputs

Following are the different output types for the job.

report

String, null

Path in Bucket of json report with confusion matrix.

segmentation2D

String, null

Reality data id of ContextScene, pointing to segmented photos.

segmentedPhotos

String, null

Reality data id of segmented photos, annotated with confusion matrix index.

json

{
    "title": "Eval Segmentation 2D Outputs",
    "type": "object",
    "properties": {
        "report": {
            "pattern": "^bkt:.+",
            "type": "string",
            "description": "Path in Bucket of json report with confusion matrix.",
            "default": null,
            "nullable": true
        },
        "segmentation2D": {
            "type": "string",
            "description": "Reality data id of ContextScene, pointing to segmented photos.",
            "default": null,
            "nullable": true
        },
        "segmentedPhotos": {
            "type": "string",
            "description": "Reality data id of segmented photos, annotated with confusion matrix index.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

Eval Segmentation 2D Specifications

Specifications for Eval Segmentation 2D job.

inputs

EvalS2DInputs

outputs

EvalS2DOutputs

json

{
    "title": "Eval Segmentation 2D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalS2DInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalS2DOutputs"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Segmentation 2D job."
}

Eval Segmentation 3D Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene pointing to segmented point cloud prediction.

reference

String

Reality data id of ContextScene, pointing to segmented point cloud reference.

json

{
    "title": "Eval Segmentation 3D Inputs",
    "required": [
        "prediction",
        "reference"
    ],
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented point cloud prediction."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene, pointing to segmented point cloud reference."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Eval Segmentation 3D Outputs

Following are the different output types for the job.

report

String, null

Path in Bucket of json report with confusion matrix.

segmentation3D

String, null

Reality data id of ContextScene pointing to segmented point cloud.

segmentedPointCloud

String, null

Reality data id of segmented point cloud annotated with confusion matrix index.

json

{
    "title": "Eval Segmentation 3D Outputs",
    "type": "object",
    "properties": {
        "report": {
            "pattern": "^bkt:.+",
            "type": "string",
            "description": "Path in Bucket of json report with confusion matrix.",
            "default": null,
            "nullable": true
        },
        "segmentation3D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented point cloud.",
            "default": null,
            "nullable": true
        },
        "segmentedPointCloud": {
            "type": "string",
            "description": "Reality data id of segmented point cloud annotated with confusion matrix index.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types for the job."
}

Eval Segmentation 3D Specifications

Specifications for Eval Segmentation 3D job.

inputs

EvalS3DInputs

outputs

EvalS3DOutputs

json

{
    "title": "Eval Segmentation 3D Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalS3DInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalS3DOutputs"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Segmentation 3D job."
}

Eval Segmentation Orthophoto Inputs

Following are the different inputs for the job.

prediction

String

Reality data id of ContextScene pointing to segmented photos prediction.

reference

String

Reality data id of ContextScene pointing to segmented photos reference.

json

{
    "title": "Eval Segmentation Orthophoto Inputs",
    "required": [
        "prediction",
        "reference"
    ],
    "type": "object",
    "properties": {
        "prediction": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos prediction."
        },
        "reference": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos reference."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Eval Segmentation Orthophoto Outputs

Following are the different output types.

report

String, null

Path in Bucket of json report with confusion matrix.

segmentation2D

String, null

Reality data id of ContextScene pointing to segmented photos.

segmentedPhotos

String, null

Reality data id of segmented photos annotated with confusion matrix index.

json

{
    "title": "Eval Segmentation Orthophoto Outputs",
    "type": "object",
    "properties": {
        "report": {
            "pattern": "^bkt:.+",
            "type": "string",
            "description": "Path in Bucket of json report with confusion matrix.",
            "default": null,
            "nullable": true
        },
        "segmentation2D": {
            "type": "string",
            "description": "Reality data id of ContextScene pointing to segmented photos.",
            "default": null,
            "nullable": true
        },
        "segmentedPhotos": {
            "type": "string",
            "description": "Reality data id of segmented photos annotated with confusion matrix index.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types."
}

Eval Segmentation Orthophoto Specifications

Specifications for Eval Segmentation Orthophoto job.

inputs

EvalSOrthoInputs

outputs

EvalSOrthoOutputs

json

{
    "title": "Eval Segmentation Orthophoto Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalSOrthoInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/EvalSOrthoOutputs"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Segmentation Orthophoto job."
}

Clearance Calculation Inputs

Following are the different inputs for the job.

clearanceFootprint

String

Reality data id of building footprints.

model3D

String

Reality data id of a point cloud.

json

{
    "title": "Clearance Calculation Inputs",
    "required": [
        "clearanceFootprint",
        "model3D"
    ],
    "type": "object",
    "properties": {
        "clearanceFootprint": {
            "type": "string",
            "description": "Reality data id of building footprints."
        },
        "model3D": {
            "type": "string",
            "description": "Reality data id of a point cloud."
        }
    },
    "additionalProperties": false,
    "description": "Following are the different inputs for the job."
}

Clearance Calculation Outputs

Following are the different output types.

ovfAreas

String, null

Reality data id of OVF Clearance Areas.

ovfLines

String, null

Reality data id of OVF Clearance Lines.

ovfPoints

String, null

Reality data id of OVF Clearance Points.

json

{
    "title": "Clearance Calculation Outputs",
    "type": "object",
    "properties": {
        "ovfAreas": {
            "type": "string",
            "description": "Reality data id of OVF Clearance Areas.",
            "default": null,
            "nullable": true
        },
        "ovfLines": {
            "type": "string",
            "description": "Reality data id of OVF Clearance Lines.",
            "default": null,
            "nullable": true
        },
        "ovfPoints": {
            "type": "string",
            "description": "Reality data id of OVF Clearance Points.",
            "default": null,
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Following are the different output types."
}

Clearance Calculation Specifications

Specifications for Clearance Calculation job.

inputs

ClearanceInputs

outputs

ClearanceOutputs

json

{
    "title": "Clearance Calculation Specifications",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/ClearanceInputs"
        },
        "outputs": {
            "$ref": "#/components/schemas/ClearanceOutputs"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Clearance Calculation job."
}

Job type

Supported job types

Objects2D

String

Segmentation2D

String

Segmentation3D

String

SegmentationOrthophoto

String

ChangeDetection

String

EvalO2D

String

EvalO3D

String

EvalS2D

String

EvalS3D

String

EvalSOrtho

String

ClearanceCalculation

String

json

{
    "title": "Job type",
    "enum": [
        "Objects2D",
        "Segmentation2D",
        "Segmentation3D",
        "SegmentationOrthophoto",
        "ChangeDetection",
        "EvalO2D",
        "EvalO3D",
        "EvalS2D",
        "EvalS3D",
        "EvalSOrtho",
        "ClearanceCalculation"
    ],
    "description": "Supported job types"
}

Job

Job information.

String

Unique id of the job.

state

JobState

userId

String

Identifier of the user that created the job.

executionInfo

ExecutionInformation

specifications

Any of: Objects2DSpecifications Segmentation2DSpecifications Segmentation3DSpecifications SegmentationOrthophotoSpecifications ChangeDetectionSpecifications EvalO2DSpecifications EvalO3DSpecifications EvalS2DSpecifications EvalS3DSpecifications EvalSOrthoSpecifications ClearanceSpecifications

List of inputs, outputs and options for the job, must be in sync with the type.

name

String, null

Name of the job.

type

JobTypes

iTwinId

String

iTwin Id for the job.

json

{
    "title": "Job",
    "required": [
        "iTwinId",
        "specifications",
        "type",
        "executionInfo",
        "id",
        "state",
        "userId"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Unique id of the job."
        },
        "state": {
            "$ref": "#/components/schemas/JobState"
        },
        "userId": {
            "type": "string",
            "description": "Identifier of the user that created 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."
        },
        "name": {
            "maxLength": 256,
            "minLength": 3,
            "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$",
            "type": "string",
            "description": "Name of the job.",
            "default": null,
            "nullable": true
        },
        "type": {
            "$ref": "#/components/schemas/JobTypes"
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id for the job."
        }
    },
    "additionalProperties": false,
    "description": "Job information."
}

Objects2D Outputs for Creation

Following are the different output types for job creation.

Objects2D

String

Objects3D

String

Objects3DAs3DTiles

String

Objects3DAsGeoJSON

String

Locations3DAsSHP

String

Locations3DAsGeoJSON

String

json

{
    "title": "Objects2D Outputs for Creation",
    "enum": [
        "Objects2D",
        "Objects3D",
        "Objects3DAs3DTiles",
        "Objects3DAsGeoJSON",
        "Locations3DAsSHP",
        "Locations3DAsGeoJSON"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Objects2D Specifications for Creation

Specifications for Objects2D job creation.

inputs

Objects2DInputs

outputs

Objects2DOutputsCreate[]

Outputs for the job.

options

Objects2DOptions

json

{
    "title": "Objects2D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Objects2DInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Objects2DOutputsCreate"
            },
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/Objects2DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Objects2D job creation."
}

Segmentation2D Outputs for Creation

Following are the different output types for job creation.

Segmentation2D

String

SegmentedPhotos

String

Lines3D

String

Lines3DAs3DTiles

String

Lines3DAsGeoJSON

String

Polygons3D

String

Polygons3DAs3DTiles

String

Polygons3DAsGeoJSON

String

json

{
    "title": "Segmentation2D Outputs for Creation",
    "enum": [
        "Segmentation2D",
        "SegmentedPhotos",
        "Lines3D",
        "Lines3DAs3DTiles",
        "Lines3DAsGeoJSON",
        "Polygons3D",
        "Polygons3DAs3DTiles",
        "Polygons3DAsGeoJSON"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Segmentation2D Specifications for Creation

Specifications for Segmentation2D job creation.

inputs

Segmentation2DInputs

outputs

Segmentation2DOutputsCreate[]

Outputs for the job.

options

Segmentation2DOptions

json

{
    "title": "Segmentation2D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Segmentation2DInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Segmentation2DOutputsCreate"
            },
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/Segmentation2DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Segmentation2D job creation."
}

Segmentation3D Outputs for Creation

Following are the different output types for job creation.

Segmentation3D

String

SegmentedPointCloud

String

Segmentation3DAsPOD

String

Segmentation3DAsLAS

String

Segmentation3DAsLAZ

String

Segmentation3DAsPLY

String

Objects3D

String

Objects3DAs3DTiles

String

Objects3DAsGeoJSON

String

Locations3DAsSHP

String

Locations3DAsGeoJSON

String

Lines3D

String

Lines3DAs3DTiles

String

Lines3DAsGeoJSON

String

Polygons3D

String

Polygons3DAs3DTiles

String

Polygons3DAsGeoJSON

String

json

{
    "title": "Segmentation3D Outputs for Creation",
    "enum": [
        "Segmentation3D",
        "SegmentedPointCloud",
        "Segmentation3DAsPOD",
        "Segmentation3DAsLAS",
        "Segmentation3DAsLAZ",
        "Segmentation3DAsPLY",
        "Objects3D",
        "Objects3DAs3DTiles",
        "Objects3DAsGeoJSON",
        "Locations3DAsSHP",
        "Locations3DAsGeoJSON",
        "Lines3D",
        "Lines3DAs3DTiles",
        "Lines3DAsGeoJSON",
        "Polygons3D",
        "Polygons3DAs3DTiles",
        "Polygons3DAsGeoJSON"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Segmentation3D Specifications for Creation

Specifications for Segmentation3D job creation.

inputs

Segmentation3DInputs

options

Segmentation3DOptions

outputs

Segmentation3DOutputsCreate[]

Outputs for the job.

json

{
    "title": "Segmentation3D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/Segmentation3DInputs"
        },
        "options": {
            "$ref": "#/components/schemas/Segmentation3DOptions"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Segmentation3DOutputsCreate"
            },
            "description": "Outputs for the job."
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Segmentation3D job creation."
}

SegmentationOrthophoto Outputs for Creation

Following are the different output types for job creation.

Segmentation2D

String

SegmentedPhotos

String

Polygons2D

String

Polygons2DAsSHP

String

Polygons2DAsGeoJSON

String

Lines2D

String

Lines2DAsSHP

String

Lines2DAsGeoJSON

String

json

{
    "title": "SegmentationOrthophoto Outputs for Creation",
    "enum": [
        "Segmentation2D",
        "SegmentedPhotos",
        "Polygons2D",
        "Polygons2DAsSHP",
        "Polygons2DAsGeoJSON",
        "Lines2D",
        "Lines2DAsSHP",
        "Lines2DAsGeoJSON"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

SegmentationOrthophoto Specifications for Creation

Specifications for SegmentationOrthophoto job creation.

inputs

SegmentationOrthophotoInputs

outputs

SegmentationOrthophotoOutputsCreate[]

Outputs for the job.

json

{
    "title": "SegmentationOrthophoto Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/SegmentationOrthophotoInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/SegmentationOrthophotoOutputsCreate"
            },
            "description": "Outputs for the job."
        }
    },
    "additionalProperties": false,
    "description": "Specifications for SegmentationOrthophoto job creation."
}

ChangeDetection Outputs for Creation

Following are the different output types for job creation.

Objects3D

String

Locations3DAsSHP

String

Locations3DAsGeoJSON

String

ChangesInModelA

String

ChangesInModelB

String

json

{
    "title": "ChangeDetection Outputs for Creation",
    "enum": [
        "Objects3D",
        "Locations3DAsSHP",
        "Locations3DAsGeoJSON",
        "ChangesInModelA",
        "ChangesInModelB"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

ChangeDetection Specifications for Creation

Specifications for ChangeDetection job creation.

inputs

ChangeDetectionInputs

outputs

ChangeDetectionOutputsCreate[]

Outputs for the job.

options

ChangeDetectionOptions

json

{
    "title": "ChangeDetection Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/ChangeDetectionInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ChangeDetectionOutputsCreate"
            },
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/ChangeDetectionOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for ChangeDetection job creation."
}

Eval Objects 2D Outputs for Creation

Following are the different output types for job creation.

Report

String

Objects2D

String

json

{
    "title": "Eval Objects 2D Outputs for Creation",
    "enum": [
        "Report",
        "Objects2D"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Eval Objects 2D Specifications for Creation

Specifications for Eval Objects 2D job creation.

inputs

EvalO2DInputs

outputs

EvalO2DOutputsCreate[]

Outputs for the job.

options

EvalO2DOptions

json

{
    "title": "Eval Objects 2D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalO2DInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/EvalO2DOutputsCreate"
            },
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/EvalO2DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Objects 2D job creation."
}

Eval Objects 3D Outputs for Creation

Following are the different output types for job creation.

Report

String

Objects3D

String

json

{
    "title": "Eval Objects 3D Outputs for Creation",
    "enum": [
        "Report",
        "Objects3D"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Eval Objects 3D Specifications for Creation

Specifications for Eval Objects 3D job creation.

inputs

EvalO3DInputs

outputs

EvalO3DOutputsCreate[]

Outputs for the job.

options

EvalO3DOptions

json

{
    "title": "Eval Objects 3D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalO3DInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/EvalO3DOutputsCreate"
            },
            "description": "Outputs for the job."
        },
        "options": {
            "$ref": "#/components/schemas/EvalO3DOptions"
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Objects 3D job creation."
}

Eval Segmentation 2D Outputs for Creation

Following are the different output types for job creation.

Report

String

SegmentedPhotos

String

Segmentation2D

String

json

{
    "title": "Eval Segmentation 2D Outputs for Creation",
    "enum": [
        "Report",
        "SegmentedPhotos",
        "Segmentation2D"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Eval Segmentation 2D Specifications for Creation

Specifications for Eval Segmentation 2D job creation.

inputs

EvalS2DInputs

outputs

EvalS2DOutputsCreate[]

Outputs for the job.

json

{
    "title": "Eval Segmentation 2D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalS2DInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/EvalS2DOutputsCreate"
            },
            "description": "Outputs for the job."
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Segmentation 2D job creation."
}

Eval Segmentation 3D Outputs for Creation

Following are the different output types for job creation.

Report

String

SegmentedPointCloud

String

Segmentation3D

String

json

{
    "title": "Eval Segmentation 3D Outputs for Creation",
    "enum": [
        "Report",
        "SegmentedPointCloud",
        "Segmentation3D"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Eval Segmentation 3D Specifications for Creation

Specifications for Eval Segmentation 3D job creation.

inputs

EvalS3DInputs

outputs

EvalS3DOutputsCreate[]

Outputs for the job.

json

{
    "title": "Eval Segmentation 3D Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalS3DInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/EvalS3DOutputsCreate"
            },
            "description": "Outputs for the job."
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Segmentation 3D job creation."
}

Eval Segmentation Orthophoto Outputs for Creation

Following are the different output types for job creation.

Report

String

SegmentedPhotos

String

Segmentation2D

String

json

{
    "title": "Eval Segmentation Orthophoto Outputs for Creation",
    "enum": [
        "Report",
        "SegmentedPhotos",
        "Segmentation2D"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Eval Segmentation Orthophoto Specifications for Creation

Specifications for Eval Segmentation Orthophoto job creation.

inputs

EvalSOrthoInputs

outputs

EvalSOrthoOutputsCreate[]

Outputs for the job.

json

{
    "title": "Eval Segmentation Orthophoto Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/EvalSOrthoInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/EvalSOrthoOutputsCreate"
            },
            "description": "Outputs for the job."
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Eval Segmentation Orthophoto job creation."
}

Clearance Calculation Outputs for Creation

Following are the different output types for job creation.

OvfPoints

String

OvfLines

String

OvfAreas

String

json

{
    "title": "Clearance Calculation Outputs for Creation",
    "enum": [
        "OvfPoints",
        "OvfLines",
        "OvfAreas"
    ],
    "type": "string",
    "additionalProperties": false,
    "description": "Following are the different output types for job creation."
}

Clearance Calculation Specifications for Creation

Specifications for Clearance Calculation job creation.

inputs

ClearanceInputs

outputs

ClearanceOutputsCreate[]

Outputs for the job.

json

{
    "title": "Clearance Calculation Specifications for Creation",
    "required": [
        "inputs",
        "outputs"
    ],
    "type": "object",
    "properties": {
        "inputs": {
            "$ref": "#/components/schemas/ClearanceInputs"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ClearanceOutputsCreate"
            },
            "description": "Outputs for the job."
        }
    },
    "additionalProperties": false,
    "description": "Specifications for Clearance Calculation job creation."
}

Job Creation

Model for creating a new job.

specifications

List of inputs, outputs and options for the job, must be in sync with type.

name

String, null

Name of the job.

type

JobTypes

iTwinId

String

iTwin Id for the job.

json

{
    "title": "Job Creation",
    "required": [
        "iTwinId",
        "specifications",
        "type"
    ],
    "type": "object",
    "properties": {
        "specifications": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/Objects2DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/Segmentation2DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/Segmentation3DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/SegmentationOrthophotoSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/ChangeDetectionSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/EvalO2DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/EvalO3DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/EvalS2DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/EvalS3DSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/EvalSOrthoSpecificationsCreate"
                },
                {
                    "$ref": "#/components/schemas/ClearanceSpecificationsCreate"
                }
            ],
            "description": "List of inputs, outputs and options for the job, must be in sync with type."
        },
        "name": {
            "maxLength": 256,
            "minLength": 3,
            "pattern": "^([^\"<>|:*?\\\\/\\u0000-\\u001f])+$",
            "type": "string",
            "description": "Name of the job.",
            "default": null,
            "nullable": true
        },
        "type": {
            "$ref": "#/components/schemas/JobTypes"
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id for the job."
        }
    },
    "additionalProperties": false,
    "description": "Model for creating a new job."
}

Job Response

job

Job

json

{
    "title": "Job Response",
    "required": [
        "job"
    ],
    "type": "object",
    "properties": {
        "job": {
            "$ref": "#/components/schemas/Job"
        }
    },
    "additionalProperties": false
}

Was this page helpful?