Populate Federation Guids - Transformations

Transformations

Download API definition:

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

post https://qa-api.bentley.com/transformations/configurations/populate-federation-guids

This endpoint is used to create a configuration for a Populate Federation Guids transformation.

Populate Federation Guids transformation creates a new FederationGuid property value on elements that currently have FederationGuid value set to null.

This transformation is useful in iModel Forking scenarios when iModel fork creation in iModels API fails with sourceIsMissingFederationGuids state. After Populate Federation Guids transformation is run on the source iModel subsequent "Fork iModel" operations will succeed.

Note: Creating a configuration does not run the transformation. To run the transformation, please see transformations reference.

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

You must have imodels_write assigned for the iModel within related configuration. 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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Create PopulateFederationGuids configuration

name

String

Yes

User friendly name of the transformation.

iModelId

String

Yes

ID of the iModel.

changesetDescription

String

Yes

Description for the changeset created after transformation.

Example

json

{
    "name": "Example name",
    "iModelId": "00000000-0000-0000-0000-000000000000",
    "changesetDescription": "Example description"
}

Response

Response 201 Created

Returns the created configuration.

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Transformation name",
        "changesetDescription": "Example description",
        "createdDateTime": "2021-08-02T02:51:33.0000000+00:00",
        "modifiedDateTime": "2021-08-02T02:52:33.0000000+00:00",
        "transformType": "PopulateFederationGuids",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            }
        }
    }
}

Response 400 Bad Request

Given data is invalid.

json

{
    "error": {
        "code": "MissingRequestBody",
        "message": "Request body was not provided."
    }
}

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 has insufficient permissions.

json

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

Response 422 Unprocessable Entity

The referenced iModel does not exist.

json

{
    "error": {
        "code": "InvalidTransformationsRequest",
        "message": "Cannot create Configuration.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "User is missing permission 'Read' to iModel '00000000-0000-0000-0000-000000000000'.",
            "target": "iModelId"
        }]
    }
}

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
}

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
}

Single iModel Configuration Links

iModel

Link

json

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

Populate Federation Guids configuration properties transformType

Type of the transformation.

PopulateFederationGuids

String

json

{
    "enum": [
        "PopulateFederationGuids"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Populate Federation Guids configuration properties transformType"
}

Populate Federation Guids configuration properties

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_SingleIModelConfigurationData

Populate Federation Guids configuration properties transformType

Configuration_PopulateFederationGuids-transformType

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Populate Federation Guids configuration properties",
    "required": [
        "id",
        "name",
        "changesetDescription",
        "createdDateTime",
        "modifiedDateTime",
        "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_SingleIModelConfigurationData"
        },
        "transformType": {
            "enum": [
                "PopulateFederationGuids"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Populate Federation Guids configuration properties transformType",
            "$ref": "#/components/schemas/Configuration_PopulateFederationGuids-transformType"
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z",
            "description": "Time the configuration was created at."
        },
        "modifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z",
            "description": "Time the configuration was last modified at."
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "additionalProperties": false
}

Create PopulateFederationGuids configuration

Data needed to create PopulateFederationGuids configuration.

name

String

User friendly name of the transformation.

iModelId

String

ID of the iModel.

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Create PopulateFederationGuids configuration",
    "required": [
        "changesetDescription",
        "iModelId",
        "name"
    ],
    "properties": {
        "name": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "iModelId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the iModel."
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Data needed to create PopulateFederationGuids configuration.",
    "additionalProperties": false
}

Populate Federation Guids configuration

configuration

Configuration_PopulateFederationGuids

json

{
    "type": "object",
    "title": "Populate Federation Guids configuration",
    "required": [
        "configuration"
    ],
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/Configuration_PopulateFederationGuids"
        }
    },
    "additionalProperties": false
}

Was this page helpful?