Get All Configurations - Transformations

Transformations

Download API definition:

GET https://qa-api.bentley.com/transformations/configurations?projectId={projectId}[&$top][&$skip]

This endpoint is used to query a list of configuration entities.

To get full configuration entities in a list set prefer header to return=representation.

Note: when return=representation is used, the type on entities returned in configurations array is a union of different configuration types. Configuration type is denoted by transformType property. API consumers should expect that new configuration types will added in the future. New configurations may have a different schema than the ones that currently exist so array items should be deserialized based on transformType.

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.

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

projectId

Yes

Source or target project 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.v1+json is recommended.

Response

Response 200 OK

Returns configurations for the given project ID. If prefer header is not set, API will treat it as `return=minimal`.

json

{
    "configurations": [{
        "id": "00000000-0000-0000-0000-000000000000",
        "transformName": "Transformation Name"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/transformations/configurations?projectId=00000000-0000-0000-0000-000000000000&skip=100&top=100"
        },
        "prev": {
            "href": "https://api.bentley.com/transformations/configurations?projectId=00000000-0000-0000-0000-000000000000&skip=100&top=100"
        },
        "next": {
            "href": "https://api.bentley.com/transformations/configurations?projectId=00000000-0000-0000-0000-000000000000&skip=200&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 422 Unprocessable Entity

Invalid request to get all configurations.

json

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

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

Configurations (prefer return=minimal)

List of Configurations in minimal representation.

configurations

Configuration_Minimal_Single[]

List of Configurations in minimal representation.

_links

Links_PagedResponse

json

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

Minimal configuration

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

json

{
    "title": "Minimal configuration",
    "required": [
        "id",
        "transformName"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "ID of the configuration.",
            "example": "00000000-0000-0000-0000-000000000000"
        },
        "transformName": {
            "type": "string",
            "description": "User friendly name of the transformation.",
            "example": "Example name"
        }
    },
    "additionalProperties": false
}

Pagination links

self

Link

json

{
    "title": "Pagination links",
    "type": "object",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link"
        },
        "prev": {
            "$ref": "#/components/schemas/Link"
        },
        "next": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Link

href

String

Link to a resource.

json

{
    "title": "Link",
    "type": "object",
    "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.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "required": [
        "code",
        "message"
    ],
    "type": "object",
    "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
        }
    },
    "description": "Contains error information."
}

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

json

{
    "title": "Error Response",
    "required": [
        "error"
    ],
    "type": "object",
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error"
        }
    },
    "additionalProperties": false,
    "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."
}

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

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

Detailed Error Response

error

DetailedError

json

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

Was this page helpful?