Platform API

<back to all web services

InsertObjectSubscription

Inseets a new object subscription record

Requires Authentication
The following routes are available for this service:
All Verbs/api/insertobjectsubscription
"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 InsertObjectSubscription {
    /** @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 InsertObjectSubscription DTOs

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

HTTP + JSON

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

POST /api/insertobjectsubscription HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}