Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
SaveObjectStructure Parameters:
NameParameterData TypeRequiredDescription
SuiteDataSourceInstanceIdbodyGuidNoGuid representing the external systems datasource information.
AlternateKeybodystringNoThe unique key that represents the connection structure object on the external system.
ObjectIdbodyGuidNoGuid of the connection structure object within PSTPF. If ObjectId is known, the external system may pass this instead of the alternate key.
RmsTableCtxIdbodyGuidNoConnection Structure RmsTableCtxId.
StructureDefinitionIdbodyGuidNoId of the Connection Structure Definition.
StructureTypeIdbodyGuidNoId of the Structure Type.
StructureDefinitionXmlbodystringNoXML for the children in the structure for the object indicated via alternateKey/objectId.
NamebodystringNoConnection Structure Name.
ReferencebodystringNoConnection Structure Reference.
LicenseeIdqueryGuidNo
SessionIdqueryGuidNo

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/SaveObjectStructure HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AlternateKey":"String","RmsTableCtxId":"4f501e1e-5e4c-439a-bf6a-2253fcbbcf68","StructureDefinitionXml":"String","Name":"String","Reference":"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"}}