Create Mapping - Grouping and Mapping

REST API Overview

Overview

Samples

Reference

Changelog

Grouping and Mapping

Download API definition:

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

Create Mapping

POST https://qa-api.bentley.com/grouping-and-mapping/datasources/imodel-mappings

Creates a mapping for an iModel. There are two ways to create a mapping.

Create an empty mapping

To create an empty mapping do not provide the sourceMappingId property. This will create a new mapping that does not have any groups.

Create a mapping from an existing mapping

To create a mapping from another mapping provide the sourceMappingId property. The server will create a new mapping and copy over all of the groups with their properties from the mapping referenced by the sourceMappingId property. User must have imodels_read permissions to the iModel containing the source mapping. Changing source mapping, groups, or their properties will not change the copies of them.

Provided mappingName, description, extractionEnabled request body properties will overwrite the properties on the copied 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_write 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.

Extraction Triggers & Configuration

Mappings can be configured with extractionEnabled set to true or false. true means that extractions will be automatically executed for the given mapping when a ChangesetGroup is completed (see ChangesetGroupCompletedEvent). Note: Multiple ChangesetGroups can be completed for a single Synchronization job which will result in multiple automatic extractions.

If extractionEnabled is set to false, the automatic extractions are disabled. However, extractions can still be executed for a specific mapping manually using the Run Extraction operation and the mappings request body parameter. To have a better control over extractions, it is recommended to set extractionEnabled to false and manually trigger an extraction when a mapping's extracted data is stale and needs to be refreshed.

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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

MappingCreate (CopyMapping)

iModelId

String

Yes

Id of the iModel for which to create a new mapping.

mappingName

String

Yes

Name of the mapping (OData v4 SimpleIdentifier).

description

String, null

Description of the mapping. The default value is empty string.

extractionEnabled

Boolean, null

Value of false excludes the mapping from the Run Extraction operation and automatic Data Extraction execution after new changes to the iModel are ready to be processed. If the Run Extraction operation is executed using the optional mappings parameter, the value of extractionEnabled will be treated as true for all specified Mappings. The default value is false.

sourceMappingId

String, null

Id of a mapping to copy. Copying a mapping will cause all of its groups and properties to be copied to the target iModel.

Example

json

{
    "iModelId": "70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a",
    "mappingName": "Mapping_name",
    "description": "This will overwrite the description when copying a mapping.",
    "sourceMappingId": "f1fe5959-35ab-467e-83b8-a679b722d80f"
}

MappingCreate (CreateMapping)

iModelId

String

Yes

Id of the iModel for which to create a new mapping.

mappingName

String

Yes

Name of the mapping (OData v4 SimpleIdentifier).

description

String, null

Description of the mapping. The default value is empty string.

extractionEnabled

Boolean, null

sourceMappingId

String, null

Id of a mapping to copy. Copying a mapping will cause all of its groups and properties to be copied to the target iModel.

Example

json

{
    "iModelId": "70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a",
    "mappingName": "Mapping_name",
    "description": "Mapping schema for iModel",
    "extractionEnabled": false
}

Response

Response 201 Created

json

{
    "mapping": {
        "id": "f1fe5959-35ab-467e-83b8-a679b722d80f",
        "mappingName": "Mapping_name",
        "description": "Mapping schema for iModel",
        "extractionEnabled": true,
        "createdOn": "2021-09-03T10:48:45+00:00",
        "createdBy": "john.doe@example.com",
        "modifiedOn": "2022-01-10T13:44:56+00:00",
        "modifiedBy": "john.doe@example.com",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a"
            }
        }
    }
}

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 403 Forbidden

User is not authorized to create a Mapping.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

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 create Mapping.",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided 'iModelId' value is not valid. Requested iModel is not available.",
            "target": "iModelId"
        }]
    }
}

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

Mapping

Defines a mapping for an iModel. Each mapping represents a collection of 'Groups'.

String

The mapping Id.

mappingName

String

Name of the mapping (OData v4 SimpleIdentifier).

description

String

Description of the mapping.

extractionEnabled

Boolean

createdOn

Date-time

Date when the mapping was created.

createdBy

Email of the user who created the mapping.

modifiedOn

Date-time

Date when the mapping was last modified.

modifiedBy

Email of the user who last modified the mapping.

_links

MappingLinks

Contains contextual hyperlinks to related data.

Mapping Links

Hyperlinks to related data which complements this entity.

iModel

Link

Link to retrieve the related iModel.

Mapping (create)

Properties of the mapping to be created.

iModelId

String

Id of the iModel for which to create a new mapping.

mappingName

String

Name of the mapping (OData v4 SimpleIdentifier).

description

String, null

Description of the mapping. The default value is empty string.

extractionEnabled

Boolean, null

sourceMappingId

String, null

Id of a mapping to copy. Copying a mapping will cause all of its groups and properties to be copied to the target iModel.

Mapping response

Container for a mapping object.

mapping

Mapping

Mapping properties.

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

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.

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.