Get job progress - 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 job progress

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

Retrieve job progress.

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.

Response 200 OK

json

{
    "progress": {
        "percentage": 56,
        "state": "active",
        "step": "Convert_Files"
    }
}

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": "ProgressNotFound",
        "message": "Requested progress is not available."
    }
}

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

Progress state

Current job state. Possible values are among 'unsubmitted', 'active', 'success', 'failed' or 'cancelled'.

unsubmitted

String

active

String

success

String

failed

String

cancelled

String

json

{
    "type": "string",
    "enum": [
        "unsubmitted",
        "active",
        "success",
        "failed",
        "cancelled"
    ],
    "description": "Current job state. Possible values are among 'unsubmitted', 'active', 'success', 'failed' or 'cancelled'.",
    "title": "Progress state"
}

Progress

Job progress information

percentage

Double

Job progress percentage.

Progress state

progress-state

Current job state. Possible values are among 'unsubmitted', 'active', 'success', 'failed' or 'cancelled'.

step

String

Current job step

json

{
    "title": "Progress",
    "description": "Job progress information",
    "type": "object",
    "properties": {
        "percentage": {
            "description": "Job progress percentage.",
            "type": "number",
            "format": "double"
        },
        "state": {
            "type": "string",
            "enum": [
                "unsubmitted",
                "active",
                "success",
                "failed",
                "cancelled"
            ],
            "description": "Current job state. Possible values are among 'unsubmitted', 'active', 'success', 'failed' or 'cancelled'.",
            "title": "Progress state",
            "$ref": "#/components/schemas/progress-state"
        },
        "step": {
            "type": "string",
            "description": "Current job step"
        }
    },
    "additionalProperties": false
}

Progress response

progress

Progress details

json

{
    "title": "Progress response",
    "type": "object",
    "properties": {
        "progress": {
            "$ref": "#/components/schemas/progress",
            "description": "Progress details"
        }
    },
    "required": [
        "progress"
    ],
    "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

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",
    "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?