Platform API

<back to all web services

UpdateObjectSubscription

Updates an existing object subscription record

Requires Authentication
The following routes are available for this service:
All Verbs/api/updateobjectsubscription
UpdateObjectSubscription Parameters:
NameParameterData TypeRequiredDescription
ObjectSubscriptionqueryObjectSubscriptionNo
ObjectSubscription Parameters:
NameParameterData TypeRequiredDescription
ObjectSubscriptionIdformGuid?No
ObjectIdformGuidNo
SuiteDataSourceInstanceIdformGuidNo
RmsTableContextIdformGuidNo
AlternateKeyformstringNo
SuiteDataSourceNameformstringNo
CreatedAtformDateTimeNo
LastModifiedformDateTime?No
RecordStatusformstringNo
SuiteInstanceIdformGuidNo
SuiteInstanceNameformstringNo
ContactIdLicenseeformGuidNo
SubscriptionUpdateResultIdformGuid?No
SubscriptionUpdateResultformstringNo
IsExportformbool?No
ProcessedAtformDateTime?No
AcknowledgedAtformDateTime?No
FailuresformintNo
ResultformstringNo
ObjectHashformstringNo
ObjectSubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

POST /api/updateobjectsubscription HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ObjectSubscription":{"ObjectSubscriptionId":"00000000000000000000000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","SuiteDataSourceInstanceId":"00000000-0000-0000-0000-000000000000","RmsTableContextId":"00000000-0000-0000-0000-000000000000","AlternateKey":"String","SuiteDataSourceName":"String","CreatedAt":"0001-01-01T00:00:00.0000000","LastModified":"0001-01-01T00:00:00.0000000","RecordStatus":"String","SuiteInstanceId":"00000000-0000-0000-0000-000000000000","SuiteInstanceName":"String","ContactIdLicensee":"00000000-0000-0000-0000-000000000000","SubscriptionUpdateResultId":"00000000000000000000000000000000","SubscriptionUpdateResult":"String","IsExport":false,"ProcessedAt":"0001-01-01T00:00:00.0000000","AcknowledgedAt":"0001-01-01T00:00:00.0000000","Failures":0,"Result":"String","ObjectHash":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}