| All Verbs | /api/objectsubscriptions/{ObjectId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | path | Guid | Yes | Get active/inactive object subscriptions for the specified object |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectSubscriptions | form | List<ObjectSubscriptionDetailModel> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectSubscriptionId | form | Guid | No | ID for the objectSubscription record. |
| SuiteDataSourceInstanceId | form | Guid | No | Id of the Suite DataSource Instance Id. |
| SuiteDataSourceName | form | string | No | Suite DataSource Instance Name. |
| RmsTableContextId | form | Guid | No | Id indicating the RmsTableCtx of the object. |
| ObjectId | form | Guid | No | Id of the integrated object. |
| AlternateKey | form | string | No | Unique Key of this object in the external Data Source. |
| CreatedAt | form | DateTime | No | Date the object was integrated. |
| RecordStatus | form | string | No | Record Status of the object subscription. |
| SuiteInstanceId | form | Guid | No | Id of the Suite Instance. |
| SuiteInstanceName | form | string | No | Suite Instance Name. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/objectsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ObjectSubscriptions":[{"ObjectSubscriptionId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceName":"String","RmsTableContextId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","CreatedAt":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}