Get Extraction Logs - Reporting

Reporting

Download API definition:

get https://dev-api.bentley.com/insights/reporting/datasources/extraction/status/{jobId}/logs[?$top][&$continuationToken]

Gets Logs 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.

"Try it out" Limitations

When you run an Extraction with the "Try it out" function on a Mapping that was created or modified by using the "Try it out" function, you are limited to 100 extracted rows for each group. Mapping modification is any POST/DELETE/PATCH/PUT request to any endpoint with the tag "Mappings" or if the URL contains {mappingId}.

Request

Request parameters

jobId

Yes

Unique Identifier of the Extraction Run.

$top

Optional max items to be sent in response.

$continuationToken

Optional token to retrieve next page in paginated response.

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

Retrieved Extraction Logs successfully.

json

{
    "logs": [{
        "state": "Running",
        "reason": "Not completed yet.",
        "dateTime": "2022-01-13T07:09:11.0000000+00:00",
        "jobId": "40f71ed2-31a3-45d3-bce0-5c9f3f112c03",
        "contextType": "IModel",
        "contextId": "adae0938-e15b-4394-a376-da32b79ee653",
        "level": "Warning",
        "category": "GroupQuery",
        "message": "iModel a5c26c0b-ae2b-43b8-b1ff-74399ce8e453 has 0 mappings.",
        "containsIssues": true
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/insights/reporting/datasources/extraction/status/40f71ed2-31a3-45d3-bce0-5c9f3f112c03/logs/?$top=100&$continuationToken=7a592cbb-2a66-43ce-a63f-60d8f75c55aa"
        },
        "self": {
            "href": "https://api.bentley.com/insights/reporting/datasources/extraction/status/40f71ed2-31a3-45d3-bce0-5c9f3f112c03/logs/?$top=100"
        }
    }
}

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 Extraction Logs were not found.

json

{
    "error": {
        "code": "ExtractionLogNotFound",
        "message": "Requested Extraction Log is not available.",
        "target": "jobId"
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

{
    "error": {
        "code": "InvalidInsightsRequest",
        "message": "Error message."
    }
}

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

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

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "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",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Extraction Log

Defines a single Extraction Log response.

jobId

String

Unique Identifier for the Extraction Run.

level

String

The level of an issue. If Extraction Log entity is not an issue it is marked as "Information".

state

String

The state of the Extraction at specific time.

reason

String

The Reason explaining why state has specific value.

message

String

Message which specifies why certain issue occured. If Extraction Log entity is not an issue Message is null.

category

String

The issue category. If Extraction Log entity is not an issue this is marked as "Unknown".

dateTime

String

Date when Extraction Log entity was created.

contextId

String

The Context Id.

contextType

String

The type of the contextId.

containsIssues

Boolean

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

json

{
    "type": "object",
    "title": "Extraction Log",
    "properties": {
        "jobId": {
            "type": "string",
            "description": "Unique Identifier for the Extraction Run."
        },
        "level": {
            "type": "string",
            "description": "The level of an issue. If Extraction Log entity is not an issue it is marked as \"Information\"."
        },
        "state": {
            "type": "string",
            "description": "The state of the Extraction at specific time."
        },
        "reason": {
            "type": "string",
            "description": "The Reason explaining why state has specific value."
        },
        "message": {
            "type": "string",
            "description": "Message which specifies why certain issue occured. If Extraction Log entity is not an issue Message is null."
        },
        "category": {
            "type": "string",
            "description": "The issue category. If Extraction Log entity is not an issue this is marked as \"Unknown\"."
        },
        "dateTime": {
            "type": "string",
            "description": "Date when Extraction Log entity was created."
        },
        "contextId": {
            "type": "string",
            "description": "The Context Id."
        },
        "contextType": {
            "type": "string",
            "description": "The type of the contextId."
        },
        "containsIssues": {
            "type": "boolean",
            "description": "If Extraction Log contains an issue, this is marked as true."
        }
    },
    "description": "Defines a single Extraction Log response.",
    "additionalProperties": false
}

Paged Response Links

URLs for redoing the current request and/or getting the next page of results if applicable.

Link

self

Link

json

{
    "type": "object",
    "title": "Paged Response Links",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "self": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable.",
    "additionalProperties": false
}

Extraction Log Collection

List of Extraction Logs.

logs

Extraction_Log[]

List of Extraction Logs.

_links

PagedResponseLinks

json

{
    "type": "object",
    "title": "Extraction Log Collection",
    "properties": {
        "logs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Extraction_Log"
            },
            "description": "List of Extraction Logs."
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks"
        }
    },
    "description": "List of Extraction Logs.",
    "additionalProperties": false
}

Was this page helpful?