Get Extraction Logs - Grouping and Mapping

Grouping and Mapping

Download API definition:

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

get https://dev-api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/extractions/{extractionId}/logs[?$top][&$continuationToken]

Gets the logs of an extraction.

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 iTwin 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 iTwin 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

extractionId

Yes

The extraction Id.

$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

json

{
    "logs": [{
        "state": "Succeeded",
        "dateTime": "2022-09-10T13:44:56.0000000+00:00",
        "contextType": "IModel",
        "contextId": "70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a",
        "level": "Information",
        "category": "StateChange",
        "message": "Completed."
    }, {
        "state": "Running",
        "dateTime": "2022-09-10T13:43:56.0000000+00:00",
        "contextType": "IModel",
        "contextId": "70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a",
        "level": "Information",
        "category": "StateChange",
        "message": "Not completed yet."
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/extractions/40f71ed2-31a3-45d3-bce0-5c9f3f112c03/logs?$top=2&$continuationToken=ddac51e3-3d37-4407-816e-52b9fc80d70a"
        },
        "self": {
            "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/extractions/40f71ed2-31a3-45d3-bce0-5c9f3f112c03/logs?$top=2"
        }
    }
}

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 was not found.

json

{
    "error": {
        "code": "ExtractionNotFound",
        "message": "Requested Extraction is not available.",
        "target": "extractionId"
    }
}

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": "InvalidGroupingAndMappingRequest",
        "message": "Cannot retrieve Extraction logs.",
        "details": [{
            "code": "InvalidParameter",
            "message": "Provided '$top' query parameter value is not valid. A single value must be provided.",
            "target": "$top"
        }]
    }
}

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",
    "required": [
        "href"
    ],
    "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
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "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."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "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 entry

A single extraction log entry.

level

String

Level of the log entry. One of 'Information', 'Warning', 'Error'.

state

String

State of the extraction at the point when this log entry was created. One of 'Queued', 'Running', 'Succeeded', 'PartiallySucceeded', 'Failed'.

message

String

Message of the log entry.

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",
    "required": [
        "self"
    ],
    "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
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError",
            "description": "Error Detailed 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 logs response

Collection of extraction logs.

logs

ExtractionLogEntry[]

List of extraction logs.

_links

PagedResponseLinks

json

{
    "type": "object",
    "title": "Extraction logs response",
    "required": [
        "logs",
        "_links"
    ],
    "properties": {
        "logs": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ExtractionLogEntry"
            },
            "description": "List of extraction logs."
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks"
        }
    },
    "description": "Collection of extraction logs.",
    "additionalProperties": false
}

Was this page helpful?