Platform API

<back to all web services

SaveObjectConnection

Creates or Updates a new connection between two objects.

Requires Authentication
The following routes are available for this service:
POST/api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod}
SaveObjectConnection Parameters:
NameParameterData TypeRequiredDescription
FromObjectIdqueryGuidYes'From' object ID in the connection.
ToObjectIdqueryGuidYes'To' object ID in the connection.
RmsTableCtxIdConnectionMethodqueryGuidYesGuid representing the Connection Method to use to connect the objects with.
SaveObjectConnectionResponse Parameters:
NameParameterData TypeRequiredDescription
ObjectConnectionIdformGuidNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"FromObjectId":"00000000-0000-0000-0000-000000000000","ToObjectId":"00000000-0000-0000-0000-000000000000","RmsTableCtxIdConnectionMethod":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ObjectConnectionId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}