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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Creates or Updates a new connection between two objects.
    */
    @Api(Description="Creates or Updates a new connection between two objects.")
    public static class SaveObjectConnection
    {
        /**
        * '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;
        
        public UUID getFromObjectId() { return FromObjectId; }
        public SaveObjectConnection setFromObjectId(UUID value) { this.FromObjectId = value; return this; }
        public UUID getToObjectId() { return ToObjectId; }
        public SaveObjectConnection setToObjectId(UUID value) { this.ToObjectId = value; return this; }
        public UUID getRmsTableCtxIdConnectionMethod() { return RmsTableCtxIdConnectionMethod; }
        public SaveObjectConnection setRmsTableCtxIdConnectionMethod(UUID value) { this.RmsTableCtxIdConnectionMethod = value; return this; }
    }

    @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
    public static class SaveObjectConnectionResponse
    {
        public UUID ObjectConnectionId = null;
        public ResponseStatus ResponseStatus = null;
        
        public UUID getObjectConnectionId() { return ObjectConnectionId; }
        public SaveObjectConnectionResponse setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SaveObjectConnectionResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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"}}}