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}

"use strict";
export class SaveObjectConnectionResponse {
    /** @param {{ObjectConnectionId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ObjectConnectionId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SaveObjectConnection {
    /** @param {{FromObjectId?:string,ToObjectId?:string,RmsTableCtxIdConnectionMethod?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description 'From' object ID in the connection. */
    FromObjectId;
    /**
     * @type {string}
     * @description 'To' object ID in the connection. */
    ToObjectId;
    /**
     * @type {string}
     * @description Guid representing the Connection Method to use to connect the objects with. */
    RmsTableCtxIdConnectionMethod;
}

JavaScript SaveObjectConnection DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}