| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} | ||
|---|---|---|---|
| GET | /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId} |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObjectConnectionModel:
object_connection_id: Optional[str] = None
object_id_from: Optional[str] = None
object_from_reference: Optional[str] = None
object_to_reference: Optional[str] = None
object_id_to: Optional[str] = None
connection_method_id: Optional[str] = None
object_from_name: Optional[str] = None
object_to_name: Optional[str] = None
record_status: Optional[str] = None
# @ApiResponse(Description="Returns the connections for the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectConnectionsResponse:
object_connections: Optional[List[ObjectConnectionModel]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get object connections for the specified object and connection method.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectConnections:
"""
Get object connections for the specified object and connection method.
"""
# @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
from_object_id: Optional[str] = None
"""
'From' object ID in the connection.
"""
# @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
to_object_id: Optional[str] = None
"""
'To' object ID in the connection.
"""
# @ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod", ParameterType="query")
rms_table_ctx_id_connection_method: Optional[str] = None
"""
Guid representing the Connection Method to use to connect the objects with.
"""
# @ApiMember(DataType="string", Description="Status of object Connections to retrieve, if not specified active connections are retrieved by default.", Name="RecordStatus", ParameterType="query")
record_status: Optional[str] = None
"""
Status of object Connections to retrieve, if not specified active connections are retrieved by default.
"""
Python 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"}}}