| All Verbs | /api/objectsubscriptions/{ObjectId} |
|---|
export class ObjectSubscriptionDetailModel
{
/** @description ID for the objectSubscription record. */
// @ApiMember(Description="ID for the objectSubscription record.", Name="ObjectSubscriptionId")
public ObjectSubscriptionId: string;
/** @description Id of the Suite DataSource Instance Id. */
// @ApiMember(Description="Id of the Suite DataSource Instance Id.", Name="SuiteDataSourceInstanceId")
public SuiteDataSourceInstanceId: string;
/** @description Suite DataSource Instance Name. */
// @ApiMember(Description="Suite DataSource Instance Name.", Name="SuiteDataSourceName")
public SuiteDataSourceName: string;
/** @description Id indicating the RmsTableCtx of the object. */
// @ApiMember(Description="Id indicating the RmsTableCtx of the object.", Name="RmsTableContextId")
public RmsTableContextId: string;
/** @description Id of the integrated object. */
// @ApiMember(Description="Id of the integrated object.", Name="ObjectId")
public ObjectId: string;
/** @description Unique Key of this object in the external Data Source. */
// @ApiMember(Description="Unique Key of this object in the external Data Source.", Name="AlternateKey")
public AlternateKey: string;
/** @description Date the object was integrated. */
// @ApiMember(Description="Date the object was integrated.", Name="CreatedAt")
public CreatedAt: string;
/** @description Record Status of the object subscription. */
// @ApiMember(Description="Record Status of the object subscription.", Name="RecordStatus")
public RecordStatus: string;
/** @description Id of the Suite Instance. */
// @ApiMember(Description="Id of the Suite Instance.", Name="SuiteInstanceId")
public SuiteInstanceId: string;
/** @description Suite Instance Name. */
// @ApiMember(Description="Suite Instance Name.", Name="SuiteInstanceName")
public SuiteInstanceName: string;
public constructor(init?: Partial<ObjectSubscriptionDetailModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="List of object subscriptions")
export class GetObjectSubscriptionsResponse
{
public ObjectSubscriptions: ObjectSubscriptionDetailModel[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetObjectSubscriptionsResponse>) { (Object as any).assign(this, init); }
}
/** @description Get object subscriptions for the specified object */
// @Api(Description="Get object subscriptions for the specified object")
export class GetObjectSubscriptions
{
/** @description Get active/inactive object subscriptions for the specified object */
// @ApiMember(Description="Get active/inactive object subscriptions for the specified object", IsRequired=true, Name="ObjectId")
public ObjectId: string;
public constructor(init?: Partial<GetObjectSubscriptions>) { (Object as any).assign(this, init); }
}
TypeScript GetObjectSubscriptions DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"ObjectId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}