Platform API

<back to all web services

UpdateDimensionValueStatus

Archives or Restores a Dimension Value record.

Requires Authentication
The following routes are available for this service:
PUT/api/dimensionvalues/{DimensionValueId}/archive
PUT/api/dimensionvalues/{DimensionValueId}/restore
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Archives or Restores a Dimension Value record.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDimensionValueStatus:
    """
    Archives or Restores a Dimension Value record.
    """

    # @ApiMember(Description="DimensionValueId of the dimension value to have its status changed", Name="DimensionValueId")
    dimension_value_id: Optional[str] = None
    """
    DimensionValueId of the dimension value to have its status changed
    """

Python UpdateDimensionValueStatus 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/dimensionvalues/{DimensionValueId}/archive HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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