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.*


/**
* Creates or Updates a new connection between two objects.
*/
@Api(Description="Creates or Updates a new connection between two objects.")
open class SaveObjectConnection
{
    /**
    * 'From' object ID in the connection.
    */
    @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
    open var FromObjectId:UUID? = null

    /**
    * 'To' object ID in the connection.
    */
    @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
    open var ToObjectId:UUID? = 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")
    open var RmsTableCtxIdConnectionMethod:UUID? = null
}

@ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
open class SaveObjectConnectionResponse
{
    open var ObjectConnectionId:UUID? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin SaveObjectConnection DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}