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
InsertObjectSubscription Parameters:
NameParameterData TypeRequiredDescription
ObjectSubscriptionqueryObjectSubscriptionNo
ObjectSubscription Parameters:
NameParameterData TypeRequiredDescription
ObjectSubscriptionIdformGuid?No
ObjectIdformGuidNo
SuiteDataSourceInstanceIdformGuidNo
RmsTableContextIdformGuidNo
AlternateKeyformstringNo
SuiteDataSourceNameformstringNo
CreatedAtformDateTimeNo
LastModifiedformDateTime?No
RecordStatusformstringNo
SuiteInstanceIdformGuidNo
SuiteInstanceNameformstringNo
ContactIdLicenseeformGuidNo
SubscriptionUpdateResultIdformGuid?No
SubscriptionUpdateResultformstringNo
IsExportformbool?No
ProcessedAtformDateTime?No
AcknowledgedAtformDateTime?No
FailuresformintNo
ResultformstringNo
ObjectHashformstringNo
ObjectSubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ResponseStatusformResponseStatusNo

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/insertobjectsubscription 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
		}
	}
}