Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Inserts an object connection between 2 valid objects.
*/
@Api(Description="Inserts an object connection between 2 valid objects.")
open class SaveObjectConnection
{
    /**
    * Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.
    */
    @ApiMember(DataType="SubscriptionObjectModel", Description="Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.", IsRequired=true, Name="FromObject")
    open var FromObject:SubscriptionObjectModel? = null

    /**
    * Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.
    */
    @ApiMember(DataType="SubscriptionObjectModel", Description="Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.", IsRequired=true, Name="ToObject")
    open var ToObject:SubscriptionObjectModel? = null

    /**
    * Guid representing the Connection Method to use to connect the objects with.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod")
    open var RmsTableCtxIdConnectionMethod:UUID? = null
}

open class SubscriptionObjectModel : ISubscription
{
    /**
    * Guid representing the external systems datasource information.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    override var SuiteDataSourceInstanceId:UUID? = null

    /**
    * The unique key that represents the object on the external system.
    */
    @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
    override var AlternateKey:String? = null

    /**
    * Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
    */
    @ApiMember(DataType="Guid", Description="Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query")
    override var ObjectId:UUID? = null

    /**
    * Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.
    */
    @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId", ParameterType="query")
    open var RmsTableCtxId:UUID? = null

    /**
    * Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.
    */
    @ApiMember(DataType="bool", Description="Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.", Name="IgnoreValidation", ParameterType="query")
    override var IgnoreValidation:Boolean? = null
}

Kotlin SaveObjectConnection DTOs

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"}}