/icws/{sessionId}/messaging/subscriptions/ipa/pas

PUT

/icws/{sessionId}/messaging/subscriptions/ipa/pas

IPA License Requirements: An IPA license is not required to call this method.

This method creates a subscription for information regarding Process Automation Server (PAS). Use the messaging API to retrieve any message representations that are provided by the server when the run state of PAS changes.

The server will provide representations when the watch is initially established, or any time pertinent information such as the current run state of PAS is changed. This API will initially include only information about the current run state of PAS (Running, Shutting Down, Shutdown). But, in the future, it is likely that it will be extended to include additional information such as what operations are currently being accepted by PAS (able to launch, able to do pickups, etc.) and indications about PAS warning and error conditions (running low on diskspace, running low on memory, PAS overloaded with too many processes, etc.).

Feature Version
ipa 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

        200 - OK

        The watch subscription to Process Automation Server status has been created. Expect a message object soon that will contain the initial run state.

        Associated Message

        Process Automation Server (PAS) has changed run state.

        pasSubscriptionEventArgs
        Property
        Value
        Comments
        __type
        "urn:inin.com:ipa:pasSubscriptionEventArgs"

        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.

        none
        0
        running
        1
        shuttingDown
        2
        down
        3
        401 - Unauthorized

        Invalid session token in 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.
        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.
        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/ipa/pas

        IPA License Requirements: An IPA license is not required to call this method.

        This method removes the subscription for information regarding Process Automation Server (PAS). Once the subscription is removed, PAS will not send any additional events -- not even to close a page that was still open.

        Feature Version
        ipa 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 watch subscription to information regarding Process Automation Server (PAS) has been removed.

              404 - Not Found

              The watch subscription to information regarding Process Automation Server (PAS) run state does not exist for this session.

              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.
              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.