| 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 .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/objectsubscriptions/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ObjectSubscriptions:
[
{
SuiteDataSourceName: String,
AlternateKey: String,
CreatedAt: 0001-01-01,
RecordStatus: String,
SuiteInstanceName: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}