| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ObjectConnections:
[
{
ObjectFromReference: String,
ObjectToReference: String,
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
}
}
}