PopulateFederationGuids - Transformations

Transformations

Download API definition:

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

POST https://dev-api.bentley.com/transformations/configurations/populatefederationguids

This endpoint is used to create a configuration for a PopulateFederationGuids 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 at the project level within related configuration. If permissions at the project level are not configured, then you must have same assigned at the iModel level.

Alternatively, you must be an Organization Administrator for the Organization that owns a given project the iModel belongs to.

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 see Bentley Communities Licensing, Cloud, and Web Services wiki page.

Important: Populate Federation Guids transformation is in closed preview mode currently and only selected applications can utilize it.

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.v1+json is recommended.

Configuration data

Request body

Create PopulateFederationGuids configuration

transformName

String

Yes

User friendly name of the transformation.

projectId

String

Yes

ProjectId of the iModel.

iModelId

String

Yes

ID of the iModel.

comment

String

Yes

Comment for the changeset created after transformation.

Example

json

{
    "transformName": "Example name",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "iModelId": "00000000-0000-0000-0000-000000000000",
    "comment": "Example comment"
}

Response

Response 201 Created

Returns the created configuration.

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "transformName": "Transformation name",
        "comment": "comment",
        "createdDateTime": "2021-08-02T14:51:33.6133333Z",
        "modifiedDateTime": "2021-08-02T14:52:33.6133333Z",
        "transformType": "PopulateFederationGuids",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            },
            "project": {
                "href": "https://api.bentley.com/itwins/00000000-0000-0000-0000-000000000000"
            }
        }
    }
}

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 404 Not Found

This response indicates that the provided Project or iModel could not be found.

json

{
    "error": {
        "code": "IModelNotFound",
        "message": "Requested IModel is not available."
    }
}

Response 422 Unprocessable Entity

Given data is invalid.

json

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

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

Create PopulateFederationGuids configuration

Data needed to create PopulateFederationGuids configuration.

transformName

String

User friendly name of the transformation.

projectId

String

ProjectId of the iModel.

iModelId

String

ID of the iModel.

comment

String

Comment for the changeset created after transformation.

json

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

Populate Federation Guids configuration

configuration

Configuration_PopulateFederationGuids

Populate Federation Guids configuration object.

json

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

Populate Federation Guids configuration properties

String

ID of the configuration.

transformName

String

User friendly name of the transformation.

comment

String, null

Comment for the changeset created after transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformType

String

Type of the transformation.

_links

Links_SingleIModelConfigurationData

Links to a configuration data.

json

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

Single iModel Configuration Links

iModel

Link

Link to an iModel.

project

Link

Link to a project.

json

{
    "type": "object",
    "title": "Single iModel Configuration Links",
    "properties": {
        "iModel": {
            "description": "Link to an iModel.",
            "$ref": "#/components/schemas/Link"
        },
        "project": {
            "description": "Link to a project.",
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Link

href

String

Link to a resource.

json

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