Get jobs - 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.

get https://dev-api.bentley.com/realityconversion/jobs[?$filter][&continuationToken][&$top]

Retrieve list of jobs matching provided filter.

The iTwinId in filter is optional. If it is not provided, this will return jobs created by the same user. However, if the iTwinId is provided and the user has access to it, this will return jobs associated with that specific iTwin.

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

Request parameters

$filter

The $filter query option requests a specific set of jobs.
The given filter is evaluated for each job and only job where the filter evaluates to true are returned.
Properties supported for filtering: id, iTwinId, name, email, type, state, createdDateTime, inputId, outputId.
Supported operators: eq, lt, le, gt, ge, ne, in, and, or.
Samples of $filter values:
$filter=iTwinId eq dc720f05-e5f7-448b-ae06-765de46f0af1
$filter=inputId in ('482b2968-6a85-4e50-b05c-8acbf828c1bd', '14c03448-bea0-4d76-b53b-4b20bd3f4cbc')
$filter=id eq 9e2d27cf-b695-47e9-b7f0-0d47dc3b88ad
$filter=createdDateTime gt 2024-06-24T13:00:00Z

continuationToken

Parameter that enables continuing to the next page of the previous paged query. This must be passed exactly as it is in the response body's _links.next property.

$top

The number of reality conversion jobs to get in each page. Max 1000, but 100 is the default if this parameter is not included.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "jobs": [{
        "id": "cc3d35cc-416a-4262-9714-b359da70b419",
        "name": "My first RCS job",
        "type": "Conversion",
        "state": "success",
        "createdDateTime": "2020-09-14T14:29:55.0000000+00:00",
        "lastModifiedDateTime": "2020-09-14T14:29:55.0000000+00:00",
        "iTwinId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ownerId": "1bc8fd79-b72a-4165-b490-58e5244c4cda",
        "email": "email@example.com",
        "dataCenter": "East US",
        "executionInformation": {
            "submissionDateTime": "2020-09-14T14:34:20.0000000+00:00",
            "startedDateTime": "2020-09-14T14:34:28.0000000+00:00",
            "endedDateTime": "2020-09-14T14:41:49.0000000+00:00",
            "estimatedUnits": 0.05
        },
        "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
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/realityconversion/jobs?$filter=iTwinId%20eq%203fa85f64-5717-4562-b3fc-2c963f66afa6&continuationToken=MzY3ZmY1ZDEtNDEzOS00ZGU1LTg0MjMtN2I5NmVkZDAyN2M0"
        }
    }
}

Response 401 Unauthorized

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

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

Response 404 Not Found

Not Found

json

{
    "error": {
        "code": "iTwinNotFound",
        "message": "Requested iTwin 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 find jobs.",
        "details": [{
            "code": "InvalidParameter",
            "message": "The $top query parameter value must be a positive integer that does not exceed 1000.",
            "target": "$top"
        }]
    }
}

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

Full representation of a job.

String

Job unique id.

name

String

Job name.

type

jobType

String

User email address.

state

jobState

inputs

jobInput[]

List of inputs of the job.

iTwinId

String

iTwin Id.

options

jobOptions

outputs

jobOutput[]

List of outputs of a job.

ownerId

String

owner Id.

dataCenter

String

Datacenter location of the job.

costEstimation

createdDateTime

Date-time

Creation time of the job.

executionInformation

lastModifiedDateTime

Date-time

Last modification date of the job.

json

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

link

href

String

Hyperlink container.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink container."
        }
    },
    "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 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

{
    "enum": [
        "Conversion",
        "ImportFeatures"
    ],
    "type": "string",
    "title": "Job Type",
    "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 Input

Input description for a job.

String

Reality data Id of the input.

type

One of: PointCloudInputs VectorInputs TileMapInputs

Input format for a job.

json

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

Job State

Job state.

unsubmitted

String

active

String

success

String

failed

String

cancelled

String

json

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

Job Output

Output description for a job.

String, null

Reality data Id of the output.

type

One of: PointCloudOutputs VectorOutputs TileMapOutputs

Output format for a job.

json

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

Options

List of optional parameters.

merge

Boolean

If true, then all the input files from multiple containers will be merged into one output file. Otherwise, creates one output per input file. Valid only for Conversion jobs.

inputSRS

String

EPSG code for the spatial reference system of input files (horizontal or horizontal+vertical).

topLevel

Integer

Top level of the tile map to generate. Default is -1 (single tile for all input data). Only valid for TileMap output.

outputSRS

String

EPSG code for the spatial reference system of output files (horizontal or horizontal+vertical).

jpgQuality

Double

Quality of JPG tiles to generate (10–99). Default is 85. Only valid for TileMap output.

tileFormat

String

Tile format for the tile map. Supported values are 'JPG' (default) and 'PNG'. Only valid for TileMap output.

bottomLevel

Integer

Bottom level of the tile map to generate. Default is -1 (closest to native resolution). Only valid for TileMap output.

backgroundColor

String

Background color to use for tiles, in 'r.g.b' where r,g,b (red,green,blue) are values 0..255, default value is '255.255.255' (white). Only valid for TileMap output.

sampleWorldStep

Double

Sampling step size in meters for traversing triangles in mesh geometry. Default is 0.125. Only valid for Cesium3DTiles input.

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.

featureClassDisplayName

String

Name of the feature class to create in the Geospatial Features API. If omitted, uses the input reality data display name. Only valid for ImportFeatures jobs.

json

{
    "type": "object",
    "title": "Options",
    "properties": {
        "merge": {
            "type": "boolean",
            "description": "If true, then all the input files from multiple containers will be merged into one output file. Otherwise, creates one output per input file. Valid only for Conversion jobs."
        },
        "inputSRS": {
            "type": "string",
            "description": "EPSG code for the spatial reference system of input files (horizontal or horizontal+vertical)."
        },
        "topLevel": {
            "type": "integer",
            "description": "Top level of the tile map to generate. Default is -1 (single tile for all input data). Only valid for TileMap output."
        },
        "outputSRS": {
            "type": "string",
            "description": "EPSG code for the spatial reference system of output files (horizontal or horizontal+vertical)."
        },
        "jpgQuality": {
            "type": "number",
            "format": "double",
            "maximum": 99,
            "minimum": 10,
            "description": "Quality of JPG tiles to generate (10–99). Default is 85. Only valid for TileMap output."
        },
        "tileFormat": {
            "type": "string",
            "description": "Tile format for the tile map. Supported values are 'JPG' (default) and 'PNG'. Only valid for TileMap output."
        },
        "bottomLevel": {
            "type": "integer",
            "description": "Bottom level of the tile map to generate. Default is -1 (closest to native resolution). Only valid for TileMap output."
        },
        "backgroundColor": {
            "type": "string",
            "description": "Background color to use for tiles, in 'r.g.b' where r,g,b (red,green,blue) are values 0..255, default value is '255.255.255' (white). Only valid for TileMap output."
        },
        "sampleWorldStep": {
            "type": "number",
            "format": "double",
            "description": "Sampling step size in meters for traversing triangles in mesh geometry. Default is 0.125. Only valid for Cesium3DTiles input."
        },
        "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."
        },
        "featureClassDisplayName": {
            "type": "string",
            "description": "Name of the feature class to create in the Geospatial Features API. If omitted, uses the input reality data display name. Only valid for ImportFeatures jobs."
        }
    },
    "description": "List of optional parameters.",
    "additionalProperties": false
}

Vector Input Formats

List of available input formats for vector conversion.

ContextScene

String

GeoJSON

String

OVF

String

OVT

String

SHP

String

json

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

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
}

Tile Map Input Formats

Input types representing raster or tiled datasets for generating tile maps.

Orthophoto

String

OrthophotoDSM

String

OMI

String

OVF

String

OVT

String

json

{
    "enum": [
        "Orthophoto",
        "OrthophotoDSM",
        "OMI",
        "OVF",
        "OVT"
    ],
    "title": "Tile Map Input Formats",
    "description": "Input types representing raster or tiled datasets for generating tile maps."
}

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

{
    "enum": [
        "GeoJSON",
        "FDB"
    ],
    "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."
}

Reality Conversion Jobs

Jobs

jobs

job[]

Array of jobs.

_links

next-page-link

json

{
    "type": "object",
    "title": " Reality Conversion Jobs",
    "properties": {
        "jobs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/job"
            },
            "description": "Array of jobs."
        },
        "_links": {
            "$ref": "#/components/schemas/next-page-link"
        }
    },
    "description": "Jobs",
    "additionalProperties": false
}

Tile Map Output Formats

List of available tile map output formats.

XYZTileMap

String

json

{
    "enum": [
        "XYZTileMap"
    ],
    "title": "Tile Map Output Formats",
    "description": "List of available tile map output formats."
}

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",
    "properties": {
        "gigaPixels": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Number of giga pixels in inputs."
        },
        "megaPoints": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "Number of mega points in inputs."
        },
        "estimatedCost": {
            "type": "number",
            "format": "double",
            "description": "Estimated cost of the job using the CostEstimationParameters."
        }
    },
    "description": "Cost estimate based on parameters before job processing.",
    "additionalProperties": false
}

Next Page Link

URL for getting the next page of data, if applicable.

link

json

{
    "type": "object",
    "title": "Next Page Link",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/link"
        }
    },
    "description": "URL for getting the next page of data, if applicable.",
    "additionalProperties": false
}

Point Cloud Input Formats

List of available input formats for point cloud conversion.

LAS

String

LAZ

String

PLY

String

E57

String

OPC

String

PointCloud

String

PNTS

String

Cesium3DTiles

String

json

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

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

LAS

String

LAZ

String

E57

String

PointCloud

String

json

{
    "enum": [
        "OPC",
        "PNTS",
        "GLB",
        "GLBC",
        "LAS",
        "LAZ",
        "E57",
        "PointCloud"
    ],
    "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."
}

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 Info

Execution information of the job.

errors

ErrorWarningMessage[], null

Errors, if any produced when processing the job

warnings

ErrorWarningMessage[], null

Warnings, if any produced when processing the job

endedDateTime

Date-time, null

End time of the job.

estimatedUnits

Number, null

Estimated processing units cost.

startedDateTime

Date-time, null

Start time of the job.

submissionDateTime

Date-time

Submission time of the job.

json

{
    "type": "object",
    "title": "Execution Info",
    "required": [
        "submissionDateTime"
    ],
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ErrorWarningMessage"
            },
            "nullable": true,
            "description": "Errors, if any produced when processing the job"
        },
        "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 time of the job."
        },
        "estimatedUnits": {
            "type": "number",
            "nullable": true,
            "description": "Estimated processing units cost."
        },
        "startedDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Start time of the job."
        },
        "submissionDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Submission time of the job."
        }
    },
    "description": "Execution information of the 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
}

Was this page helpful?