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

// @ApiResponse(Description="Success of the create/update of the dimension value")
export class SaveDimensionValueResponse
{
    /** @description Id of the Dimension Value created. */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension Value created.", Name="DimensionValueId", ParameterType="query")
    public DimensionValueId: string;

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SaveDimensionValueResponse>) { (Object as any).assign(this, init); }
}

export class DimensionValueModel
{
    /** @description Id of the dimension value. */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    public DimensionValueId: string;

    /** @description Dimension Id this value is for. */
    // @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    public DimensionId: string;

    /** @description Name of the dimension value. */
    // @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    public Name: string;

    /** @description Description of the dimension value. */
    // @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    public Description: string;

    /** @description Short Name for the dimension value. */
    // @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    public ShortName: string;

    /** @description Id of the colour associated. */
    // @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    public TrafficLightId: string;

    /** @description Colour associated with the dimension value. */
    // @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    public TrafficLightColour: string;

    /** @description Id that links this dimension value to an object. */
    // @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    public ObjectConnectionId: string;

    /** @description Owner Id of the dimension value. */
    // @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    public OwnerContactId: string;

    /** @description Record status of the dimension value. */
    // @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    public RecordStatus: string;

    public constructor(init?: Partial<DimensionValueModel>) { (Object as any).assign(this, init); }
}

/** @description Add or update a dimension values details. */
// @Api(Description="Add or update a dimension values details.")
export class SaveDimensionValue
{
    /** @description Details of the dimension value to be added or updated. */
    // @ApiMember(DataType="DimensionValueModel", Description="Details of the dimension value to be added or updated.", IsRequired=true, Name="DimensionValue")
    public DimensionValue: DimensionValueModel;

    /** @description Id of the dimension value. */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", IsRequired=true, Name="DimensionValueId")
    public DimensionValueId: string;

    public constructor(init?: Partial<SaveDimensionValue>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}