-
Notifications
You must be signed in to change notification settings - Fork 0
REST API Interface Connection
The REST API interface can be accessed under the path 'API/REST.svc/'. Windows Authentication must be enabled on the web server, and anonymous authentication must be disallowed.
Methods for connections
There is deliberately no method for reading all connections apart from their configuration items. In large environments with thousands of items, this would crash most applications, since there are much more connections than items.
Path: Connection/{id}
Method: GET
Expects: Guid of the desired connection
Returns: Connection object
Path: Connection/upperItem/{upperItem}/connectionType/{connType}/lowerItem/{lowerItem}
Method: GET
Expects: Guid of the desired upper and lower item and connection type
Returns: Connection object
Path: Connection
Method: POST
Expects: { connection: Connection } object
Returns: OperationResult
Path: Connection/{id}
Method: PUT
Expects: Guid of the desired connection in the path and { connection: Connection } object in the body
Returns: OperationResult
Only the connection description can be altered, upper and lower item an connection type and rule are immutable. If the connection description does not match the validation expression, the update fails.
Path: Connection/{id}
Method: DELETE
Expects: Guid of the desired connection
Returns: OperationResult
Path: ConfigurationItem/{id}/Connections
Method: GET
Expects: Guid of the desired configuration item
Returns: Connection[]
Path: ConfigurationItem/{id}/Connections/ToLower
Method: GET
Expects: Guid of the desired configuration item
Returns: Connection[]
Path: ConfigurationItem/{id}/Connections/ToUpper
Method: GET
Expects: Guid of the desired configuration item
Returns: Connection[]