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}

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


/**
* Get object connections for the specified object and connection method.
*/
@Api(Description="Get object connections for the specified object and connection method.")
open class GetObjectConnections
{
    /**
    * 'From' object ID in the connection.
    */
    @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
    open var FromObjectId:UUID? = null

    /**
    * 'To' object ID in the connection.
    */
    @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
    open var ToObjectId:UUID? = 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", ParameterType="query")
    open var RmsTableCtxIdConnectionMethod:UUID? = null

    /**
    * Status of object Connections to retrieve, if not specified active connections are retrieved by default.
    */
    @ApiMember(DataType="string", Description="Status of object Connections to retrieve, if not specified active connections are retrieved by default.", Name="RecordStatus", ParameterType="query")
    open var RecordStatus:String? = null
}

@ApiResponse(Description="Returns the connections for the specified object.")
open class GetObjectConnectionsResponse
{
    open var ObjectConnections:ArrayList<ObjectConnectionModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class ObjectConnectionModel
{
    open var ObjectConnectionId:UUID? = null
    open var ObjectIdFrom:UUID? = null
    open var ObjectFromReference:String? = null
    open var ObjectToReference:String? = null
    open var ObjectIdTo:UUID? = null
    open var ConnectionMethodId:UUID? = null
    open var ObjectFromName:String? = null
    open var ObjectToName:String? = null
    open var RecordStatus:String? = null
}

Kotlin GetObjectConnections DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjectConnectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ObjectConnections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ObjectConnectionModel>
      <d2p1:ConnectionMethodId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionMethodId>
      <d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
      <d2p1:ObjectFromName>String</d2p1:ObjectFromName>
      <d2p1:ObjectFromReference>String</d2p1:ObjectFromReference>
      <d2p1:ObjectIdFrom>00000000-0000-0000-0000-000000000000</d2p1:ObjectIdFrom>
      <d2p1:ObjectIdTo>00000000-0000-0000-0000-000000000000</d2p1:ObjectIdTo>
      <d2p1:ObjectToName>String</d2p1:ObjectToName>
      <d2p1:ObjectToReference>String</d2p1:ObjectToReference>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
    </d2p1:ObjectConnectionModel>
  </ObjectConnections>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetObjectConnectionsResponse>