• Get Started
  • Documentation
  • Samples
  • Blog
  • Pricing
    • Table of contents
    Overview
    Context Scenes
    Context Scenes version 5
    Context Detectors
    Job types
    Tutorials
    Samples
    Changelog
    Reality Analysis
    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/realitydataanalysis/jobs/{jobId}/progress

    Retrieve job progress.

    Parameters

    The job id

    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 itwin-platform.

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

    Request

    Request parameters

    Name
    Required?
    Description
    jobId
    Yes

    Request headers

    Name
    Required?
    Description
    Authorization
    Yes

    OAuth access token with itwin-platform scope

    Accept
    Yes

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

    Response

    Response 200 OK

    OK

    json
    {
    "progress": {
        "percentage": 56,
        "state": "active",
        "step": "Prepare_Production"
    }
}

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

    Name
    Description
    retry-after

    Number of seconds to wait until client is allowed to make more requests.

    Definitions

    Job state

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

    Name
    Type
    Description
    unsubmitted
    String
    active
    String
    success
    String
    failed
    String
    cancelled
    String

    Progress

    Job progress information

    Name
    Type
    Description
    percentage
    Double

    Job progress percentage.

    state
    state

    Current job state

    step
    String

    Current job step

    Progress response

    Name
    Type
    Description
    progress
    progress

    Progress details

    Error

    Contains error information.

    Name
    Type
    Description
    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.

    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.

    Name
    Type
    Description
    error
    Error

    Error information.