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

export class ObjectSubscription
{
    public ObjectSubscriptionId?: string;
    public ObjectId: string;
    public SuiteDataSourceInstanceId: string;
    public RmsTableContextId: string;
    public AlternateKey: string;
    public SuiteDataSourceName: string;
    public CreatedAt: string;
    public LastModified?: string;
    public RecordStatus: string;
    public SuiteInstanceId: string;
    public SuiteInstanceName: string;
    public ContactIdLicensee: string;
    public SubscriptionUpdateResultId?: string;
    public SubscriptionUpdateResult: string;
    public IsExport?: boolean;
    public ProcessedAt?: string;
    public AcknowledgedAt?: string;
    public Failures: number;
    public Result: string;
    public ObjectHash: string;

    public constructor(init?: Partial<ObjectSubscription>) { (Object as any).assign(this, init); }
}

/** @description Inseets a new object subscription record */
// @Api(Description="Inseets a new object subscription record")
export class InsertObjectSubscription
{
    public ObjectSubscription: ObjectSubscription;

    public constructor(init?: Partial<InsertObjectSubscription>) { (Object as any).assign(this, init); }
}

export class ObjectSubscriptionResponse
{
    public Success: boolean;
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ObjectSubscriptionResponse>) { (Object as any).assign(this, init); }
}

TypeScript InsertObjectSubscription DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}}