Expand All Collapse All

/icws/{sessionId}/response-management

Feature Version
response-management 4

PUT

/icws/{sessionId}/response-management

Updates a user's response management library.
Feature Version
response-management 4

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
        responseManagementLibrary
        Expand AllCollapse All
        Property
        Value
        Comments
        id
        Guid

        Required

        The identifier for the library.
        name
        String

        Required

        The name for the library.

        Note

        The name will always be the user's ID.

        description
        String
        The description for the library.
        id
        Guid

        Required

        The identifier for the category.
        name
        String

        Required

        The name for the category.
        categories
        List [Unbounded]: Complex Type: responseManagementCategory

        Recursive

        A list of categories contained in the category.
        id
        Guid

        Required

        The identifier for the item.
        name
        String

        Required

        The name for the item.
        Text
        0
        URL
        1
        File
        2
        shortcut
        String
        The shortcut for the item.
        keywords
        List [Unbounded]: String
        The keywords for the item.
        value
        String

        Required

        The value for the item.

        Response

        204 - No Content
        The user's response management library has been updated. Any response management subscriptions will receive updates as a result of this operation. These updates will include a cacheTag for this update.
        Feature Version
        response-management 3
        403 - Forbidden
        The user is not authorized to use response management.
        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.
        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.
        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.