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

GET https://dev-api.bentley.com/reality-analysis/jobs/{id}/messages

Retrieve job messages.

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.v2+json is recommended.

Response 200 OK

json

{
    "messages": {
        "errors": [{
            "code": "InputData_Invalid",
            "message": "Invalid input data. Please check the documentation. (\"%1\")",
            "title": "Invalid input data",
            "params": ["Scene"]
        }],
        "warnings": []
    }
}

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

messages

JobMessages

Job Messages.

json

{
    "title": "Job Messages Response",
    "type": "object",
    "properties": {
        "messages": {
            "$ref": "#/components/schemas/JobMessages",
            "description": "Job Messages."
        }
    },
    "required": [
        "messages"
    ],
    "additionalProperties": false
}

Job Messages

List of errors or warnings.

errors

JobMessage[]

List of potential errors from the job execution.

warnings

JobMessage[]

List of potential warnings from the job execution.

json

{
    "title": "Job Messages",
    "description": "List of errors or warnings.",
    "type": "object",
    "properties": {
        "errors": {
            "description": "List of potential errors from the job execution.",
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/JobMessage"
            }
        },
        "warnings": {
            "description": "List of potential warnings from the job execution.",
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/JobMessage"
            }
        }
    },
    "required": [
        "errors",
        "warnings"
    ],
    "additionalProperties": false
}

Job Message

Details of an error or a warning message.

code

String

Unique identifier for the error or warning.

title

String

Title of the error or warning.

message

String

Message of the error or warning.

params

String[]

Parameters to be placed in the message. Can be used for localization effort.

json

{
    "title": "Job Message",
    "description": "Details of an error or a warning message.",
    "type": "object",
    "properties": {
        "code": {
            "description": "Unique identifier for the error or warning.",
            "type": "string"
        },
        "title": {
            "description": "Title of the error or warning.",
            "type": "string"
        },
        "message": {
            "description": "Message of the error or warning.",
            "type": "string"
        },
        "params": {
            "description": "Parameters to be placed in the message. Can be used for localization effort.",
            "type": "array",
            "items": {
                "type": "string"
            }
        }
    },
    "required": [
        "code",
        "title",
        "message",
        "params"
    ],
    "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?