Get Report Parameters

post

/config/sim/v2/setup/getReportParameters

Gets Report 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, options
  • 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.
    Example: hierUnitId:asc
  • If specified, returns records that match the criteria.
    Example: where equals(hierUnitId, 3599)
Back to Top

Response

Supported Media Types

200 Response

A collection of Report Parameters.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Array of Report Parameters objects.
Show Source
Nested Schema : ReportParameters
Type: object
Report Parameters record.
Show Source
Nested Schema : ReportParametersOptionsExt
Type: object
Read Only: true
Read-only helper object derived from options. Bit positions are 1-based.
Show Source
Back to Top