Get Job DLQ Messages

Required capabilities: hostedExtractors:READ rawAcl:READ

List dead letter queue (DLQ) messages for a job. These are messages the job failed to transform. They are stored in CDF RAW. The dead letter queue must be enabled for the job. See dlqEnabled in the update jobs endpoint. If it is not enabled, the request fails with status 400 and the message DLQ is not enabled for job '<externalId>'. This request uses the caller's credentials to read the messages, so the caller needs read access to RAW in addition to hostedExtractors:READ. If RAW rejects the request, the 401 or 403 status is passed through to the caller. Errors from the underlying storage are returned with status codes 400 (e.g., invalid cursor), 429 (rate limited), 502 (storage unavailable), or 504 (storage timed out). A 404 is returned if the job does not exist.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
query Parameters
job
required
string (Job)

External ID of the job to return DLQ messages for.

limit
integer [ 1 .. 1000 ]
Default: 100

Limits the number of results to be returned. The maximum results returned by the server is 1000 even if you specify a higher limit.

cursor
string

Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that value as the cursor parameter in the next request.

Note that the cursor may or may not be encrypted, but either way, it is not intended to be decoded. Its internal structure is not a part of the public API, and may change without notice. You should treat it as an opaque string and not attempt to craft your own cursors.

Example: cursor=4zj0Vy2fo0NtNMb229mI9r1V3YG5NBL752kQz1cKtwo
minLastUpdatedTime
integer <int64> (EpochTimestamp) >= 0

Only return messages last updated at or after this time, in milliseconds since epoch. Must not be greater than maxLastUpdatedTime.

Example: minLastUpdatedTime=1730204346000
maxLastUpdatedTime
integer <int64> (EpochTimestamp) >= 0

Only return messages last updated at or before this time, in milliseconds since epoch.

Example: maxLastUpdatedTime=1730204346000
Responses
200

List of retrieved DLQ messages and an optional cursor.

400

Response for a failed request. This includes the case where the dead letter queue is not enabled for the job.

422

Validation Error

get/hostedextractors/jobs/dlq
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to Get Job Logs