| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} | ||
|---|---|---|---|
| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FromObjectId | query | Guid | Yes | 'From' object ID in the connection. |
| ToObjectId | query | Guid | Yes | 'To' object ID in the connection. |
| RmsTableCtxIdConnectionMethod | query | Guid | Yes | Guid representing the Connection Method to use to connect the objects with. |
| RecordStatus | query | string | No | Status of object Connections to retrieve, if not specified active connections are retrieved by default. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectConnections | form | List<ObjectConnectionModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectConnectionId | form | Guid | No | |
| ObjectIdFrom | form | Guid | No | |
| ObjectFromReference | form | string | No | |
| ObjectToReference | form | string | No | |
| ObjectIdTo | form | Guid | No | |
| ConnectionMethodId | form | Guid | No | |
| ObjectFromName | form | string | No | |
| ObjectToName | form | string | No | |
| RecordStatus | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ObjectConnections":[{"ObjectConnectionId":"00000000-0000-0000-0000-000000000000","ObjectIdFrom":"00000000-0000-0000-0000-000000000000","ObjectFromReference":"String","ObjectToReference":"String","ObjectIdTo":"00000000-0000-0000-0000-000000000000","ConnectionMethodId":"00000000-0000-0000-0000-000000000000","ObjectFromName":"String","ObjectToName":"String","RecordStatus":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}