Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication
"use strict";
export class SubscriptionObjectModel {
    /** @param {{SuiteDataSourceInstanceId?:string,AlternateKey?:string,ObjectId?:string,RmsTableCtxId?:string,IgnoreValidation?:boolean}} [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 object on the external system. */
    AlternateKey;
    /**
     * @type {string}
     * @description Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key. */
    ObjectId;
    /**
     * @type {string}
     * @description Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update. */
    RmsTableCtxId;
    /**
     * @type {boolean}
     * @description Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement. */
    IgnoreValidation;
}
export class SaveObjectConnection {
    /** @param {{FromObject?:SubscriptionObjectModel,ToObject?:SubscriptionObjectModel,RmsTableCtxIdConnectionMethod?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {SubscriptionObjectModel}
     * @description Information to allow retrieval of the object from Eros that will be the 'From' object in the connection. */
    FromObject;
    /**
     * @type {SubscriptionObjectModel}
     * @description Information to allow retrieval of the object from Eros that will be the 'To' object in the connection. */
    ToObject;
    /**
     * @type {string}
     * @description Guid representing the Connection Method to use to connect the objects with. */
    RmsTableCtxIdConnectionMethod;
}

JavaScript SaveObjectConnection 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/SaveObjectConnection HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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