Required capabilities:
hostedExtractors:WRITE
Update a list of up to 100 jobs. Enabling the dead letter queue for a job, or moving a job that has it enabled to a different destination, requires the job's destination credentials to have write access to CDF RAW, in addition to hostedExtractors:WRITE. Before updating, the destination session is refreshed and the DLQ storage for the job is created. The request fails with status 400 if the destination has no session, the session cannot be refreshed, or the session lacks RAW write access. It fails with status 502 if CDF cannot be reached or RAW returns a server error during this check. If the check fails for any job, no jobs in the request are updated. The check is not run for jobs that already have the dead letter queue enabled and keep their destination.
Jobs to update.
required | Array of objects (Items) [ 1 .. 10 ] characters |
List of updated jobs.
The response for a bad request.
Validation Error
{- "items": [
- {
- "externalId": "my.known.id",
- "update": {
- "destinationId": {
- "set": "string"
}, - "format": {
- "set": {
- "type": "rockwell",
- "encoding": "utf8",
- "compression": "gzip",
- "prefix": {
- "fromTopic": true,
- "prefix": "string"
}, - "dataModels": {
- "space": "string"
}
}
}, - "sourceId": {
- "set": "string"
}, - "targetStatus": {
- "set": "running"
}, - "config": {
- "set": {
- "topicFilter": "string"
}
}, - "dlqEnabled": {
- "set": true
}, - "name": {
- "set": "string"
}, - "description": {
- "set": "string"
}, - "metadata": {
- "set": {
- "property1": "string",
- "property2": "string"
}
}
}
}
]
}{- "items": [
- {
- "externalId": "my.known.id",
- "destinationId": "string",
- "sourceId": "string",
- "format": {
- "type": "rockwell",
- "encoding": "utf8",
- "compression": "gzip",
- "prefix": {
- "fromTopic": true,
- "prefix": "string"
}, - "dataModels": {
- "space": "string"
}
}, - "targetStatus": "running",
- "status": "startup_error",
- "config": {
- "topicFilter": "string"
}, - "dlqEnabled": false,
- "createdTime": 1730204346000,
- "lastUpdatedTime": 1730204346000,
- "name": "string",
- "description": "string",
- "metadata": {
- "property1": "string",
- "property2": "string"
}
}
]
}