Platform Subscription API

SaveObjectConnection

Inserts an object connection between 2 valid objects.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription;
using Eros.Saguna.Common.WebAPI.ServiceModel;

namespace Eros.Saguna.Common.WebAPI.ServiceModel
{
    public partial class SubscriptionObjectModel
        : ISubscription
    {
        ///<summary>
        ///Guid representing the external systems datasource information.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")]
        public virtual Guid SuiteDataSourceInstanceId { get; set; }

        ///<summary>
        ///The unique key that represents the object on the external system.
        ///</summary>
        [ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")]
        public virtual string AlternateKey { get; set; }

        ///<summary>
        ///Guid of the object within Eros.  If ObjectId is known, the external system may pass this instead of the alternate key.
        ///</summary>
        [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")]
        public virtual Guid ObjectId { get; set; }

        ///<summary>
        ///Guid of the RmsTableCtx within Eros.  This is used if the alternate key is provided to identify the object to update.
        ///</summary>
        [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")]
        public virtual Guid RmsTableCtxId { get; set; }

        ///<summary>
        ///Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.
        ///</summary>
        [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")]
        public virtual bool IgnoreValidation { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription
{
    ///<summary>
    ///Inserts an object connection between 2 valid objects.
    ///</summary>
    [Api(Description="Inserts an object connection between 2 valid objects.")]
    public partial class SaveObjectConnection
    {
        ///<summary>
        ///Information to allow retrieval of the object from Eros that will be the 'From' object in the connection.
        ///</summary>
        [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")]
        public virtual SubscriptionObjectModel FromObject { get; set; }

        ///<summary>
        ///Information to allow retrieval of the object from Eros that will be the 'To' object in the connection.
        ///</summary>
        [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")]
        public virtual SubscriptionObjectModel ToObject { get; set; }

        ///<summary>
        ///Guid representing the Connection Method to use to connect the objects with.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod")]
        public virtual Guid RmsTableCtxIdConnectionMethod { get; set; }
    }

}

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