Get Mapping Extractions - 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/{mappingId}/extractions[?$top][&$continuationToken]

Gets a list of extractions executed on a mapping.

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

mappingId

Yes

The mapping 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

{
    "extractions": [{
        "extractionId": "d4ca244b-81c8-4146-934d-e5936345bba2",
        "extractionTimestamp": "2023-01-10T13:44:56+00:00",
        "changesetIndex": 5,
        "mappingTimestamp": "2022-01-10T13:44:56+00:00",
        "_links": {
            "cdm": {
                "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/f1fe5959-35ab-467e-83b8-a679b722d80f/extractions/d4ca244b-81c8-4146-934d-e5936345bba2/cdm"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/f1fe5959-35ab-467e-83b8-a679b722d80f/extractions?$top=100&$continuationToken=ddac51e3-3d37-4407-816e-52b9fc80d70a"
        },
        "self": {
            "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/f1fe5959-35ab-467e-83b8-a679b722d80f/extractions?$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 Mapping was not found.

json

{
    "error": {
        "code": "MappingNotFound",
        "message": "Requested Mapping is not available.",
        "target": "mappingId"
    }
}

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 Mapping Extractions.",
        "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

Mapping Extractions response

Collection of mapping extractions.

extractions

MappingExtraction[]

List of mapping extractions.

_links

PagedResponseLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Mapping Extractions response",
    "type": "object",
    "description": "Collection of mapping extractions.",
    "properties": {
        "extractions": {
            "type": "array",
            "description": "List of mapping extractions.",
            "items": {
                "$ref": "#/components/schemas/MappingExtraction"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "required": [
        "extractions",
        "_links"
    ],
    "additionalProperties": false
}

Mapping Extraction

Information about a completed extraction of a mapping.

extractionId

String

The extraction Id.

extractionTimestamp

Date-time

End time of the extraction.

changesetIndex

Int64

Index of the iModel Changeset that the mapping was extracted from.

mappingTimestamp

Date-time

Time of last modification done to the mapping before it was extracted.

_links

MappingExtractionLinks

Contains contextual hyperlinks to related data.

json

{
    "title": "Mapping Extraction",
    "type": "object",
    "description": "Information about a completed extraction of a mapping.",
    "properties": {
        "extractionId": {
            "type": "string",
            "description": "The extraction Id."
        },
        "extractionTimestamp": {
            "type": "string",
            "description": "End time of the extraction.",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z"
        },
        "changesetIndex": {
            "type": "integer",
            "format": "int64",
            "description": "Index of the iModel Changeset that the mapping was extracted from."
        },
        "mappingTimestamp": {
            "type": "string",
            "description": "Time of last modification done to the mapping before it was extracted.",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z"
        },
        "_links": {
            "$ref": "#/components/schemas/MappingExtractionLinks",
            "description": "Contains contextual hyperlinks to related data."
        }
    },
    "required": [
        "extractionId",
        "extractionTimestamp",
        "changesetIndex",
        "mappingTimestamp"
    ],
    "additionalProperties": false
}

Mapping Extraction Links

Hyperlinks to related data which complements this entity.

cdm

Link

Link to retrieve the Common Data Model.

json

{
    "title": "Mapping Extraction Links",
    "type": "object",
    "description": "Hyperlinks to related data which complements this entity.",
    "properties": {
        "cdm": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve the Common Data Model."
        }
    },
    "required": [
        "cdm"
    ],
    "additionalProperties": false
}

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

Paged Response Links

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

Link, null

URL to get the next page of results.

self

Link

URL to repeat the current request.

json

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

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

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

Detailed 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

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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?