Get All Configurations - Transformations

Transformations

Download API definition:

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

get https://qa-api.bentley.com/transformations/configurations[?targetIModelId][&targetITwinId][&$top][&$skip]

This endpoint is used to query a list of configuration entities associated to a target iModel or it's iTwin. One of the parameters targetIModelId or targetITwinId must be provided.

Note: Get all configurations endpoint doesn't return a full configuration response and to get all of configuration's data Get Configuration must be called.

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.

You must have imodels_read assigned for the target iModel within related configuration or be an Organization Administrator for the Organization that owns target iModel's iTwin. You can check iModel permissions here.

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

targetIModelId

Target iModel ID of the configurations.

targetITwinId

Target iTwin ID of the configurations.

$top

The $top query option requests the number of items in the queried collection to be included in the result. E.g. to return only first collection item provide the following query: $top=1. When $top parameter is not provided default is set to 100. $top value cannot exceed 1000.

$skip

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result. E.g. to return items from the collection starting at the third place provide the following query: $skip=2.

Request headers

Prefer

Indicates a level of details in the response.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

Returns configurations for the given target iModel Id.

json

{
    "configurations": [{
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Transformation Name",
        "transformType": "ImportIModel",
        "_links": {
            "targetIModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            },
            "sourceIModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000001"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/transformations/configurations?targetIModelId=00000000-0000-0000-0000-000000000000&skip=100&top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/transformations/configurations?targetIModelId=00000000-0000-0000-0000-000000000000&skip=100&top=100"
        },
        "next": {
            "href": "https://api.bentley.com/transformations/configurations?targetIModelId=00000000-0000-0000-0000-000000000000&skip=200&top=100"
        }
    }
}

Response 400 Bad Request

The request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidTransformationsRequest",
        "message": "Cannot get Configurations.",
        "details": [{
            "code": "MissingRequiredParameter",
            "message": "Required parameter is missing.",
            "target": "targetIModelId"
        }, {
            "code": "InvalidParameter",
            "message": "'{number}' is not a valid '{$top/$skip}' value.",
            "target": "{$top/$skip}"
        }]
    }
}

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

href

String

Link to a resource.

json

{
    "type": "object",
    "title": "Link",
    "properties": {
        "href": {
            "type": "string",
            "description": "Link to a resource."
        }
    },
    "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
}

Pagination links

Link

self

Link

json

{
    "type": "object",
    "title": "Pagination links",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "$ref": "#/components/schemas/Link"
        },
        "self": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "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
}

Minimal configuration

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_Configuration_Minimal_Single

transformType

String

Type of the transformation.

json

{
    "type": "object",
    "title": "Minimal configuration",
    "required": [
        "id",
        "name",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "name": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_Configuration_Minimal_Single"
        },
        "transformType": {
            "type": "string",
            "example": "ImportIModel",
            "description": "Type of the transformation."
        }
    },
    "additionalProperties": false
}

Configurations (prefer return=minimal)

List of Configurations in minimal representation.

_links

Links_PagedResponse

configurations

Configuration_Minimal_Single[]

List of Configurations in minimal representation.

json

{
    "type": "object",
    "title": "Configurations (prefer return=minimal)",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/Links_PagedResponse"
        },
        "configurations": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Configuration_Minimal_Single"
            },
            "description": "List of Configurations in minimal representation."
        }
    },
    "description": "List of Configurations in minimal representation.",
    "additionalProperties": false
}

Minimal Configuration Links

sourceIModel

Link

targetIModel

Link

json

{
    "type": "object",
    "title": "Minimal Configuration Links",
    "properties": {
        "sourceIModel": {
            "$ref": "#/components/schemas/Link"
        },
        "targetIModel": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Was this page helpful?