Platform API

UpdateDimensionStatus

Archives or Restores a Dimension record.

The following routes are available for this service:
PUT	/api/dimensions/{DimensionId}/archive
PUT	/api/dimensions/{DimensionId}/restore

"use strict";
export class UpdateDimensionStatus {
    /** @param {{DimensionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description DimensionId of the dimension to have its status changed */
    DimensionId;
}

JavaScript UpdateDimensionStatus DTOs

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

HTTP + OTHER

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

PUT /api/dimensions/{DimensionId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"DimensionId":"00000000-0000-0000-0000-000000000000"}

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

{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}