Get a job - Reality Modeling

REST API Overview

Reference

Changelog

Reality Modeling

Download API definition:

Get a job

GET https://api.bentley.com/contextcapture/jobs/{id}

Retrieve job details.

Authentication

Requires Authorization header with valid Bearer token for scope contextcapture:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Request parameters

template

Yes

Job id

Request headers

Authorization

Yes

OAuth access token with scope contextcapture:read

Yes

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

Response 200 OK

json

{
    "job": {
        "id": "cc3d35cc-416a-4262-9714-b359da70b419",
        "name": "My first Reality Modeling job",
        "type": "Full",
        "state": "success",
        "createdDateTime": "2020-09-14T14:29:55Z",
        "lastModifiedDateTime": "2020-09-14T14:29:55Z",
        "iTwinId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "location": "East US",
        "email": "john.smith@example.com",
        "workspaceId": "6881117d-9fd2-4900-870b-9b721dc90f25",
        "executionInformation": {
            "submittedDateTime": "2020-09-14T14:34:20Z",
            "startedDateTime": "2020-09-14T14:34:28Z",
            "endedDateTime": "2020-09-14T14:41:49Z",
            "estimatedUnits": 0.05
        },
        "inputs": [{
                "id": "58e0c0ca-f730-4e5b-808d-1c8cacacb4d4",
                "description": "Drone ImageCollection"
            },
            {
                "id": "dc65ce7d-2598-422f-97a5-5ae8eb004b67",
                "description": "Drone CCOrientations"
            }
        ],
        "jobSettings": {
            "quality": "Extra",
            "outputs": [{
                    "format": "OBJ",
                    "id": "3ddee08c-01e8-44a5-8e56-3879109f6728"
                },
                {
                    "format": "3MX",
                    "id": "f18fc6c3-2224-4d63-a04b-52bd18805d01"
                }
            ],
            "processingEngines": 5,
            "cacheSettings": {
                "createCache": true,
                "useCache": "799b11bd-71cf-481a-b284-bf48f672cd9a"
            }
        },
        "costEstimationParameters": {
            "gigaPixels": 2.1,
            "megaPoints": 1.5,
            "meshQuality": "Extra"
        },
        "estimatedCost": 3.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 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Output format

Output format among 'CCOrientations', '3MX', '3SM', 'WebReady ScalableMesh', 'Cesium 3D Tiles', 'POD', 'Orthophoto/DSM', 'LAS', 'FBX', 'OBJ', 'ESRI i3s', 'DGN', 'LODTreeExport', 'PLY', 'OPC', OMR and ContextScene.

TableSchema

No data.

Job quality

Job quality among 'Draft', 'Medium' and 'Extra'

TableSchema

No data.

Cost Estimation Parameters

Parameters to be used to estimate the cost of the job

TableSchema

gigaPixels

Number

Gigapixels to be processed

megaPoints

Number

Megapoints to be processed

meshQuality

quality

Quality of the job

Job Input

Description of an input for a job

TableSchema

String

Context Share reality data id of the input

description

String

Description of the input

Cache settings

Describe how a job will use and create cache

TableSchema

createCache

Boolean

Indicate if the job will produce a cache

useCache

String

Id of the previous job cache to be reused

Error and Warning messages

Model for error and warning messages

TableSchema

code

String

Error or warning message code

title

String

Error or warning message title

message

String

Error or warning message

params

Array

Error or warning message parameters

Execution Info

Execution information relative to a job

TableSchema

submittedDateTime

Date-time

Submission time of the job

startedDateTime

Date-time

Start time of the job

endedDateTime

Date-time

End time of the job

estimatedUnits

Number,null

Estimated processing units cost

errors

ErrorWarningMessages[]

Errors, if any produced when processing the job

warnings

ErrorWarningMessages[]

Warnings, if any produced when processing the job

Job Output

Job output information

TableSchema

format

Output format

String,null

Reality Data Id of the output

Job Settings

High-level job settings

TableSchema

quality

Quality of the job

processingEngines

Integer

Maximum usable engines for the job

outputs

jobOutput[]

List of outputs of the job

cacheSettings

Cache settings for the job

Job

Job information

TableSchema

String

Job unique id

name

String

Job name

type

Object

Job type among 'Full', 'Calibration' and 'Reconstruction'

state

Object

Job current state

createdDateTime

Date-time

Creation time of the job

lastModifiedDateTime

Date-time

Last modification date of the job

location

Object

Datacenter location of the job

iTwinId

String

Project Id

workspaceId

String

Workspace id relative to the job

String

User email address

executionInformation

execInfo

Execution information relative to the job

inputs

jobInput[]

List of inputs for the job

jobSettings

Job settings

costEstimationParameters

Parameters to be used to estimate the cost of the job

estimatedCost

Number

Estimated Cost of the job using the CostEstimationParameters

Job response

TableSchema

job

Complete job details

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

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.

TableSchema

error

Error

Error information.