Element External Systems
List, link, and unlink external systems associated with elements.
Link an element with an external system
Creates or updates an element's representation in an external system. Provide systemUrl to select a specific external system. When systemUrl is omitted, the binding target is resolved from the current organization settings.
path Parameters
idLink an element with an external system › Request Body
Element representation in the external system.
Provide at least one of externalId or link.
systemUrlExternal system URL selector.
Omit systemUrl to resolve the target binding from the current organization settings.
Link an element with an external system › Responses
OK
Representation of the element in the external system.
systemUrlURL of the external system this binding belongs to. Null means the historical row is not currently bound to organization REST settings.
Unlink an element from an external system
Removes an element's representation from an external system. Provide systemUrl to select a specific external system. When systemUrl is omitted, the binding target is resolved from the current organization settings.
path Parameters
idUnlink an element from an external system › Request Body
systemUrlExternal system URL selector.
Omit systemUrl to resolve the target binding from the current organization settings.
Unlink an element from an external system › Responses
OK
Representation of the element in the external system.
systemUrlURL of the external system this binding belongs to. Null means the historical row is not currently bound to organization REST settings.
List external systems linked to an element
Returns active external-system bindings visible for the addressed element in the current organization scope. Use this endpoint to inspect all external-system representations available for the element; ElementApiModel.externalElement remains a convenience projection of one active binding.
path Parameters
idList external systems linked to an element › Responses
OK
Representation of the element in the external system.
systemUrlURL of the external system this binding belongs to. Null means the historical row is not currently bound to organization REST settings.