Platform API

SaveObjectConnection

Creates or Updates a new connection between two objects.

The following routes are available for this service:
POST	/api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod}

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Saguna.Common.WebAPIModel.ServiceModels

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.ServiceModels

        '''<Summary>
        '''Creates or Updates a new connection between two objects.
        '''</Summary>
        <Api(Description:="Creates or Updates a new connection between two objects.")>
        Public Partial Class SaveObjectConnection
            '''<Summary>
            ''''From' object ID in the connection.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="'From' object ID in the connection.", IsRequired:=true, Name:="FromObjectId", ParameterType:="query")>
            Public Overridable Property FromObjectId As Guid

            '''<Summary>
            ''''To' object ID in the connection.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="'To' object ID in the connection.", IsRequired:=true, Name:="ToObjectId", ParameterType:="query")>
            Public Overridable Property ToObjectId As Guid

            '''<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", ParameterType:="query")>
            Public Overridable Property RmsTableCtxIdConnectionMethod As Guid
        End Class

        <ApiResponse(Description:="Returns the object connection Id created/modified and success of the save.")>
        Public Partial Class SaveObjectConnectionResponse
            Public Overridable Property ObjectConnectionId As Guid
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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 /api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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