Get job progress - Reality Data Analysis

Reality Data Analysis

Download API definition:

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

GET https://qa-api.bentley.com/realitydataanalysis/jobs/{jobId}/progress

Retrieve job progress.

Remarks

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

Client should query with a backoff intervals [15,30,60,120] seconds. The interval between the first and second query is 15 sec and then 30 sec... If the percentage changes the sequence is restarted.

Authentication

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

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

Request headers

Authorization

Yes

OAuth access token with scope realitydataanalysis:read

Accept

No

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

Response 200 OK

OK

json

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

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": "Unauthorized",
        "message": "Access denied due to invalid access_token. Make sure to provide a valid token for this API endpoint."
    }
}

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 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

Job state

Possible state of a job among 'unsubmitted', 'active', 'success', 'failed' and 'cancelled'.

unsubmitted

String

active

String

success

String

failed

String

cancelled

String

json

{
    "title": "Job state",
    "enum": [
        "unsubmitted",
        "active",
        "success",
        "failed",
        "cancelled"
    ],
    "description": "Possible state of a job among 'unsubmitted', 'active', 'success', 'failed' and 'cancelled'."
}

Progress

Job progress information

percentage

Double

Job progress percentage.

state

Current job state

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": {
            "$ref": "#/components/schemas/state",
            "description": "Current job state"
        },
        "step": {
            "type": "string",
            "description": "Current job step"
        }
    }
}

Progress response

progress

Progress details

json

{
    "title": "Progress response",
    "type": "object",
    "properties": {
        "progress": {
            "$ref": "#/components/schemas/progress",
            "description": "Progress details"
        }
    },
    "required": [
        "progress"
    ]
}

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.code

String

One of a server-defined set of error codes.

error.message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "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": {
            "type": "object",
            "description": "The error object.",
            "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."
                }
            }
        }
    }
}

Error

Contains error information and an optional 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.

details

ErrorDetails[]

Optional array of more specific errors.

json

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

Error Details

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "title": "Error Details",
    "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."
        }
    },
    "required": [
        "code",
        "message"
    ]
}

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"
    ]
}

On this page

Was this page helpful?

Parameters

Remarks

Authentication

Request

Request parameters

Request headers

Response

Response 200 OK

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Job state

Progress

Progress response

error-response

Error

Error Details

Error Response