Platform API

<back to all web services

UpdateObjectSubscription

Updates an existing object subscription record

Requires Authentication
The following routes are available for this service:
All Verbs/api/updateobjectsubscription

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 Updates an existing object subscription record */
// @Api(Description="Updates an existing object subscription record")
export class UpdateObjectSubscription
{
    public ObjectSubscription: ObjectSubscription;

    public constructor(init?: Partial<UpdateObjectSubscription>) { (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 UpdateObjectSubscription DTOs

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

HTTP + JSV

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

POST /api/updateobjectsubscription HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ObjectSubscription: 
	{
		ObjectSubscriptionId: 00000000000000000000000000000000,
		AlternateKey: String,
		SuiteDataSourceName: String,
		CreatedAt: 0001-01-01,
		LastModified: 0001-01-01,
		RecordStatus: String,
		SuiteInstanceName: String,
		SubscriptionUpdateResultId: 00000000000000000000000000000000,
		SubscriptionUpdateResult: String,
		IsExport: False,
		ProcessedAt: 0001-01-01,
		AcknowledgedAt: 0001-01-01,
		Failures: 0,
		Result: String,
		ObjectHash: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}