Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication
SaveObjectConnection Parameters:
NameParameterData TypeRequiredDescription
FromObjectbodySubscriptionObjectModelYesInformation to allow retrieval of the object from PSTPF that will be the 'From' object in the connection.
ToObjectbodySubscriptionObjectModelYesInformation to allow retrieval of the object from PSTPF that will be the 'To' object in the connection.
RmsTableCtxIdConnectionMethodbodyGuidYesGuid representing the Connection Method to use to connect the objects with.
SubscriptionObjectModel Parameters:
NameParameterData TypeRequiredDescription
SuiteDataSourceInstanceIdbodyGuidYesGuid representing the external systems datasource information.
AlternateKeybodystringNoThe unique key that represents the object on the external system.
ObjectIdbodyGuidNoGuid of the object within PSTPF. If ObjectId is known, the external system may pass this instead of the alternate key.
RmsTableCtxIdbodyGuidNoGuid of the RmsTableCtx within PSTPF. This is used if the alternate key is provided to identify the object to update.

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/SaveObjectConnection HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FromObject":{"AlternateKey":"String"},"ToObject":{"AlternateKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}