| All Verbs | /api/dimensions/object/{ObjectId} |
|---|
"use strict";
export class DimensionValueModel {
/** @param {{DimensionValueId?:string,DimensionId?:string,Name?:string,Description?:string,ShortName?:string,TrafficLightId?:string,TrafficLightColour?:string,ObjectConnectionId?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Id of the dimension value. */
DimensionValueId;
/**
* @type {string}
* @description Dimension Id this value is for. */
DimensionId;
/**
* @type {string}
* @description Name of the dimension value. */
Name;
/**
* @type {string}
* @description Description of the dimension value. */
Description;
/**
* @type {string}
* @description Short Name for the dimension value. */
ShortName;
/**
* @type {string}
* @description Id of the colour associated. */
TrafficLightId;
/**
* @type {string}
* @description Colour associated with the dimension value. */
TrafficLightColour;
/**
* @type {string}
* @description Id that links this dimension value to an object. */
ObjectConnectionId;
/**
* @type {string}
* @description Owner Id of the dimension value. */
OwnerContactId;
/**
* @type {string}
* @description Record status of the dimension value. */
RecordStatus;
}
export class DimensionModel {
/** @param {{DimensionId?:string,Name?:string,Description?:string,ShortName?:string,HasTrafficLightForValues?:boolean,HasImage?:boolean,OwnerContactId?:string,RecordStatus?:string,DimensionValues?:DimensionValueModel[],ObjectConnectionId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Id of the Dimension itself. */
DimensionId;
/**
* @type {string}
* @description Dimension name. */
Name;
/**
* @type {string}
* @description Dimension description. */
Description;
/**
* @type {string}
* @description Dimension shortened name. */
ShortName;
/**
* @type {boolean}
* @description True if the values for the dimension should have colours associated with them. */
HasTrafficLightForValues;
/** @type {boolean} */
HasImage;
/**
* @type {string}
* @description Owner Id of the dimension. */
OwnerContactId;
/**
* @type {string}
* @description Record status of the dimension. */
RecordStatus;
/**
* @type {DimensionValueModel[]}
* @description Dimension values for this dimension. */
DimensionValues;
/**
* @type {string}
* @description Id that links this dimension to an object. */
ObjectConnectionId;
}
export class GetObjectDimensionsResponse {
/** @param {{Dimensions?:DimensionModel[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {DimensionModel[]}
* @description List of dimensions. */
Dimensions;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetObjectDimensions {
/** @param {{LicenseeId?:string,ObjectId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Licensee Id to retrieve dimensions for. */
LicenseeId;
/**
* @type {string}
* @description Object Id to retrieve dimensions for. */
ObjectId;
}
JavaScript GetObjectDimensions 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.
POST /api/dimensions/object/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Dimensions:
[
{
Name: String,
Description: String,
ShortName: String,
HasTrafficLightForValues: False,
HasImage: False,
RecordStatus: String,
DimensionValues:
[
{
Name: String,
Description: String,
ShortName: String,
TrafficLightColour: String,
RecordStatus: String
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}