| Feature | Version | |
|---|---|---|
| data-extractor | 2 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Specifies the quantity of jobs to request. If unspecified, the 30 most recent jobs will be requested.
Default value: 30
Specifies to return the "n" (30 being default, see jobCount) jobs prior to the given jobId. If unspecified, the "n" most recent jobs will be requested.
Specifies the way the data should be populated for the response.
Default value: status
Required
A list of jobs.Required
The name of the job.
Required
The user ID that was used to submit the job.
Required
The unique ID associated with the job. This value is set by the server at the time the job is created.
Required
The site ID associated with the user who submitted the job.
The datetime the job was submitted.
The datetime the job was queued.
The datetime the job was canceled.
The datetime the job finished.
The datetime the job started.
The datetime the job failed.
The datetime the job last changed state.
The user ID that cancelled the job.
The output path where the extracted files were saved to.
Additional error information.
When the job has been submitted.
When the job has been queued.
When the job has been started.
If the job failed.
If the job was canceled.
When the job has finished.
Required
The name of the job.
Required
The user ID that was used to submit the job.
The unique ID associated with the job. This value is set by the server at the time the job is created.
Required
A list of tables.Required
The name of the table.
The value represented by this property should be treated as case-insensitive.
The column used to filter the table using a datetime.
The column used to filter the table using one or more site IDs.
Required
Required
The name of the column.
Required
A list of views.Required
The name of the view.
The column used to filter the view using a datetime.
The column used to filter the view using one or more site IDs.
Required
list of columns.
The lower bounds datetime UTC value utilized to filter the extraction job.
The upper bounds datetime UTC value utilized to filter the extraction job.
The list of site IDs used for filtering the data in the extraction job.
The site ID.
Required
A message that describes the current error.Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.| Feature | Version | |
|---|---|---|
| data-extractor | 2 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The name of the job.
Required
The user ID that was used to submit the job.
The unique ID associated with the job. This value is set by the server at the time the job is created.
Required
A list of tables.Required
The name of the table.
The value represented by this property should be treated as case-insensitive.
The column used to filter the table using a datetime.
The column used to filter the table using one or more site IDs.
Required
Required
A list of views.Required
The name of the view.
The column used to filter the view using a datetime.
The column used to filter the view using one or more site IDs.
Required
list of columns.
The lower bounds datetime UTC value utilized to filter the extraction job.
The upper bounds datetime UTC value utilized to filter the extraction job.
The list of site IDs used for filtering the data in the extraction job.
The site ID.
Required
The ID of the extraction job. This value is assigned by the server.
Required
A message that describes the current error.Required
A message that describes the current error.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"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.