Platform API

GetObjectConnections

Get object connections for the specified object and connection method.

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

namespace Eros.Saguna.Common.WebAPIModel.Models

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

    [<AllowNullLiteral>]
    type ObjectConnectionModel() = 
        member val ObjectConnectionId:Guid = new Guid() with get,set
        member val ObjectIdFrom:Guid = new Guid() with get,set
        member val ObjectFromReference:String = null with get,set
        member val ObjectToReference:String = null with get,set
        member val ObjectIdTo:Guid = new Guid() with get,set
        member val ConnectionMethodId:Guid = new Guid() with get,set
        member val ObjectFromName:String = null with get,set
        member val ObjectToName:String = null with get,set
        member val RecordStatus:String = null with get,set

    [<ApiResponse(Description="Returns the connections for the specified object.")>]
    [<AllowNullLiteral>]
    type GetObjectConnectionsResponse() = 
        member val ObjectConnections:ResizeArray<ObjectConnectionModel> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get object connections for the specified object and connection method.
    ///</summary>
    [<Api(Description="Get object connections for the specified object and connection method.")>]
    [<AllowNullLiteral>]
    type GetObjectConnections() = 
        ///<summary>
        ///'From' object ID in the connection.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")>]
        member val FromObjectId:Guid = new Guid() with get,set

        ///<summary>
        ///'To' object ID in the connection.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")>]
        member val ToObjectId:Guid = new Guid() 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", ParameterType="query")>]
        member val RmsTableCtxIdConnectionMethod:Guid = new Guid() with get,set

        ///<summary>
        ///Status of object Connections to retrieve, if not specified active connections are retrieved by default.
        ///</summary>
        [<ApiMember(DataType="string", Description="Status of object Connections to retrieve, if not specified active connections are retrieved by default.", Name="RecordStatus", ParameterType="query")>]
        member val RecordStatus:String = null with get,set

F# GetObjectConnections 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.

GET /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv

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

{
	ObjectConnections: 
	[
		{
			ObjectFromReference: String,
			ObjectToReference: String,
			ObjectFromName: String,
			ObjectToName: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}