Platform Subscription API

<back to all web services

SaveObjectStructure

Inserts or Updates an object connection structure.

Requires Authentication
"use strict";
export class SaveObjectStructure {
    /** @param {{SuiteDataSourceInstanceId?:string,AlternateKey?:string,ObjectId?:string,RmsTableCtxId?:string,IgnoreValidation?:boolean,StructureDefinitionId?:string,StructureTypeId?:string,StructureDefinitionXml?:string,Name?:string,Reference?:string,LicenseeId?:string,SessionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid representing the external systems datasource information. */
    SuiteDataSourceInstanceId;
    /**
     * @type {string}
     * @description The unique key that represents the connection structure object on the external system. */
    AlternateKey;
    /**
     * @type {string}
     * @description Guid of the connection structure object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key. */
    ObjectId;
    /**
     * @type {string}
     * @description Connection Structure RmsTableCtxId. */
    RmsTableCtxId;
    /** @type {boolean} */
    IgnoreValidation;
    /**
     * @type {string}
     * @description Id of the Connection Structure Definition. */
    StructureDefinitionId;
    /**
     * @type {string}
     * @description Id of the Structure Type. */
    StructureTypeId;
    /**
     * @type {string}
     * @description XML for the children in the structure for the object indicated via alternateKey/objectId. */
    StructureDefinitionXml;
    /**
     * @type {string}
     * @description Connection Structure Name. */
    Name;
    /**
     * @type {string}
     * @description Connection Structure Reference. */
    Reference;
    /** @type {string} */
    LicenseeId;
    /** @type {string} */
    SessionId;
}

JavaScript SaveObjectStructure DTOs

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

HTTP + OTHER

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

POST /jsonl/reply/SaveObjectStructure HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"AlternateKey":"String","RmsTableCtxId":"4f501e1e-5e4c-439a-bf6a-2253fcbbcf68","IgnoreValidation":false,"StructureDefinitionXml":"String","Name":"String","Reference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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