Create ManifestConnection - Synchronization

Synchronization

Download API definition:

Create ManifestConnection

POST https://dev-api.bentley.com/synchronization/imodels/manifestconnections

Create a ManifestConnection that describes which files from a manifest will be synchronized to the iModel.

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.

Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a ManifestConnection.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Manifest Connection (create)

authenticationType

A type used for defining authorization workflow for this connection. Default is user.

displayName

String

A manifest connection display name.

iModelId

String

Yes

iModel id.

sourceFiles

manifest-file-create[]

Yes

Source files to be synchronized.

Example

json

{
    "displayName": "30",
    "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a",
    "authenticationType": "User",
    "sourceFiles": [{
        "sourceFileId": "t5bDFuN4qUa9ojVw1E5FGtldp8BgSbNCiJ2XMdiT-cA"
    }]
}

Response 201 Created

Connection successfully created.

json

{
    "connection": {
        "id": "MWplZe9Uf0iR1IDMqyOMLifv_1OzLIFLvYKsoxpfJfk",
        "displayName": "30",
        "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a",
        "iTwinId": "5fb9aa98-9874-4697-b942-d19728840f19",
        "authenticationType": "User",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/7dbd531d-6967-47b2-8945-a722a437ad7a"
            },
            "iTwin": {
                "href": "https://api.bentley.com/itwins/5fb9aa98-9874-4697-b942-d19728840f19"
            },
            "lastRun": {
                "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/MWplZe9Uf0iR1IDMqyOMLifv_1OzLIFLvYKsoxpfJfk/runs/de626d0d-1647-48d7-8c11-f1f74f2d4523"
            }
        }
    }
}

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

One or more SourceFiles are already mapped to the iModel.

json

{
    "error": {
        "code": "FileMappingToTheIModelAlreadyExists",
        "message": "One or more SourceFiles are already mapped to the iModel."
    }
}

Response 422 Unprocessable Entity

Invalid request to create connection. Request payload might be missing some of the required properties.

json

{
    "error": {
        "code": "InvalidManifestConnectionRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidRequestBody",
                "message": "Error parsing JSON, malformed JSON."
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to create or update a connection is missing.",
                "target": "sourceFiles"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "A property required to create or update a connection is missing.",
                "target": "sourceFileId"
            },
            {
                "code": "MissingRequiredProperty",
                "message": "imodelId was not provided.",
                "target": "imodelId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided imodelId value is not valid.",
                "target": "imodelId"
            },
            {
                "code": "InvalidValue",
                "message": "Provided sourceFileId value is not valid.",
                "target": "sourceFileId"
            }
        ]
    }
}

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

Manifest Connection

authenticationType

A type used for defining authorization workflow for this connection. Default is user.

String

Manifest connection id.

displayName

String

A manifest connection display name.

iModelId

String

iModel id.

iTwinId

String

iTwin id.

_links

connection-links

A set of links to iModel, iTwin, and the latest connection run.

json

{
    "title": "Manifest Connection",
    "type": "object",
    "properties": {
        "authenticationType": {
            "$ref": "#/components/schemas/authenticationType",
            "description": "A type used for defining authorization workflow for this connection. Default is user."
        },
        "id": {
            "type": "string",
            "description": "Manifest connection id."
        },
        "displayName": {
            "type": "string",
            "description": "A manifest connection display name."
        },
        "iModelId": {
            "type": "string",
            "description": "iModel id."
        },
        "iTwinId": {
            "type": "string",
            "description": "iTwin id."
        },
        "_links": {
            "$ref": "#/components/schemas/connection-links",
            "description": "A set of links to iModel, iTwin, and the latest connection run."
        }
    },
    "additionalProperties": false
}

Manifest connection response

connection

ManifestConnection

Manifest connection entity.

json

{
    "title": "Manifest connection response",
    "type": "object",
    "properties": {
        "connection": {
            "$ref": "#/components/schemas/ManifestConnection",
            "description": "Manifest connection entity."
        }
    },
    "additionalProperties": false
}

Manifest Connection (create)

authenticationType

A type used for defining authorization workflow for this connection. Default is user.

displayName

String

A manifest connection display name.

iModelId

String

iModel id.

sourceFiles

manifest-file-create[]

Source files to be synchronized.

json

{
    "title": "Manifest Connection (create)",
    "type": "object",
    "properties": {
        "authenticationType": {
            "$ref": "#/components/schemas/authenticationType",
            "description": "A type used for defining authorization workflow for this connection. Default is user."
        },
        "displayName": {
            "type": "string",
            "description": "A manifest connection display name."
        },
        "iModelId": {
            "type": "string",
            "description": "iModel id."
        },
        "sourceFiles": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/manifest-file-create"
            },
            "description": "Source files to be synchronized."
        }
    },
    "required": [
        "sourceFiles",
        "iModelId"
    ],
    "additionalProperties": false
}

Authentication Type

One of 'User' or 'Service'.

User

String

Service

String

json

{
    "title": "Authentication Type",
    "description": "One of 'User' or 'Service'.",
    "type": "string",
    "enum": [
        "User",
        "Service"
    ]
}

ManifestFile (create)

sourceFileId

String

Source file id.

json

{
    "title": "ManifestFile (create)",
    "type": "object",
    "properties": {
        "sourceFileId": {
            "type": "string",
            "description": "Source file id."
        }
    },
    "required": [
        "sourceFileId"
    ],
    "additionalProperties": false
}

Connection Links

iModel

Link

Link to iModel.

iTwin

Link

Link to iTwin.

lastRun

Link

Link to latest run for a connection.

json

{
    "title": "Connection Links",
    "type": "object",
    "properties": {
        "iModel": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to iModel."
        },
        "iTwin": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to iTwin."
        },
        "lastRun": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to latest run for a connection."
        }
    },
    "additionalProperties": false
}

Link

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "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

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",
    "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?

Authentication

Associated entities

Request

Request headers

Request body

Manifest Connection (create)

Example

Response

Response 201 Created

Response 401 Unauthorized

Response 409 Conflict

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Manifest Connection

Manifest connection response

Manifest Connection (create)

Authentication Type

ManifestFile (create)

Connection Links

Link

Error

Error Response