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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Archives or Restores a Dimension record.
    */
    @Api(Description="Archives or Restores a Dimension record.")
    public static class UpdateDimensionStatus
    {
        /**
        * DimensionId of the dimension to have its status changed
        */
        @ApiMember(Description="DimensionId of the dimension to have its status changed", Name="DimensionId")
        public UUID DimensionId = null;
        
        public UUID getDimensionId() { return DimensionId; }
        public UpdateDimensionStatus setDimensionId(UUID value) { this.DimensionId = value; return this; }
    }

}

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