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 list of job IDs to subscribe for status changes.Required
The JSON type representing this option.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.
Required
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
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
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.