Platform API

<back to all web services

GetObjectConnections

Get object connections for the specified object and connection method.

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

public class dtos
{

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

        /**
        * 'To' object ID in the connection.
        */
        @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
        public UUID ToObjectId = 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")
        public UUID RmsTableCtxIdConnectionMethod = 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")
        public String RecordStatus = null;
        
        public UUID getFromObjectId() { return FromObjectId; }
        public GetObjectConnections setFromObjectId(UUID value) { this.FromObjectId = value; return this; }
        public UUID getToObjectId() { return ToObjectId; }
        public GetObjectConnections setToObjectId(UUID value) { this.ToObjectId = value; return this; }
        public UUID getRmsTableCtxIdConnectionMethod() { return RmsTableCtxIdConnectionMethod; }
        public GetObjectConnections setRmsTableCtxIdConnectionMethod(UUID value) { this.RmsTableCtxIdConnectionMethod = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public GetObjectConnections setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

    @ApiResponse(Description="Returns the connections for the specified object.")
    public static class GetObjectConnectionsResponse
    {
        public ArrayList<ObjectConnectionModel> ObjectConnections = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<ObjectConnectionModel> getObjectConnections() { return ObjectConnections; }
        public GetObjectConnectionsResponse setObjectConnections(ArrayList<ObjectConnectionModel> value) { this.ObjectConnections = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetObjectConnectionsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ObjectConnectionModel
    {
        public UUID ObjectConnectionId = null;
        public UUID ObjectIdFrom = null;
        public String ObjectFromReference = null;
        public String ObjectToReference = null;
        public UUID ObjectIdTo = null;
        public UUID ConnectionMethodId = null;
        public String ObjectFromName = null;
        public String ObjectToName = null;
        public String RecordStatus = null;
        
        public UUID getObjectConnectionId() { return ObjectConnectionId; }
        public ObjectConnectionModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
        public UUID getObjectIdFrom() { return ObjectIdFrom; }
        public ObjectConnectionModel setObjectIdFrom(UUID value) { this.ObjectIdFrom = value; return this; }
        public String getObjectFromReference() { return ObjectFromReference; }
        public ObjectConnectionModel setObjectFromReference(String value) { this.ObjectFromReference = value; return this; }
        public String getObjectToReference() { return ObjectToReference; }
        public ObjectConnectionModel setObjectToReference(String value) { this.ObjectToReference = value; return this; }
        public UUID getObjectIdTo() { return ObjectIdTo; }
        public ObjectConnectionModel setObjectIdTo(UUID value) { this.ObjectIdTo = value; return this; }
        public UUID getConnectionMethodId() { return ConnectionMethodId; }
        public ObjectConnectionModel setConnectionMethodId(UUID value) { this.ConnectionMethodId = value; return this; }
        public String getObjectFromName() { return ObjectFromName; }
        public ObjectConnectionModel setObjectFromName(String value) { this.ObjectFromName = value; return this; }
        public String getObjectToName() { return ObjectToName; }
        public ObjectConnectionModel setObjectToName(String value) { this.ObjectToName = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public ObjectConnectionModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}

Java GetObjectConnections DTOs

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>