Platform API

<back to all web services

UpdateDimensionStatus

Archives or Restores a Dimension record.

Requires Authentication
The following routes are available for this service:
PUT/api/dimensions/{DimensionId}/archive
PUT/api/dimensions/{DimensionId}/restore
import Foundation
import ServiceStack

/**
* Archives or Restores a Dimension record.
*/
// @Api(Description="Archives or Restores a Dimension record.")
public class UpdateDimensionStatus : Codable
{
    /**
    * DimensionId of the dimension to have its status changed
    */
    // @ApiMember(Description="DimensionId of the dimension to have its status changed", Name="DimensionId")
    public var dimensionId:String

    required public init(){}
}

Swift UpdateDimensionStatus 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.

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

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

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

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