Get job progress - Reality Analysis

Reality Analysis

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/reality-analysis/jobs/{id}/progress

Retrieve job progress.

Remarks

The job progression is deemed valid when the job is active and won't be available after 30 days.

User should query with backoff intervals of 15, 30, 60, 120 seconds. The interval between the first and second query is 15 seconds and then 30 seconds. If the percentage changes the sequence is restarted.

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

Yes

Job id

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "progress": {
        "percentage": 5,
        "state": "Active"
    }
}

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

This response indicates that the specified job progress was not found.

json

{
    "error": {
        "code": "JobProgressNotFound",
        "message": "Requested job 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

Job State

Job current state.

Queued

String

Active

String

Terminating

String

Cancelled

String

Failed

String

Success

String

json

{
    "title": "Job State",
    "description": "Job current state.",
    "enum": [
        "Queued",
        "Active",
        "Terminating",
        "Cancelled",
        "Failed",
        "Success"
    ],
    "type": "string"
}

Job Progress Response

progress

JobProgress

Job progression details.

json

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

Job Progress

Job progress percentage and job state.

percentage

Number

Job progress percentage.

state

JobState

Job current state.

json

{
    "title": "Job Progress",
    "description": "Job progress percentage and job state.",
    "type": "object",
    "properties": {
        "percentage": {
            "type": "number",
            "description": "Job progress percentage."
        },
        "state": {
            "description": "Job current state.",
            "$ref": "#/components/schemas/JobState"
        }
    },
    "required": [
        "percentage",
        "state"
    ],
    "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?