/icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

PUT

/icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

Creates or updates message subscription to statistic catalog.
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
        statisticCatalogSubscription
        Property
        Value
        Comments
        statisticCatalogCacheTag
        String
        Tag which will help server determine if client cached statistic catalog is fresh. Client should send this only if it has locally cached a statistic catalog from a statistic catalog message and is sending the tag received from the statisticCatalogCacheTag member (of the statistic catalog message).

        Response

        200 - OK
        The message subscription to statistic catalog has been updated.
        statisticCatalogSubscriptionResponse
        Property
        Value
        Comments
        clientStateIsFresh
        Boolean
        This member explicitly lets the client know whether or not their persisted statistic catalog is fresh or stale. If this member's value is true, there will be no corresponding statistic catalog message sent and the client should instead use their cached statistic catalog. This member will only be present if the statistic catalog subscription request contained a cache tag.
        Associated Message
        The statistic catalog (all categories, definitions, parameter types, ACLs, and licenses) is contained in this message.
        statisticCatalogMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:statistics:statisticCatalogMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        Required

        When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

        When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

        statisticCatalogCacheTag
        String
        This tag represents the state of the session user's accessible categories of the statistic catalog. A client can persist the statistic catalog locally along with this cache tag. If a client chooses to do so, it can then send this cache tag in subsequent statistic catalog subscription requests. If the statistic categories which would be returned are the same, the corresponding statistic catalog message will not be sent and the client can use their cached statistic catalog.
        statisticCategoryId
        String

        Required

        The ID of the statistic category.
        displayString
        String

        Required

        A user friendly string for display purposes.
        description
        String

        Required

        A description of the statistic category.
        statisticIdentifier
        String

        Required

        The ID of the statistic definition.
        displayString
        String

        Required

        A user friendly string for display purposes.
        description
        String

        Required

        A description of the statistic definition.
        unitsDisplayString
        String

        Required

        The display string to define the measurement of units.
        orderedParameterTypeList
        List [Unbounded]: String

        Required

        The types of parameters required in a specific order.
        shouldBeSuppressed
        Boolean

        Required

        Gets a value indicating whether this should be suppressed from direct presentation to the user.

        Multiple options:

        The value can be assigned any of the following options.
        __type
        "urn:inin.com:statistics:statisticBoolValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Boolean

        Required

        __type
        "urn:inin.com:statistics:statisticDoubleValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Double

        Required

        __type
        "urn:inin.com:statistics:statisticDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Duration

        Required

        __type
        "urn:inin.com:statistics:statisticErrorValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        malformedStatisticKey
        1
        unknownStatisticKey
        2
        statisticProviderTooBusy
        3
        other
        99
        __type
        "urn:inin.com:statistics:statisticFiniteDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        stoppedTimeSpan
        Duration
        startTickingTime
        DateTime
        ticking
        Boolean

        Required

        __type
        "urn:inin.com:statistics:statisticFutureDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Duration

        Required

        __type
        "urn:inin.com:statistics:statisticIntValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Int

        Required

        __type
        "urn:inin.com:statistics:statisticPercentValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        Double

        Required

        __type
        "urn:inin.com:statistics:statisticStatusMessageKeyValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        DateTime

        Required

        __type
        "urn:inin.com:statistics:statisticStringValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        String

        Required

        __type
        "urn:inin.com:statistics:statisticTimeDurationValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        DateTime

        Required

        __type
        "urn:inin.com:statistics:statisticTimeStampValue"

        Required

        The JSON type representing this option.
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        value
        DateTime

        Required

        precision
        Int

        Required

        The precision of the data.
        none
        0
        milliseconds
        1
        seconds
        2
        gigabytes
        3
        kilobytes
        4
        percent
        5
        int
        0
        double
        1
        string
        2
        bool
        3
        timeStamp
        4
        timeDuration
        5
        duration
        6
        futureDuration
        7
        finiteDuration
        8
        percent
        9
        statusMessage
        10
        weightedPercent
        11
        error
        12
        suppressInUI
        0
        The statistic should not be displayed in the UI.
        suppressInAlerts
        1
        The statistic should not be used for alerts.
        sortIndex
        Int
        The index used to sort statistics in views.
        expanded
        Boolean
        True if this statistic definition is expanded; otherwise false.
        drillDownId
        String

        Required

        The ID of the drill down.
        typeHint
        String

        Required

        The hint as to what the format is of the drill down data.
        hintString
        String

        Required

        The string that gives a hint as to what this drill down data refers to.
        accessControlRights
        List [Unbounded]: String

        Required

        A list of access rights that the user should have in order to see this catalog.
        licenses
        List [Unbounded]: String

        Required

        A list of the licenses that the user should have in order to see this catalog.
        parameterTypeId
        String

        Required

        The ID of the parameter type.
        displayString
        String

        Required

        A user friendly string for display purposes.
        description
        String

        Required

        The description of the associated parameter type.
        accessControlLists
        List [Unbounded]: String

        Required

        Each of the access control lists returned by this property could be used to fetch parameter values that the Session user is allowed to use. When retrieving available parameter values associated with this ParameterTypeDefinition, the values will be filtered to only include items allowed by these access control lists.
        preserveOrder
        Boolean

        Required

        True if the display order should be preserved; otherwise false.
        400 - Bad Request
        The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
        error
        Provides additional detail for an error.
        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.
          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.
          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.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.

          DELETE

          /icws/{sessionId}/messaging/subscriptions/statistics/statistic-catalog

          Removes message subscription to statistic catalog.
          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.

                Response

                204 - No Content
                The message subscription to statistic catalog has been removed.
                400 - Bad Request
                The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
                error
                Provides additional detail for an error.
                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.
                  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.
                  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.
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.