/icws/{sessionId}/messaging/subscriptions/data-extractor/jobs-statuses

PUT

/icws/{sessionId}/messaging/subscriptions/data-extractor/jobs-statuses

Creates or updates message subscriptions for Data Extractor job statuses.
Feature Version
data-extractor 2

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
        jobStatusSubscription
        Property
        Value
        Comments
        jobIds
        List [1,*]: String

        Required

        The list of job IDs to subscribe for status changes.

        Response

        200 - OK
        The subscription for the Data Extractor job statuses has been updated.
        Associated Message
        The list of job statuses that have changed. Updates will only be sent for jobs that have had a status change.
        jobStatusMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dataExtractor:jobStatusMessage"

        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.

        name
        String

        Required

        The name of the job.

        submittedUserId
        String

        Required

        The user ID that was used to submit the job.

        id
        String

        Required

        The unique ID associated with the job. This value is set by the server at the time the job is created.

        submittedUserSiteId
        Int

        Required

        The site ID associated with the user who submitted the job.

        submitTime
        DateTime

        The datetime the job was submitted.

        queuedTime
        DateTime

        The datetime the job was queued.

        canceledTime
        DateTime

        The datetime the job was canceled.

        finishedTime
        DateTime

        The datetime the job finished.

        startedTime
        DateTime

        The datetime the job started.

        failedTime
        DateTime

        The datetime the job failed.

        stateChangedTime
        DateTime

        The datetime the job last changed state.

        cancelUserId
        String

        The user ID that cancelled the job.

        outputFolder
        String

        The output path where the extracted files were saved to.

        errorInfo
        String

        Additional error information.

        submitted
        0

        When the job has been submitted.

        queued
        1

        When the job has been queued.

        started
        2

        When the job has been started.

        failed
        3

        If the job failed.

        canceled
        4

        If the job was canceled.

        finished
        5

        When the job has finished.

        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/data-extractor/jobs-statuses

          Removes the jobs status subscription.
          Feature Version
          data-extractor 2

          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 jobs status subscription 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.