Platform API

SaveObjectConnection

Creates or Updates a new connection between two objects.

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

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
class SaveObjectConnectionResponse implements IConvertible
{
    String? ObjectConnectionId;
    ResponseStatus? ResponseStatus;

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

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

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

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

/**
* Creates or Updates a new connection between two objects.
*/
// @Api(Description="Creates or Updates a new connection between two objects.")
class SaveObjectConnection 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;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SaveObjectConnectionResponse': TypeInfo(TypeOf.Class, create:() => SaveObjectConnectionResponse()),
    'SaveObjectConnection': TypeInfo(TypeOf.Class, create:() => SaveObjectConnection()),
});

Dart SaveObjectConnection 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.

POST /api/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FromObjectId":"00000000-0000-0000-0000-000000000000","ToObjectId":"00000000-0000-0000-0000-000000000000","RmsTableCtxIdConnectionMethod":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ObjectConnectionId":"00000000-0000-0000-0000-000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}