| All Verbs | /api/updateobjectsubscription |
|---|
"use strict";
export class ObjectSubscription {
/** @param {{ObjectSubscriptionId?:string,ObjectId?:string,SuiteDataSourceInstanceId?:string,RmsTableContextId?:string,AlternateKey?:string,SuiteDataSourceName?:string,CreatedAt?:string,LastModified?:string,RecordStatus?:string,SuiteInstanceId?:string,SuiteInstanceName?:string,ContactIdLicensee?:string,SubscriptionUpdateResultId?:string,SubscriptionUpdateResult?:string,IsExport?:boolean,ProcessedAt?:string,AcknowledgedAt?:string,Failures?:number,Result?:string,ObjectHash?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
ObjectSubscriptionId;
/** @type {string} */
ObjectId;
/** @type {string} */
SuiteDataSourceInstanceId;
/** @type {string} */
RmsTableContextId;
/** @type {string} */
AlternateKey;
/** @type {string} */
SuiteDataSourceName;
/** @type {string} */
CreatedAt;
/** @type {?string} */
LastModified;
/** @type {string} */
RecordStatus;
/** @type {string} */
SuiteInstanceId;
/** @type {string} */
SuiteInstanceName;
/** @type {string} */
ContactIdLicensee;
/** @type {?string} */
SubscriptionUpdateResultId;
/** @type {string} */
SubscriptionUpdateResult;
/** @type {?boolean} */
IsExport;
/** @type {?string} */
ProcessedAt;
/** @type {?string} */
AcknowledgedAt;
/** @type {number} */
Failures;
/** @type {string} */
Result;
/** @type {string} */
ObjectHash;
}
export class UpdateObjectSubscription {
/** @param {{ObjectSubscription?:ObjectSubscription}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ObjectSubscription} */
ObjectSubscription;
}
export class ObjectSubscriptionResponse {
/** @param {{Success?:boolean,Message?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Success;
/** @type {string} */
Message;
/** @type {ResponseStatus} */
ResponseStatus;
}
JavaScript UpdateObjectSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
ObjectSubscription:
{
ObjectSubscriptionId: 00000000000000000000000000000000,
AlternateKey: String,
SuiteDataSourceName: String,
CreatedAt: 0001-01-01,
LastModified: 0001-01-01,
RecordStatus: String,
SuiteInstanceName: String,
SubscriptionUpdateResultId: 00000000000000000000000000000000,
SubscriptionUpdateResult: String,
IsExport: False,
ProcessedAt: 0001-01-01,
AcknowledgedAt: 0001-01-01,
Failures: 0,
Result: String,
ObjectHash: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}