Modify a job - Reality Conversion

Reality Conversion

Download API definition:

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

Modify a job

PATCH https://dev-api.bentley.com/realityconversion/jobs/{id}

Patch can be used for changing the job state (to active or cancelled), 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 parameters

Yes

Job Id.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

JobStateModify (UpdateState)

Job State

JobStateModify-state

Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.

Example

json

{
    "state": "active"
}

JobModify (UpdateOptions)

options

jobOptions

List of optional parameters.

costEstimationParameters

Parameters to be used to estimate the cost of the job.

Example

json

{
    "options": {
        "processingEngines": 2,
        "merge": false
    },
    "costEstimationParameters": {
        "gigaPixels": 2.5,
        "megaPoints": 1.7
    }
}

Response 200 OK

Job was successfully updated.

json

{
    "job": {
        "id": "cc3d35cc-416a-4262-9714-b359da70b419",
        "name": "My first RCS job",
        "type": "Conversion",
        "state": "active",
        "createdDateTime": "2020-09-14T14:29:55Z",
        "lastModifiedDateTime": "2020-09-14T14:29:55Z",
        "iTwinId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "email": "example@email.com",
        "dataCenter": "East US",
        "inputs": [{
            "id": "58e0c0ca-f730-4e5b-808d-1c8cacacb4d4",
            "type": "LAS"
        }],
        "outputs": [{
            "id": "3ddee08c-01e8-44a5-8e56-3879109f6728",
            "type": "OPC"
        }],
        "options": {
            "processingEngines": 5,
            "merge": false
        },
        "costEstimation": {
            "estimatedCost": 3.5,
            "gigaPixels": 2.1,
            "megaPoints": 1.5
        }
    }
}

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

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": "InvalidRealityConversionRequest",
        "message": "Cannot modify job.",
        "details": [{
            "code": "InvalidChange",
            "message": "Cannot resubmit 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 Response

job

Complete job details.

json

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

Job

Full representation of a job.

String

Job unique id.

name

String

Job name.

type

jobType

Job type.

state

jobState

Job current state.

iTwinId

String

iTwin Id.

ownerId

String

owner Id.

createdDateTime

Date-time

Creation time of the job.

lastModifiedDateTime

Date-time

Last modification date of the job.

dataCenter

String

Datacenter location of the job.

String

User email address.

executionInformation

Execution information of the job.

costEstimation

Parameters to be used to estimate the cost of the job.

inputs

jobInput[]

List of inputs of the job.

outputs

jobOutput[]

List of outputs of a job.

options

jobOptions

List of optional parameters.

json

{
    "title": "Job",
    "description": "Full representation of a job.",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Job unique id."
        },
        "name": {
            "type": "string",
            "description": "Job name."
        },
        "type": {
            "$ref": "#/components/schemas/jobType",
            "description": "Job type."
        },
        "state": {
            "$ref": "#/components/schemas/jobState",
            "description": "Job current state."
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin Id."
        },
        "ownerId": {
            "type": "string",
            "description": "owner Id."
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the job."
        },
        "lastModifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Last modification date of the job."
        },
        "dataCenter": {
            "type": "string",
            "description": "Datacenter location of the job."
        },
        "email": {
            "type": "string",
            "description": "User email address."
        },
        "executionInformation": {
            "$ref": "#/components/schemas/executionInformation",
            "description": "Execution information of the job."
        },
        "costEstimation": {
            "$ref": "#/components/schemas/costEstimation",
            "description": "Parameters to be used to estimate the cost of the job."
        },
        "inputs": {
            "description": "List of inputs of the job.",
            "items": {
                "$ref": "#/components/schemas/jobInput"
            },
            "type": "array"
        },
        "outputs": {
            "description": "List of outputs of a job.",
            "items": {
                "$ref": "#/components/schemas/jobOutput"
            },
            "type": "array"
        },
        "options": {
            "$ref": "#/components/schemas/jobOptions",
            "description": "List of optional parameters."
        }
    },
    "required": [
        "id",
        "name",
        "type",
        "state",
        "createdDateTime",
        "lastModifiedDateTime",
        "dataCenter",
        "inputs",
        "outputs",
        "iTwinId"
    ],
    "additionalProperties": false
}

Job Type

Possible values:

Conversion: Converts input data from one format to another.
ImportFeatures: Takes vector inputs and imports features into a feature class of Geospatial Features API. Use FDB as the output format for this type.

Conversion

String

ImportFeatures

String

json

{
    "title": "Job Type",
    "type": "string",
    "enum": [
        "Conversion",
        "ImportFeatures"
    ],
    "description": "Possible values:\n- Conversion: Converts input data from one format to another.\n- ImportFeatures: Takes vector inputs and imports features into a feature class of Geospatial Features API. Use `FDB` as the output format for this type."
}

Job State

Job state.

unsubmitted

String

active

String

success

String

failed

String

cancelled

String

json

{
    "title": "Job State",
    "type": "string",
    "enum": [
        "unsubmitted",
        "active",
        "success",
        "failed",
        "cancelled"
    ],
    "description": "Job state."
}

Point Cloud Input Formats

List of available point cloud input formats.

LAS

String

LAZ

String

PLY

String

E57

String

OPC

String

PointCloud

String

PNTS

String

Cesium3DTiles

String

json

{
    "title": "Point Cloud Input Formats",
    "description": "List of available point cloud input formats.",
    "enum": [
        "LAS",
        "LAZ",
        "PLY",
        "E57",
        "OPC",
        "PointCloud",
        "PNTS",
        "Cesium3DTiles"
    ]
}

Vector Input Formats

List of available vector input formats.

ContextScene

String

GeoJSON

String

OVF

String

OVT

String

SHP

String

json

{
    "title": "Vector Input Formats",
    "description": "List of available vector input formats.",
    "enum": [
        "ContextScene",
        "GeoJSON",
        "OVF",
        "OVT",
        "SHP"
    ]
}

Job Input

Input description for a job.

type

One of: PointCloudInputs VectorInputs

Input format for a job.

String

Reality data Id of the input.

json

{
    "type": "object",
    "title": "Job Input",
    "description": "Input description for a job.",
    "properties": {
        "type": {
            "description": "Input format for a job.",
            "oneOf": [
                {
                    "$ref": "#/components/schemas/PointCloudInputs"
                },
                {
                    "$ref": "#/components/schemas/VectorInputs"
                }
            ]
        },
        "id": {
            "type": "string",
            "description": "Reality data Id of the input."
        }
    },
    "additionalProperties": false
}

Point Cloud Output Formats

List of available point cloud output formats.

OPC: Orbit Point Cloud
PNTS: OGC 3DTiles Point Cloud 1.0
GLB: OGC 3DTiles Point Cloud 1.1
GLBC: OGC 3DTiles Point Cloud 1.1 Compressed.

OPC

String

PNTS

String

GLB

String

GLBC

String

json

{
    "title": "Point Cloud Output Formats",
    "description": "List of available point cloud output formats.\n- OPC: Orbit Point Cloud\n- PNTS: OGC 3DTiles Point Cloud 1.0\n- GLB: OGC 3DTiles Point Cloud 1.1\n- GLBC: OGC 3DTiles Point Cloud 1.1 Compressed.",
    "enum": [
        "OPC",
        "PNTS",
        "GLB",
        "GLBC"
    ]
}

Vector Output Formats

List of available vector output formats.

Use FDB as the output format when the job type is ImportFeatures.

GeoJSON

String

FDB

String

json

{
    "title": "Vector Output Formats",
    "description": "List of available vector output formats.\n\n - Use FDB as the output format when the job type is ImportFeatures.",
    "enum": [
        "GeoJSON",
        "FDB"
    ]
}

Job Output

Output description for a job.

type

One of: PointCloudOutputs VectorOutputs

Output format for a job.

String, null

Reality data Id of the output.

json

{
    "type": "object",
    "title": "Job Output",
    "description": "Output description for a job.",
    "properties": {
        "type": {
            "description": "Output format for a job.",
            "oneOf": [
                {
                    "$ref": "#/components/schemas/PointCloudOutputs"
                },
                {
                    "$ref": "#/components/schemas/VectorOutputs"
                }
            ]
        },
        "id": {
            "type": "string",
            "description": "Reality data Id of the output.",
            "nullable": true
        }
    },
    "additionalProperties": false
}

Options

List of optional parameters.

processingEngines

Integer

Number of engines to be used at most, between 0 and your engine limit. If set at 0, RCS will use your engine limit.

merge

Boolean

If true, then all the input files from multiple containers will be merged into one output file. Else output file will be created per input file. Valid only for Conversion job type.

inputSRS

String

Horizonal or horizontal+vertical EPSG codes of the SRS (spatial reference system.) of the input files.

outputSRS

String

Horizonal or horizontal+vertical EPSG codes of the SRS (spatial reference system.) of the output files.

sampleWorldStep

Double

Specifies the sampling step size, in world units (meters), used when traversing triangles in the input mesh geometry. Defaults to 0.125 meters. Only supported when the input format is Cesium3DTiles.

featureClassDisplayName

String

Specifies the name of the feature class to create in the Geospatial Features API. If omitted, the input reality data display name is used. Valid only for ImportFeatures job type.

json

{
    "type": "object",
    "title": "Options",
    "description": "List of optional parameters.",
    "properties": {
        "processingEngines": {
            "type": "integer",
            "description": "Number of engines to be used at most, between 0 and your engine limit. If set at 0, RCS will use your engine limit."
        },
        "merge": {
            "type": "boolean",
            "description": "If true, then all the input files from multiple containers will be merged into one output file. Else output file will be created per input file. Valid only for Conversion job type."
        },
        "inputSRS": {
            "type": "string",
            "description": "Horizonal or horizontal+vertical EPSG codes of the SRS (spatial reference system.) of the input files."
        },
        "outputSRS": {
            "type": "string",
            "description": "Horizonal or horizontal+vertical EPSG codes of the SRS (spatial reference system.) of the output files."
        },
        "sampleWorldStep": {
            "type": "number",
            "format": "double",
            "description": "Specifies the sampling step size, in world units (meters), used when traversing triangles in the input mesh geometry. Defaults to 0.125 meters. Only supported when the input format is Cesium3DTiles."
        },
        "featureClassDisplayName": {
            "type": "string",
            "description": "Specifies the name of the feature class to create in the Geospatial Features API. If omitted, the input reality data display name is used. Valid only for ImportFeatures job type."
        }
    },
    "additionalProperties": false
}

Execution Info

Execution information of the job.

submissionDateTime

Date-time

Submission time of the job.

startedDateTime

Date-time, null

Start time of the job.

endedDateTime

Date-time, null

End time of the job.

estimatedUnits

Number, null

Estimated processing units cost.

json

{
    "title": "Execution Info",
    "description": "Execution information of the job.",
    "type": "object",
    "properties": {
        "submissionDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Submission time of the job."
        },
        "startedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Start time of the job.",
            "nullable": true
        },
        "endedDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "End time of the job.",
            "nullable": true
        },
        "estimatedUnits": {
            "type": "number",
            "description": "Estimated processing units cost.",
            "nullable": true
        }
    },
    "required": [
        "submissionDateTime"
    ],
    "additionalProperties": false
}

Cost Estimation Parameters

Parameters to be used to estimate the cost of the job.

gigaPixels

Number

Gigapixels to be processed.

megaPoints

Number

Megapoints to be processed.

json

{
    "title": "Cost Estimation Parameters",
    "description": "Parameters to be used to estimate the cost of the job.",
    "type": "object",
    "properties": {
        "gigaPixels": {
            "type": "number",
            "description": "Gigapixels to be processed."
        },
        "megaPoints": {
            "type": "number",
            "description": "Megapoints to be processed."
        }
    },
    "additionalProperties": false
}

Cost Estimation Information

Cost estimate based on parameters before job processing.

gigaPixels

Double, null

Number of giga pixels in inputs.

megaPoints

Double, null

Number of mega points in inputs.

estimatedCost

Double

Estimated cost of the job using the CostEstimationParameters.

json

{
    "type": "object",
    "title": "Cost Estimation Information",
    "description": "Cost estimate based on parameters before job processing.",
    "properties": {
        "gigaPixels": {
            "description": "Number of giga pixels in inputs.",
            "type": "number",
            "format": "double",
            "nullable": true
        },
        "megaPoints": {
            "description": "Number of mega points in inputs.",
            "type": "number",
            "format": "double",
            "nullable": true
        },
        "estimatedCost": {
            "type": "number",
            "description": "Estimated cost of the job using the CostEstimationParameters.",
            "format": "double"
        }
    },
    "additionalProperties": false
}

Job State

Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.

active

String

cancelled

String

json

{
    "title": "Job State",
    "type": "string",
    "enum": [
        "active",
        "cancelled"
    ],
    "description": "Set to 'active' to start processing the job, or 'cancelled' to cancel the running job."
}

Modify Job State

Request model for updating the state of a job. Use to start processing or cancel a running job.

Job State

JobStateModify-state

Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.

json

{
    "title": "Modify Job State",
    "type": "object",
    "description": "Request model for updating the state of a job. Use to start processing or cancel a running job.",
    "properties": {
        "state": {
            "title": "Job State",
            "type": "string",
            "enum": [
                "active",
                "cancelled"
            ],
            "description": "Set to 'active' to start processing the job, or 'cancelled' to cancel the running job.",
            "$ref": "#/components/schemas/JobStateModify-state"
        }
    },
    "additionalProperties": false
}

Modify Job

PATCH model for updating job properties. All properties are optional; only provided fields will be updated.

options

jobOptions

List of optional parameters.

costEstimationParameters

Parameters to be used to estimate the cost of the job.

json

{
    "title": "Modify Job",
    "type": "object",
    "description": "PATCH model for updating job properties. All properties are optional; only provided fields will be updated.",
    "properties": {
        "options": {
            "$ref": "#/components/schemas/jobOptions",
            "description": "List of optional parameters."
        },
        "costEstimationParameters": {
            "$ref": "#/components/schemas/costEstimationParameters",
            "description": "Parameters to be used to estimate the cost of the 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.

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

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

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

Error Detailed information.

json

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

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

{
    "type": "object",
    "description": "Contains error information.",
    "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
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

Error Response

error

Error

Error information.

json

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

Was this page helpful?

Authentication

Request

Request parameters

Request headers

Request body

JobStateModify (UpdateState)

Example

JobModify (UpdateOptions)

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 Response

Job

Job Type

Job State

Point Cloud Input Formats

Vector Input Formats

Job Input

Point Cloud Output Formats

Vector Output Formats

Job Output

Options

Execution Info

Cost Estimation Parameters

Cost Estimation Information

Job State

Modify Job State

Modify Job

DetailedError

Detailed Error Response

Error

Error Response