/icws/{sessionId}/messaging/subscriptions/ipa/launchable-processes

PUT

/icws/{sessionId}/messaging/subscriptions/ipa/launchable-processes

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

This method creates a subscription for the list of process definitions that are launchable by the user associated with the current session. Use the messaging API to retrieve any message representations that are provided by the server when the list of launchable processes changes.

The server will provide representations when the subscription is initially established, when a process definition becomes launchable or unlaunchable, or when the description of the process definition changes. A process definition may become launchable when it is initially published, when the it gets changed to the active state, or when ACLs are changed such that the user now has rights to launch a new process instance from that process definition. Similarly, a process becomes unlaunchable if the process definition is deleted or deactivated, or if the ACLs are changed such that the user no longer has access to launch a new process instance for that process definition.

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 the list of launchable processes for the current user has been created. Expect a message representation soon if the user has one or more launchable processes.

        Associated Message

        The list of launchable processes for the current user has changed.

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

        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.

        processDefinitionId
        String

        Required

        This is the ID associated with the process definition. This ID does not change as new revisions of the process are created, modified or published.

        revision
        String

        Required

        This is the revision of the process indicated by the processDefinitionId. Each different published version of the same process will have the same processDefinitionId, but will have a different revision.

        name
        String

        Required

        This is the current name of the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current name.

        description
        String

        Required

        This is the current description the process definition indicated by the processDefinitionId. All revisions of the process definition with the same processDefinitionId share the same current description.

        removed
        List [Unbounded]: String

        This property contains the list of IDs for the process definitions that were previously launchable by the current user, but are no longer launchable by that user. The process may have been deactivated or deleted, the user may no longer have the appropriate ACLs, etc.

        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/launchable-processes

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

        This method removes the subscription for the list of processes that are launchable by the user associated with the current session.

        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 the list of launchable processes for the current user has been removed.

              404 - Not Found

              The watch subscription to the list of launchable processes for the current user 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.