Expand All Collapse All

/icws/{sessionId}/statistics/statistic-parameter-values/queries

POST

/icws/{sessionId}/statistics/statistic-parameter-values/queries

Executes a query for parameter values. The created resource (query results) is not stored on the server, but returned in the response.
Feature Version
statistics 1

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Representations
        parameterValueQuery
        Expand AllCollapse All
        Property
        Value
        Comments
        parameterTypeId
        String

        Required

        filter
        String
        This member is used to search. Only parameter values containing the string will be returned. If set to an empty string or not included, the default is to retrieve all parameter values for the specified parameterTypeId.
        maxToReturn
        Int
        Allows clients to limit the number of parameter values returned. If there are more items than specified, totalResultsAvailable will be set in the response.
        parameterTypeId
        String

        Required

        This member needs to match the ID of a parameter type exactly.
        value
        String

        Required

        This member either needs to match a parameter value exactly or be set to an empty string to use a default value.

        Response

        200 - OK
        The result set of the query is included in the response.
        parameterValueQueryResults
        Expand AllCollapse All
        Property
        Value
        Comments
        totalResultsAvailable
        Int
        This member is only included if there are more items available.

        Multiple options:

        The value can be assigned any of the following options.
        value
        String

        Required

        A possible value for the parameter.
        displayString
        String

        Required

        A user friendly string for display purposes.
        description
        String

        Required

        The description for the parameter value.
        __type
        "urn:inin.com:statistics:qualifiedParameterValue"

        Required

        The JSON type representing this option.
        value
        String

        Required

        A possible value for the parameter.
        displayString
        String

        Required

        A user friendly string for display purposes.
        description
        String

        Required

        The description for the parameter value.
        parameterTypeId
        String

        Required

        The ID of the parameter type.
        400 - Bad Request
        Invalid parameter value was specified or the query is not supported.
        error
        Provides additional detail for an error.
        Expand AllCollapse All
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        401 - Unauthorized
        The specified session token is missing, invalid, or has expired.
        Parameters
        Type
        Name
        Comments
        Header
        WWW-Authenticate

        Required

        Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

        WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

          error
          Provides additional detail for an error.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          410 - Gone
          This resource has been deprecated and removed from the API.
          error
          Provides additional detail for an error.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          500 - Internal Server Error
          An unexpected error occurred while processing the request.
          error
          Provides additional detail for an error.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.