Expand All Collapse All

/icws/{sessionId}/connection/switchover-status

Feature Version
connection 11

GET

/icws/{sessionId}/connection/switchover-status

Queries for switchover status on the server.
Feature Version
connection 11

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

        200 - OK
        The switchover status was successfully retrieved and is available in the entity body.
        switchoverStatus
        Expand AllCollapse All
        Property
        Value
        Comments
        isSwitchoverActive
        Boolean

        Required

        Indicates whether the IC deployment is configured as a switchover pair.
        primaryHost
        String

        Required

        The host name of the current primary server of a switchover pair. For non-switchover deployments, this will be the host name of the stand-alone server.
        backupHost
        String
        The host name of the current backup server of a switchover pair.
        isBackupICStopping
        Boolean
        Indicates whether the backup IC server is stopping.
        isBackupICStarting
        Boolean
        Indicates whether the backup IC server is starting.
        isManualSwitchOnly
        Boolean
        Indicates whether the backup IC server is in manual switch only mode.
        active
        0
        upgradeLower
        1
        upgradeHigher
        2
        upgradeHigherManual
        3
        backupVersion
        String
        The backup server's IC version. For example "CIC 2015 R2 Patch6".
        subsystemsDown
        List [Unbounded]: String
        A list of subsystems that are currently down on the backup server.
        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.