Platform API

GetObjectSubscriptions

Get object subscriptions for the specified object

The following routes are available for this service:
All Verbs	/api/objectsubscriptions/{ObjectId}

"use strict";
export class ObjectSubscriptionDetailModel {
    /** @param {{ObjectSubscriptionId?:string,SuiteDataSourceInstanceId?:string,SuiteDataSourceName?:string,RmsTableContextId?:string,ObjectId?:string,AlternateKey?:string,CreatedAt?:string,RecordStatus?:string,SuiteInstanceId?:string,SuiteInstanceName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ID for the objectSubscription record. */
    ObjectSubscriptionId;
    /**
     * @type {string}
     * @description Id of the Suite DataSource Instance Id. */
    SuiteDataSourceInstanceId;
    /**
     * @type {string}
     * @description Suite DataSource Instance Name. */
    SuiteDataSourceName;
    /**
     * @type {string}
     * @description Id indicating the RmsTableCtx of the object. */
    RmsTableContextId;
    /**
     * @type {string}
     * @description Id of the integrated object. */
    ObjectId;
    /**
     * @type {string}
     * @description Unique Key of this object in the external Data Source. */
    AlternateKey;
    /**
     * @type {string}
     * @description Date the object was integrated. */
    CreatedAt;
    /**
     * @type {string}
     * @description Record Status of the object subscription. */
    RecordStatus;
    /**
     * @type {string}
     * @description Id of the Suite Instance. */
    SuiteInstanceId;
    /**
     * @type {string}
     * @description Suite Instance Name. */
    SuiteInstanceName;
}
export class GetObjectSubscriptionsResponse {
    /** @param {{ObjectSubscriptions?:ObjectSubscriptionDetailModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ObjectSubscriptionDetailModel[]} */
    ObjectSubscriptions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetObjectSubscriptions {
    /** @param {{ObjectId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get active/inactive object subscriptions for the specified object */
    ObjectId;
}

JavaScript GetObjectSubscriptions 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/objectsubscriptions/{ObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ObjectId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}