Platform Subscription API

<back to all web services

SaveObjectConnection

Inserts an object connection between 2 valid objects.

Requires Authentication
namespace Eros.Saguna.Common.WebAPI.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SubscriptionObjectModel() = 
        ///<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")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with 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")>]
        member val AlternateKey:String = null with 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")>]
        member val ObjectId:Guid = new Guid() with 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")>]
        member val RmsTableCtxId:Guid = new Guid() with 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")>]
        member val IgnoreValidation:Boolean = new Boolean() with get,set

    ///<summary>
    ///Inserts an object connection between 2 valid objects.
    ///</summary>
    [<Api(Description="Inserts an object connection between 2 valid objects.")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val FromObject:SubscriptionObjectModel = null with 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")>]
        member val ToObject:SubscriptionObjectModel = null with 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")>]
        member val RmsTableCtxIdConnectionMethod:Guid = new Guid() with get,set

F# SaveObjectConnection DTOs

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

HTTP + JSV

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

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

{
	FromObject: 
	{
		AlternateKey: String,
		IgnoreValidation: False
	},
	ToObject: 
	{
		AlternateKey: String,
		IgnoreValidation: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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