| 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.*;
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}