Platform API

<back to all web services

GetObjectConnections

Get object connections for the specified object and connection method.

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

GET /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetObjectConnectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ObjectConnections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ObjectConnectionModel>
      <d2p1:ConnectionMethodId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionMethodId>
      <d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
      <d2p1:ObjectFromName>String</d2p1:ObjectFromName>
      <d2p1:ObjectFromReference>String</d2p1:ObjectFromReference>
      <d2p1:ObjectIdFrom>00000000-0000-0000-0000-000000000000</d2p1:ObjectIdFrom>
      <d2p1:ObjectIdTo>00000000-0000-0000-0000-000000000000</d2p1:ObjectIdTo>
      <d2p1:ObjectToName>String</d2p1:ObjectToName>
      <d2p1:ObjectToReference>String</d2p1:ObjectToReference>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
    </d2p1:ObjectConnectionModel>
  </ObjectConnections>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetObjectConnectionsResponse>