Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication
SaveObjectConnection Parameters:
NameParameterData TypeRequiredDescription
FromObjectquerySubscriptionObjectModelYesInformation to allow retrieval of the object from Eros that will be the 'From' object in the connection.
ToObjectquerySubscriptionObjectModelYesInformation to allow retrieval of the object from Eros that will be the 'To' object in the connection.
RmsTableCtxIdConnectionMethodqueryGuidYesGuid representing the Connection Method to use to connect the objects with.
SubscriptionObjectModel Parameters:
NameParameterData TypeRequiredDescription
SuiteDataSourceInstanceIdqueryGuidYesGuid representing the external systems datasource information.
AlternateKeyquerystringYesThe unique key that represents the object on the external system.
ObjectIdqueryGuidNoGuid of the object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.
RmsTableCtxIdqueryGuidNoGuid of the RmsTableCtx within Eros. This is used if the alternate key is provided to identify the object to update.
IgnoreValidationqueryboolNoValidation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.

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","IgnoreValidation":false},"ToObject":{"AlternateKey":"String","IgnoreValidation":false}}
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"}}