/icws/{sessionId}/data-extractor/jobs/{jobId}

GET

/icws/{sessionId}/data-extractor/jobs/{jobId}

Retrieves details of the job.
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.

        Template
        jobId

        Required

        The extraction job ID.

          Query
          jobsResponseMode

          Specifies the way the data should be populated for the response.

          Default value: all

          Options:

          • configuration
          • status
          • all

          Response

          200 - OK
          The job details are included in the entity body.
          Property
          Value
          Comments
          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.

          name
          String

          Required

          The name of the job.

          submittedUserId
          String

          Required

          The user ID that was used to submit the job.

          id
          String

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

          name
          String

          Required

          The name of the table.

          The value represented by this property should be treated as case-insensitive.

          dateTimeFilterColumn
          String

          The column used to filter the table using a datetime.

          siteIdFilterColumn
          String

          The column used to filter the table using one or more site IDs.

          name
          String

          Required

          The name of the column.

          name
          String

          Required

          The name of the view.

          dateTimeFilterColumn
          String

          The column used to filter the view using a datetime.

          siteIdFilterColumn
          String

          The column used to filter the view using one or more site IDs.

          startTimeFilter
          DateTime

          The lower bounds datetime UTC value utilized to filter the extraction job.

          endTimeFilter
          DateTime

          The upper bounds datetime UTC value utilized to filter the extraction job.

          name
          String

          The site ID.

          403 - Forbidden
          The session user does not have permission to query the job.
          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.

            DELETE

            /icws/{sessionId}/data-extractor/jobs/{jobId}

            Cancels a queued or running extraction job.
            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.

                  Template
                  jobId

                  Required

                  The extraction job ID.

                    Response

                    200 - OK
                    The job has been cancelled.
                    403 - Forbidden
                    The session user does not have permission to cancel this job.
                    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.