Get Extraction Status - Reporting

Reporting

Download API definition:

Get Extraction Status

GET https://api.bentley.com/insights/reporting/datasources/extraction/status/{jobId}

Gets the Status of an Extraction Run.

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.

Authorization

User must have imodels_read permission(s) assigned at the Project level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project or iModel.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request

Request parameters

jobId

Yes

Unique Identifier of the Extraction Run.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

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

Response

Response 200 OK

Retrieved status of Extraction Run successfully.

json

{
    "status": {
        "state": "Succeeded",
        "reason": "Completed",
        "containsIssues": true,
        "_links": {
            "logs": {
                "href": "https://api.bentley.com/insights/reporting/datasources/extraction/status/40f71ed2-31a3-45d3-bce0-5c9f3f112c03/logs"
            }
        }
    }
}

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

Specified ExtractionStatus was not found.

json

{
    "error": {
        "code": "ExtractionStatusNotFound",
        "message": "Requested ExtractionStatus is not available.",
        "target": "jobId"
    }
}

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "title": "Link",
    "type": "object",
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false
}

Extraction Status

Status of the specified Extraction Run.

status.state

String

Current state of the Extraction Run - 'Running', 'Succeeded', or 'Failed'.

status.reason

String

Additional justification for the current state of the Extraction Run.

status.containsIssues

Boolean

If Extraction Log contains an issue, this is marked as true.

status._links.logs

Link

URL pointing to the related Report.

json

{
    "title": "Extraction Status",
    "type": "object",
    "description": "Status of the specified Extraction Run.",
    "properties": {
        "status": {
            "type": "object",
            "description": "Extraction Status properties.",
            "properties": {
                "state": {
                    "type": "string",
                    "description": "Current state of the Extraction Run - 'Running', 'Succeeded', or 'Failed'."
                },
                "reason": {
                    "type": "string",
                    "description": "Additional justification for the current state of the Extraction Run."
                },
                "containsIssues": {
                    "type": "boolean",
                    "description": "If Extraction Log contains an issue, this is marked as true."
                },
                "_links": {
                    "type": "object",
                    "description": "Contains contextual hyperlinks to related data.",
                    "properties": {
                        "logs": {
                            "$ref": "#/components/schemas/Link",
                            "description": "URL pointing to the related Report."
                        }
                    }
                }
            }
        }
    },
    "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?