Platform API

<back to all web services

SaveDimensionValue

Add or update a dimension values details.

Requires Authentication
The following routes are available for this service:
PUT/api/dimensionvalues/{DimensionValueId}
POST/api/dimensionvalues
"use strict";
export class SaveDimensionValueResponse {
    /** @param {{DimensionValueId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the Dimension Value created. */
    DimensionValueId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
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 SaveDimensionValue {
    /** @param {{DimensionValue?:DimensionValueModel,DimensionValueId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {DimensionValueModel}
     * @description Details of the dimension value to be added or updated. */
    DimensionValue;
    /**
     * @type {string}
     * @description Id of the dimension value. */
    DimensionValueId;
}

JavaScript SaveDimensionValue DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/dimensionvalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DimensionValue":{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"},"DimensionValueId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DimensionValueId":"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"}}}