Modify a job - Reality Analysis

Reality Analysis

This API is deprecated. Please upgrade to the current version of this API as soon as possible.

patch https://dev-api.bentley.com/realitydataanalysis/jobs/{jobId}

Patch an existing job

Patch can be used for changing the job state (to active or cancelled), updating job type and options or changing cost estimation parameters.

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.v1+json is recommended.

jobPatch (Cost)

type

jobType

state

inputs

jobInput[]

List of inputs of the job

options

Any of: objects2DOptions segmentation2DOptions segmentationOrthophotoOptions segmentation3DOptions changeDetectionOptions

Options for this job, must be in sync with type

outputs

outputType[]

List of output types of the job

costEstimationParameters

Example

json

{
    "costEstimationParameters": {
        "gigaPixels": 2,
        "numberOfPhotos": 150
    }
}

Response 200 OK

Created

json

{
    "job": {
        "state": "unsubmitted",
        "outputs": [{
            "type": "objects2D"
        }],
        "inputs": [{
            "type": "photos",
            "id": "e9803e0e-70ce-4ea6-b2ad-1c653cbf2f76"
        }, {
            "type": "photoObjectDetector",
            "id": "@bentley/bentley-traffic-signs-o2d"
        }],
        "options": {
            "minPhotos": 2,
            "useTiePoints": true
        },
        "createdDateTime": "2025-07-24T14:13:27.0000000+00:00",
        "lastModifiedDateTime": "2025-07-24T14:13:27.0000000+00:00",
        "id": "6f51448f-6377-4330-9ab0-f13fe994b3f1",
        "email": "example@email.com",
        "dataCenter": "EastUs",
        "type": "objects2D",
        "name": "My first objects2D job",
        "iTwinId": "510cd1a3-3703-4729-b08c-fecd9c87c3be",
        "costEstimation": {
            "gigaPixels": 2,
            "sceneWidth": 4.5,
            "sceneHeight": 3,
            "sceneLength": 1.7,
            "detectorScale": 1.2,
            "detectorCost": 1.4,
            "numberOfPhotos": 150,
            "estimatedCost": 2.1
        }
    }
}

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

{
    "$ref": "#/components/examples/401.HeaderNotFound.example"
}

Response 404 Not Found

Not Found

json

{
    "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).

json

{
    "error": {
        "code": "InvalidRealityDataAnalysisRequest",
        "message": "Cannot modify job.",
        "details": [{
            "code": "InvalidChange",
            "message": "Cannot submit an already submitted job."
        }]
    }
}

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

Job

Job details

String

Job id

name

String

Job name

type

jobType

String

User email address

state

inputs

jobInput[]

List of inputs of the job

iTwinId

String

ITwin Id

options

Any of: objects2DOptions segmentation2DOptions segmentationOrthophotoOptions segmentation3DOptions changeDetectionOptions

Options for this job, must be in sync with type

outputs

jobOutput[]

List of outputs of the job

dataCenter

String

Data center location of the job

costEstimation

createdDateTime

Date-time

Created date-time of the job

executionInformation

lastModifiedDateTime

Date-time

Date-time of the latest modification of the job

json

{
    "type": "object",
    "title": "Job",
    "required": [
        "id",
        "email",
        "state",
        "type",
        "name",
        "iTwinId",
        "inputs",
        "outputs",
        "createdDateTime",
        "lastModifiedDateTime",
        "costEstimation",
        "dataCenter"
    ],
    "properties": {
        "id": {
            "type": "string",
            "description": "Job id"
        },
        "name": {
            "type": "string",
            "description": "Job name"
        },
        "type": {
            "$ref": "#/components/schemas/jobType"
        },
        "email": {
            "type": "string",
            "description": "User email address"
        },
        "state": {
            "$ref": "#/components/schemas/state"
        },
        "inputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/jobInput"
            },
            "description": "List of inputs of the job"
        },
        "iTwinId": {
            "type": "string",
            "description": "ITwin Id"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/objects2DOptions"
                },
                {
                    "$ref": "#/components/schemas/segmentation2DOptions"
                },
                {
                    "$ref": "#/components/schemas/segmentationOrthophotoOptions"
                },
                {
                    "$ref": "#/components/schemas/segmentation3DOptions"
                },
                {
                    "$ref": "#/components/schemas/changeDetectionOptions"
                }
            ],
            "description": "Options for this job, must be in sync with type"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/jobOutput"
            },
            "description": "List of outputs of the job"
        },
        "dataCenter": {
            "type": "string",
            "description": "Data center location of the job"
        },
        "costEstimation": {
            "$ref": "#/components/schemas/costEstimation"
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Created date-time of the job"
        },
        "executionInformation": {
            "$ref": "#/components/schemas/executionInformation"
        },
        "lastModifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Date-time of the latest modification of the job"
        }
    },
    "description": "Job details",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "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

Possible state of a job among 'unsubmitted', 'active', 'success', 'failed' and 'cancelled'.

unsubmitted

String

active

String

success

String

failed

String

cancelled

String

json

{
    "enum": [
        "unsubmitted",
        "active",
        "success",
        "failed",
        "cancelled"
    ],
    "title": "Job state",
    "description": "Possible state of a job among 'unsubmitted', 'active', 'success', 'failed' and 'cancelled'."
}

Job type

Available job types among 'objects2D', 'segmentation2D', 'segmentation3D', 'segmentationOrthophoto' and 'changeDetection'.

objects2D

String

segmentation2D

String

segmentation3D

String

segmentationOrthophoto

String

changeDetection

String

json

{
    "enum": [
        "objects2D",
        "segmentation2D",
        "segmentation3D",
        "segmentationOrthophoto",
        "changeDetection"
    ],
    "title": "Job type",
    "description": "Available job types among 'objects2D', 'segmentation2D', 'segmentation3D', 'segmentationOrthophoto' and 'changeDetection'."
}

Job Input

Input description of job. In order to use a detector from the Reality Analysis Detector library, the detector's name and version (optional) can be provided in the job input's id field as detectorName/detectorVersion. If the version is not provided, the service will use the latest ready-to-use version of the detector.

String

Detector name from the detector library or reality data id from the Reality Management.

type

inputType

json

{
    "type": "object",
    "title": "Job Input",
    "required": [
        "type",
        "id"
    ],
    "properties": {
        "id": {
            "type": "string",
            "description": "Detector name from the detector library or reality data id from the Reality Management."
        },
        "type": {
            "$ref": "#/components/schemas/inputType"
        }
    },
    "description": "Input description of job. In order to use a detector from the [Reality Analysis Detector](/apis/realitydataanalysis/rda-cd/#reality-analysis-detectors-api) library, the detector's name and version (optional) can be provided in the job input's id field as `detectorName/detectorVersion`. If the version is not provided, the service will use the latest ready-to-use version of the detector.",
    "additionalProperties": false
}

Job Patch

Patch information to be applied

type

jobType

state

inputs

jobInput[]

List of inputs of the job

options

Any of: objects2DOptions segmentation2DOptions segmentationOrthophotoOptions segmentation3DOptions changeDetectionOptions

Options for this job, must be in sync with type

outputs

outputType[]

List of output types of the job

costEstimationParameters

json

{
    "type": "object",
    "title": "Job Patch",
    "properties": {
        "type": {
            "$ref": "#/components/schemas/jobType"
        },
        "state": {
            "$ref": "#/components/schemas/state"
        },
        "inputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/jobInput"
            },
            "description": "List of inputs of the job"
        },
        "options": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/objects2DOptions"
                },
                {
                    "$ref": "#/components/schemas/segmentation2DOptions"
                },
                {
                    "$ref": "#/components/schemas/segmentationOrthophotoOptions"
                },
                {
                    "$ref": "#/components/schemas/segmentation3DOptions"
                },
                {
                    "$ref": "#/components/schemas/changeDetectionOptions"
                }
            ],
            "description": "Options for this job, must be in sync with type"
        },
        "outputs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/outputType"
            },
            "description": "List of output types of the job"
        },
        "costEstimationParameters": {
            "$ref": "#/components/schemas/costEstimationParameters"
        }
    },
    "description": "Patch information to be applied",
    "additionalProperties": false
}

Input types

Input types available. Refer to 'Job types' page for per job type list.

photos

String

photoObjectDetector

String

photoSegmentationDetector

String

orthophoto

String

orthophotoSegmentationDetector

String

pointClouds

String

objects2D

String

meshes

String

pointCloudSegmentationDetector

String

clipPolygon

String

segmentation3D

String

segmentation2D

String

pointClouds1

String

pointClouds2

String

meshes1

String

meshes2

String

json

{
    "enum": [
        "photos",
        "photoObjectDetector",
        "photoSegmentationDetector",
        "orthophoto",
        "orthophotoSegmentationDetector",
        "pointClouds",
        "objects2D",
        "meshes",
        "pointCloudSegmentationDetector",
        "clipPolygon",
        "segmentation3D",
        "segmentation2D",
        "pointClouds1",
        "pointClouds2",
        "meshes1",
        "meshes2"
    ],
    "title": "Input types",
    "description": "Input types available. Refer to 'Job types' page for per job type list."
}

Job Output

Output description for a job

String, null

Reality Data id of the output

type

outputType

json

{
    "type": "object",
    "title": "Job Output",
    "required": [
        "type"
    ],
    "properties": {
        "id": {
            "type": "string",
            "nullable": true,
            "description": "Reality Data id of the output"
        },
        "type": {
            "$ref": "#/components/schemas/outputType"
        }
    },
    "description": "Output description for a job",
    "additionalProperties": false
}

Output types

Output types available. Refer to 'Job types' page for per job type list.

objects2D

String

segmentation2D

String

polygons2D

String

polygons3D

String

exportedPolygons2DSHP

String

exportedPolygons3DDGN

String

exportedPolygons2DGeoJSON

String

exportedPolygons3DCesium

String

exportedPolygons3DGeoJSON

String

lines2D

String

exportedLines2DSHP

String

exportedLines2DDGN

String

exportedLines2DGeoJSON

String

objects3D

String

exportedObjects3DDGN

String

exportedObjects3DCesium

String

exportedObjects3DGeoJSON

String

exportedLocations3DSHP

String

exportedLocations3DGeoJSON

String

segmentation3D

String

segmentedPointCloud

String

segmentedPhotos

String

exportedSegmentation3DPOD

String

exportedSegmentation3DLAS

String

exportedSegmentation3DLAZ

String

exportedSegmentation3DPLY

String

lines3D

String

exportedLines3DDGN

String

exportedLines3DCesium

String

exportedLines3DGeoJSON

String

json

{
    "enum": [
        "objects2D",
        "segmentation2D",
        "polygons2D",
        "polygons3D",
        "exportedPolygons2DSHP",
        "exportedPolygons3DDGN",
        "exportedPolygons2DGeoJSON",
        "exportedPolygons3DCesium",
        "exportedPolygons3DGeoJSON",
        "lines2D",
        "exportedLines2DSHP",
        "exportedLines2DDGN",
        "exportedLines2DGeoJSON",
        "objects3D",
        "exportedObjects3DDGN",
        "exportedObjects3DCesium",
        "exportedObjects3DGeoJSON",
        "exportedLocations3DSHP",
        "exportedLocations3DGeoJSON",
        "segmentation3D",
        "segmentedPointCloud",
        "segmentedPhotos",
        "exportedSegmentation3DPOD",
        "exportedSegmentation3DLAS",
        "exportedSegmentation3DLAZ",
        "exportedSegmentation3DPLY",
        "lines3D",
        "exportedLines3DDGN",
        "exportedLines3DCesium",
        "exportedLines3DGeoJSON"
    ],
    "title": "Output types",
    "description": "Output types available. Refer to 'Job types' page for per job type list."
}

Job response

job

json

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

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "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."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "additionalProperties": true
}

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

Error

Error information.

json

{
    "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
}

Cost Estimation information

Cost estimate based on parameters before job processing

gigaPixels

Double, null

Number of giga pixels in inputs

sceneWidth

Double, null

Width of the scene

sceneHeight

Double, null

Height of the scene

sceneLength

Double, null

Length of the scene

detectorCost

Double, null

Cost of the detector

detectorScale

Double, null

Scale of the detector

estimatedCost

Double

Estimated Cost of the job using the CostEstimationParameters

numberOfPhotos

Int32, null

Number of photos in inputs

json

{
    "type": "object",
    "title": "Cost Estimation information",
    "properties": {
        "gigaPixels": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Number of giga pixels in inputs"
        },
        "sceneWidth": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Width of the scene"
        },
        "sceneHeight": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Height of the scene"
        },
        "sceneLength": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Length of the scene"
        },
        "detectorCost": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Cost of the detector"
        },
        "detectorScale": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Scale of the detector"
        },
        "estimatedCost": {
            "type": "number",
            "format": "double",
            "description": "Estimated Cost of the job using the CostEstimationParameters"
        },
        "numberOfPhotos": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Number of photos in inputs"
        }
    },
    "description": "Cost estimate based on parameters before job processing",
    "additionalProperties": false
}

Objects2D Options

Options for Object2D job

maxDist

Number

Maximum distance between photos and 3D objects (default: 0)

exportSrs

String

SRS used by exports

minPhotos

Integer

Minimum number of 2D objects to generate a 3D object (default: 0)

useTiePoints

Boolean

Improve detection using tie points in orientedPhotos (advanced)

json

{
    "type": "object",
    "title": "Objects2D Options",
    "properties": {
        "maxDist": {
            "type": "number",
            "description": "Maximum distance between photos and 3D objects (default: 0)"
        },
        "exportSrs": {
            "type": "string",
            "description": "SRS used by exports"
        },
        "minPhotos": {
            "type": "integer",
            "description": "Minimum number of 2D objects to generate a 3D object (default: 0)"
        },
        "useTiePoints": {
            "type": "boolean",
            "description": "Improve detection using tie points in orientedPhotos (advanced)"
        }
    },
    "description": "Options for Object2D job",
    "additionalProperties": false
}

Error and Warning messages

Model for error and warning messages

code

String

Error or warning message code

title

String

Error or warning message title

params

Array

Error or warning message parameters

message

String

Error or warning message

json

{
    "type": "object",
    "title": "Error and Warning messages",
    "properties": {
        "code": {
            "type": "string",
            "description": "Error or warning message code"
        },
        "title": {
            "type": "string",
            "description": "Error or warning message title"
        },
        "params": {
            "type": "array",
            "description": "Error or warning message parameters"
        },
        "message": {
            "type": "string",
            "description": "Error or warning message"
        }
    },
    "description": "Model for error and warning messages",
    "additionalProperties": false
}

Execution information

Execution details regarding a job

errors

ErrorWarningMessage[], null

Errors, if any produced when processing the job

exitCode

Integer, null

Exit code of the processing

warnings

ErrorWarningMessage[], null

Warnings, if any produced when processing the job

endedDateTime

Date-time, null

End date time of the job

estimatedUnits

Double, null

Estimated cost of the executed job

startedDateTime

Date-time, null

Start date time of the job

submissionDateTime

Date-time, null

Submission date time of the job

json

{
    "type": "object",
    "title": "Execution information",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ErrorWarningMessage"
            },
            "nullable": true,
            "description": "Errors, if any produced when processing the job"
        },
        "exitCode": {
            "type": "integer",
            "nullable": true,
            "description": "Exit code of the processing"
        },
        "warnings": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ErrorWarningMessage"
            },
            "nullable": true,
            "description": "Warnings, if any produced when processing the job"
        },
        "endedDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "End date time of the job"
        },
        "estimatedUnits": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Estimated cost of the executed job"
        },
        "startedDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Start date time of the job"
        },
        "submissionDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Submission date time of the job"
        }
    },
    "description": "Execution details regarding a job",
    "additionalProperties": false
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

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

Segmentation2D Options

Options for Segmentation2D job

exportSrs

String

SRS used by exports

minPhotos

Integer

Minimum number of 2D objects to generate a 3D object (default: 0)

computeLineWidth

Boolean

Estimate 3D line width at each vertex

removeSmallComponents

Number

Remove 3D lines with total length smaller than this value

json

{
    "type": "object",
    "title": "Segmentation2D Options",
    "properties": {
        "exportSrs": {
            "type": "string",
            "description": "SRS used by exports"
        },
        "minPhotos": {
            "type": "integer",
            "description": "Minimum number of 2D objects to generate a 3D object (default: 0)"
        },
        "computeLineWidth": {
            "type": "boolean",
            "description": "Estimate 3D line width at each vertex"
        },
        "removeSmallComponents": {
            "type": "number",
            "description": "Remove 3D lines with total length smaller than this value"
        }
    },
    "description": "Options for Segmentation2D job",
    "additionalProperties": false
}

Segmentation3D Options

Options for Segmentation3D job

exportSrs

String

SRS used by exports

saveConfidence

String

Save confidence in 3D segmentation

computeLineWidth

Boolean

Estimate 3D line width at each vertex

keepInputResolution

Boolean

The default value is false which means the input point cloud may be subsampled if the detector resolution is different than the input point cloud resolution. If set to true, the output point cloud will have the exact same points as the input point cloud.

removeSmallComponents

Number

Remove 3D lines with total length smaller than this value

json

{
    "type": "object",
    "title": "Segmentation3D Options",
    "properties": {
        "exportSrs": {
            "type": "string",
            "description": "SRS used by exports"
        },
        "saveConfidence": {
            "type": "string",
            "description": "Save confidence in 3D segmentation"
        },
        "computeLineWidth": {
            "type": "boolean",
            "description": "Estimate 3D line width at each vertex"
        },
        "keepInputResolution": {
            "type": "boolean",
            "description": "The default value is false which means the input point cloud may be subsampled if the detector resolution is different than the input point cloud resolution. If set to true, the output point cloud will have the exact same points as the input point cloud."
        },
        "removeSmallComponents": {
            "type": "number",
            "description": "Remove 3D lines with total length smaller than this value"
        }
    },
    "description": "Options for Segmentation3D job",
    "additionalProperties": false
}

ChangeDetection Options

Options for a ChangeDetection job

exportSrs

String

SRS used by exports

minPoints

Integer

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

resolution

Number

Target point cloud resolution when starting from meshes

distThresholdLow

Number

Low threshold to detect spatial changes (hysteresis detection). 0 for automatic setting

colorThresholdLow

Number

Low threshold to detect color changes (hysteresis detection). 0 to ignore color changes

distThresholdHigh

Number

High threshold to detect spatial changes (hysteresis detection). 0 for automatic setting

colorThresholdHigh

Number

High threshold to detect color changes (hysteresis detection). 0 to ignore color changes

json

{
    "type": "object",
    "title": "ChangeDetection Options",
    "properties": {
        "exportSrs": {
            "type": "string",
            "description": "SRS used by exports"
        },
        "minPoints": {
            "type": "integer",
            "description": "Minimum number of points in a region to be considered as a change"
        },
        "resolution": {
            "type": "number",
            "description": "Target point cloud resolution when starting from meshes"
        },
        "distThresholdLow": {
            "type": "number",
            "description": "Low threshold to detect spatial changes (hysteresis detection). 0 for automatic setting"
        },
        "colorThresholdLow": {
            "type": "number",
            "description": "Low threshold to detect color changes (hysteresis detection). 0 to ignore color changes"
        },
        "distThresholdHigh": {
            "type": "number",
            "description": "High threshold to detect spatial changes (hysteresis detection). 0 for automatic setting"
        },
        "colorThresholdHigh": {
            "type": "number",
            "description": "High threshold to detect color changes (hysteresis detection). 0 to ignore color changes"
        }
    },
    "description": "Options for a ChangeDetection job",
    "additionalProperties": false
}

Cost Estimation Parameters

Optional parameters for estimating job cost before its processing

gigaPixels

Double, null

Number of giga pixels in inputs

sceneWidth

Double, null

Width of the scene

sceneHeight

Double, null

Height of the scene

sceneLength

Double, null

Length of the scene

detectorCost

Double, null

Cost of the detector

detectorScale

Double, null

Scale of the detector

numberOfPhotos

Int32, null

Number of photos in inputs

json

{
    "type": "object",
    "title": "Cost Estimation Parameters",
    "properties": {
        "gigaPixels": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Number of giga pixels in inputs"
        },
        "sceneWidth": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Width of the scene"
        },
        "sceneHeight": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Height of the scene"
        },
        "sceneLength": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Length of the scene"
        },
        "detectorCost": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Cost of the detector"
        },
        "detectorScale": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Scale of the detector"
        },
        "numberOfPhotos": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Number of photos in inputs"
        }
    },
    "description": "Optional parameters for estimating job cost before its processing",
    "additionalProperties": false
}

SegmentationOrthophoto Options

Options for SegmentationOrthophoto job

Was this page helpful?

Authentication

Request

Request parameters

Request headers

Request body

jobPatch (Cost)

Example

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Job

Error

Job state

Job type

Job Input

Job Patch

Input types

Job Output

Output types

Job response

DetailedError

Error Response

Cost Estimation information

Objects2D Options

Error and Warning messages

Execution information

Detailed Error Response

Segmentation2D Options

Segmentation3D Options

ChangeDetection Options

Cost Estimation Parameters

SegmentationOrthophoto Options