Platform API

<back to all web services

GetObjectConnections

Get object connections for the specified object and connection method.

Requires Authentication
The following routes are available for this service:
GET/api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId}
GET/api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId}
"use strict";
export class ObjectConnectionModel {
    /** @param {{ObjectConnectionId?:string,ObjectIdFrom?:string,ObjectFromReference?:string,ObjectToReference?:string,ObjectIdTo?:string,ConnectionMethodId?:string,ObjectFromName?:string,ObjectToName?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ObjectConnectionId;
    /** @type {string} */
    ObjectIdFrom;
    /** @type {string} */
    ObjectFromReference;
    /** @type {string} */
    ObjectToReference;
    /** @type {string} */
    ObjectIdTo;
    /** @type {string} */
    ConnectionMethodId;
    /** @type {string} */
    ObjectFromName;
    /** @type {string} */
    ObjectToName;
    /** @type {string} */
    RecordStatus;
}
export class GetObjectConnectionsResponse {
    /** @param {{ObjectConnections?:ObjectConnectionModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ObjectConnectionModel[]} */
    ObjectConnections;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetObjectConnections {
    /** @param {{FromObjectId?:string,ToObjectId?:string,RmsTableCtxIdConnectionMethod?:string,RecordStatus?: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;
    /**
     * @type {string}
     * @description Status of object Connections to retrieve, if not specified active connections are retrieved by default. */
    RecordStatus;
}

JavaScript GetObjectConnections 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.

GET /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json

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