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}


export class ObjectConnectionModel
{
    public ObjectConnectionId: string;
    public ObjectIdFrom: string;
    public ObjectFromReference: string;
    public ObjectToReference: string;
    public ObjectIdTo: string;
    public ConnectionMethodId: string;
    public ObjectFromName: string;
    public ObjectToName: string;
    public RecordStatus: string;

    public constructor(init?: Partial<ObjectConnectionModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="Returns the connections for the specified object.")
export class GetObjectConnectionsResponse
{
    public ObjectConnections: ObjectConnectionModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetObjectConnectionsResponse>) { (Object as any).assign(this, init); }
}

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

    /** @description 'To' object ID in the connection. */
    // @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
    public ToObjectId: string;

    /** @description 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 RmsTableCtxIdConnectionMethod: string;

    /** @description 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 RecordStatus: string;

    public constructor(init?: Partial<GetObjectConnections>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}