Update an existing ManifestConnection.
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
The Connection ID is required to be set when updating a ManifestConnection.
Request parameters
Connection Id
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
Manifest Connection (update)
Example
{ "displayName": "30", "authenticationType": "User" }
Response 200 OK
Connection successfully updated.
{ "connection": { "id": "MWplZe9Uf0iR1IDMqyOMLry641hUCa9JjxI3cYz8uCg", "iModelId": "7dbd531d-6967-47b2-8945-a722a437ad7a", "iTwinId": "5fb9aa98-9874-4697-b942-d19728840f19", "authenticationType": "User", "displayName": "30", "_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/MWplZe9Uf0iR1IDMqyOMLry641hUCa9JjxI3cYz8uCg/runs/de626d0d-1647-48d7-8c11-f1f74f2d4523" } } } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified connection was not found.
{ "error": { "code": "ManifestConnectionNotFound", "message": "Requested ManifestConnection is not available." } }
Response 422 Unprocessable Entity
Invalid request to update connection. Request payload might be missing some of the required properties.
{ "error": { "code": "InvalidManifestConnectionRequest", "message": "Cannot perform operation.", "details": [{ "code": "InvalidRequestBody", "message": "Error parsing JSON, malformed JSON." }, { "code": "InvalidValue", "message": "Provided connectionId value is not valid.", "target": "connectionId" }] } }
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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "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.
{ "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." }
Link
Hyperlink to the specific entity.
{ "type": "object", "properties": { "href": { "type": "string", "description": "Hyperlink to the specific entity." } }, "additionalProperties": false }
Connection Links
{ "title": "Connection Links", "type": "object", "properties": { "iModel": { "$ref": "#/components/schemas/Link" }, "iTwin": { "$ref": "#/components/schemas/Link" }, "lastRun": { "$ref": "#/components/schemas/Link" } }, "additionalProperties": false }
Authentication Type
One of 'User' or 'Service'.
{ "title": "Authentication Type", "enum": [ "User", "Service" ], "type": "string", "description": "One of 'User' or 'Service'." }
Manifest Connection
Manifest connection id.
A manifest connection display name.
iModel id.
iTwin id.
{ "title": "Manifest Connection", "type": "object", "properties": { "authenticationType": { "$ref": "#/components/schemas/authenticationType" }, "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" } }, "additionalProperties": false }
Manifest connection response
{ "title": "Manifest connection response", "type": "object", "properties": { "connection": { "$ref": "#/components/schemas/ManifestConnection" } }, "additionalProperties": false }
Manifest Connection (update)
{ "title": "Manifest Connection (update)", "type": "object", "properties": { "authenticationType": { "$ref": "#/components/schemas/authenticationType" }, "displayName": { "type": "string", "description": "A manifest connection display name." } }, "additionalProperties": false }
Was this page helpful?