| 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 .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"}}}