| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} | ||
|---|---|---|---|
| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId} |
import Foundation
import ServiceStack
/**
* Get object connections for the specified object and connection method.
*/
// @Api(Description="Get object connections for the specified object and connection method.")
public class GetObjectConnections : Codable
{
/**
* 'From' object ID in the connection.
*/
// @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
public var fromObjectId:String
/**
* 'To' object ID in the connection.
*/
// @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
public var toObjectId:String
/**
* 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 var rmsTableCtxIdConnectionMethod:String
/**
* 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 var recordStatus:String
required public init(){}
}
// @ApiResponse(Description="Returns the connections for the specified object.")
public class GetObjectConnectionsResponse : Codable
{
public var objectConnections:[ObjectConnectionModel]
public var responseStatus:ResponseStatus
required public init(){}
}
public class ObjectConnectionModel : Codable
{
public var objectConnectionId:String
public var objectIdFrom:String
public var objectFromReference:String
public var objectToReference:String
public var objectIdTo:String
public var connectionMethodId:String
public var objectFromName:String
public var objectToName:String
public var recordStatus:String
required public init(){}
}
Swift GetObjectConnections DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ObjectConnections":[{"ObjectConnectionId":"00000000-0000-0000-0000-000000000000","ObjectIdFrom":"00000000-0000-0000-0000-000000000000","ObjectFromReference":"String","ObjectToReference":"String","ObjectIdTo":"00000000-0000-0000-0000-000000000000","ConnectionMethodId":"00000000-0000-0000-0000-000000000000","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"}}}