Get ManifestConnections - Synchronization

Synchronization

Download API definition:

GET https://api.bentley.com/synchronization/imodels/manifestconnections?imodelId[&$top][&$skip]

Retrieves Manifest Connections for the specified iModel.

Notes

The Prefer header can be used to specify how much result metadata is desired by the client. The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports "return=representation" and "return=minimal" preferences.

The "return=representation" preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. The "return=minimal" preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer header is not specified.

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.

Request

Request parameters

imodelId

Yes

iModel Id

$top

The $top system query option requests the number of items in the queried collection to be included in the result.

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

Request headers

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

json

{
    "connections": [{
        "id": "MWplZe9Uf0iR1IDMqyOMLry641hUCa9JjxI3cYz8uCg",
        "displayName": "30"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/synchronization/imodels/manifestconnections?iModelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=10&$top=10"
        },
        "prev": {
            "href": "https://api.bentley.com/synchronization/imodels/manifestconnections?iModelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=0&$top=10"
        },
        "next": {
            "href": "https://api.bentley.com/synchronization/imodels/manifestconnections?iModelId=7dbd531d-6967-47b2-8945-a722a437ad7a&$skip=20&$top=10"
        }
    }
}

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

This response indicates that the specified iModel was not found.

json

{
    "error": {
        "code": "ManifestConnectionNotFound",
        "message": "Requested iModelId is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get manifest connections.

json

{
    "error": {
        "code": "InvalidManifestConnectionRequest",
        "message": "Cannot perform operation.",
        "details": [{
                "code": "InvalidValue",
                "message": "Page size is over '50' items limit.",
                "target": "$top"
            },
            {
                "code": "InvalidValue",
                "message": "Provided imodelId value is not valid.",
                "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

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 (summary)

String

Manifest connection id.

displayName

String

A manifest connection display name.

json

{
    "title": "Manifest Connection (summary)",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "Manifest connection id."
        },
        "displayName": {
            "type": "string",
            "description": "A manifest connection display name."
        }
    },
    "additionalProperties": false
}

Synchronization Manifest Connections (prefer return=minimal)

connections

manifest-connection-summary[]

A set of manifest connection entities representing a minimal number of properties.

_links

Links

Links to current, previous, and next connection.

json

{
    "title": "Synchronization Manifest Connections (prefer return=minimal)",
    "type": "object",
    "properties": {
        "connections": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/manifest-connection-summary"
            },
            "description": "A set of manifest connection entities representing a minimal number of properties."
        },
        "_links": {
            "$ref": "#/components/schemas/Links",
            "description": "Links to current, previous, and next connection."
        }
    },
    "additionalProperties": false
}

Synchronization Manifest Connections (prefer return=representation)

connections

ManifestConnection[]

A set of manifest connection entities representing all manifest connection properties.

_links

Links

Links to current, previous, and next connection.

json

{
    "title": "Synchronization Manifest Connections (prefer return=representation)",
    "type": "object",
    "properties": {
        "connections": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ManifestConnection"
            },
            "description": "A set of manifest connection entities representing all manifest connection properties."
        },
        "_links": {
            "$ref": "#/components/schemas/Links",
            "description": "Links to current, previous, and next connection."
        }
    },
    "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"
    ]
}

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
}

Links (paging)

URLs for redoing the current request, getting to the previous or next page of results.

self

Link

URL for redoing the current request.

Link

URL for getting the next page of results.

Link

URL for getting the previous page of results.

json

{
    "title": "Links (paging)",
    "type": "object",
    "description": "URLs for redoing the current request, getting to the previous or next page of results.",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "URL for redoing the current request."
        },
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "URL for getting the next page of results."
        },
        "prev": {
            "$ref": "#/components/schemas/Link",
            "description": "URL for getting the previous page of results."
        }
    },
    "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?