Platform API

GetObjectConnections

Get object connections for the specified object and connection method.

The following routes are available for this service:
GET	/api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId}
GET	/api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId}

import 'package:servicestack/servicestack.dart';

class ObjectConnectionModel implements IConvertible
{
    String? ObjectConnectionId;
    String? ObjectIdFrom;
    String? ObjectFromReference;
    String? ObjectToReference;
    String? ObjectIdTo;
    String? ConnectionMethodId;
    String? ObjectFromName;
    String? ObjectToName;
    String? RecordStatus;

    ObjectConnectionModel({this.ObjectConnectionId,this.ObjectIdFrom,this.ObjectFromReference,this.ObjectToReference,this.ObjectIdTo,this.ConnectionMethodId,this.ObjectFromName,this.ObjectToName,this.RecordStatus});
    ObjectConnectionModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectConnectionId = json['ObjectConnectionId'];
        ObjectIdFrom = json['ObjectIdFrom'];
        ObjectFromReference = json['ObjectFromReference'];
        ObjectToReference = json['ObjectToReference'];
        ObjectIdTo = json['ObjectIdTo'];
        ConnectionMethodId = json['ConnectionMethodId'];
        ObjectFromName = json['ObjectFromName'];
        ObjectToName = json['ObjectToName'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectConnectionId': ObjectConnectionId,
        'ObjectIdFrom': ObjectIdFrom,
        'ObjectFromReference': ObjectFromReference,
        'ObjectToReference': ObjectToReference,
        'ObjectIdTo': ObjectIdTo,
        'ConnectionMethodId': ConnectionMethodId,
        'ObjectFromName': ObjectFromName,
        'ObjectToName': ObjectToName,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "ObjectConnectionModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="Returns the connections for the specified object.")
class GetObjectConnectionsResponse implements IConvertible
{
    List<ObjectConnectionModel>? ObjectConnections;
    ResponseStatus? ResponseStatus;

    GetObjectConnectionsResponse({this.ObjectConnections,this.ResponseStatus});
    GetObjectConnectionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ObjectConnections = JsonConverters.fromJson(json['ObjectConnections'],'List<ObjectConnectionModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ObjectConnections': JsonConverters.toJson(ObjectConnections,'List<ObjectConnectionModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetObjectConnectionsResponse";
    TypeContext? context = _ctx;
}

/**
* Get object connections for the specified object and connection method.
*/
// @Api(Description="Get object connections for the specified object and connection method.")
class GetObjectConnections implements IConvertible
{
    /**
    * 'From' object ID in the connection.
    */
    // @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
    String? FromObjectId;

    /**
    * 'To' object ID in the connection.
    */
    // @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
    String? ToObjectId;

    /**
    * 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")
    String? RmsTableCtxIdConnectionMethod;

    /**
    * 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")
    String? RecordStatus;

    GetObjectConnections({this.FromObjectId,this.ToObjectId,this.RmsTableCtxIdConnectionMethod,this.RecordStatus});
    GetObjectConnections.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FromObjectId = json['FromObjectId'];
        ToObjectId = json['ToObjectId'];
        RmsTableCtxIdConnectionMethod = json['RmsTableCtxIdConnectionMethod'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FromObjectId': FromObjectId,
        'ToObjectId': ToObjectId,
        'RmsTableCtxIdConnectionMethod': RmsTableCtxIdConnectionMethod,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "GetObjectConnections";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ObjectConnectionModel': TypeInfo(TypeOf.Class, create:() => ObjectConnectionModel()),
    'GetObjectConnectionsResponse': TypeInfo(TypeOf.Class, create:() => GetObjectConnectionsResponse()),
    'List<ObjectConnectionModel>': TypeInfo(TypeOf.Class, create:() => <ObjectConnectionModel>[]),
    'GetObjectConnections': TypeInfo(TypeOf.Class, create:() => GetObjectConnections()),
});

Dart GetObjectConnections DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}