Get Diagnostic Reports - Synchronization

Synchronization

Download API definition:

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

GET https://api.bentley.com/synchronization/reports?imodelId&runId[&taskId]

Retrieves a Synchronization diagnostic report for a task or a run, that enables users to trouble shoot data related problems. It can be easily visualized by react component https://www.npmjs.com/package/@itwin/synchronization-report-react.

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

imodelId

Yes

IModel Id

runId

Yes

Run Id

taskId

Task 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

Response 200 OK

json

{
    "reports": [{
        "id": "sDqQVHVsukGk7iM6qgMM1lSUJ4mVOB5Fi9PnWyA1HfU",
        "imodelId": "54903ab0-6c75-41ba-a4ee-233aaa030cd6",
        "runId": "89279454-3895-451e-8bd3-e75b20351df5",
        "taskId": "89279454-3895-451e-8bd3-e75b20351df5",
        "sasUri": "https://example.blob.core.windows.net/",
        "createdTimeStamp": "2024-09-04T10:25:48Z"
    }]
}

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 422 Unprocessable Entity

Invalid request to get diagnostic reports.

json

{
    "error": {
        "code": "InvalidBadgersRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "MissingRequiredProperty",
                "message": "iModelId should be provided.",
                "target": "iModelId"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "runId should be provided.",
                "target": "runId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided iModelId value is not valid.",
                "target": "iModelId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided runId value is not valid.",
                "target": "runId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided taskId value is not valid.",
                "target": "taskId"
            }
        ]
    }
}

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

Diagnostic Reports

reports

diagnostic-report[]

A set of diagnostic report entities.

json

{
    "title": "Diagnostic Reports",
    "type": "object",
    "properties": {
        "reports": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/diagnostic-report"
            },
            "description": "A set of diagnostic report entities."
        }
    },
    "additionalProperties": false
}

diagnostic-report

String

Diagnostic report id.

imodelId

String

iModel id.

runId

String

Run id.

taskId

String

Task id.

sasUri

String

Sas Uri for the report.

createdTimeStamp

String

A timestamp when diagnostic report was created.

json

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Diagnostic report id."
        },
        "imodelId": {
            "type": "string",
            "description": "iModel id."
        },
        "runId": {
            "type": "string",
            "description": "Run id."
        },
        "taskId": {
            "type": "string",
            "description": "Task id."
        },
        "sasUri": {
            "type": "string",
            "description": "Sas Uri for the report."
        },
        "createdTimeStamp": {
            "type": "string",
            "description": "A timestamp when diagnostic report was created."
        }
    },
    "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?