Get Control Parameters

post

/config/sim/v2/setup/getControlParameters

Gets Control Parameters

Request

Supported Media Types
Body ()
The input body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • If specified, limits the data returned to these fields.
    Example: hierUnitId, guestCountConfirmationThreshold, openCheckAgeThreshold
  • If this value is specified, the include parameter is ignored.
    Value Description
    basic Forces the response to include all fields except option string details.
    detailed Forces the response to include all fields including option string details.
    Example: detailed
  • If using paging, number of results returned in this page.
    Example: 100
  • Starting resource record index.
    Example: 0
  • Sorts the response by the specified field name and sort order. Allowed fields are all public fields.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria. Allowed fields are all public fields.
    Example: where equals(hierUnitId, 3599)
Back to Top

Response

Supported Media Types

200 Response

A collection of Control Parameters.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Control Parameters objects.
Show Source
Nested Schema : ControlParameters
Type: object
Control Parameters record.
Show Source
Nested Schema : ControlParametersOptionsExt
Type: object
Read Only: true
Read-only helper object derived from options. Bit positions are 1-based. Bits 49 gates bits 50-61; bit 54 requires one of bits 50, 51, or 52; bit 61 requires one of bits 56, 57, or 58; bit 65 requires bit 36.
Show Source
Nested Schema : ControlParametersReportsDefaultViewExt
Type: object
Read Only: true
Read-only helper object derived from reportsDefaultView. Bit position equals report id. True means Revenue Center view; false means Property view.
Show Source
Back to Top