DeveloperAPI ReferenceJobs
/api/jobs
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/jobs" \ -H "Content-Type: application/json" \ -d '{ "type": "string" }'{
"job": {
"id": "string",
"type": "scan",
"libraryId": "string",
"pluginId": "string",
"status": "pending",
"priority": 0,
"payload": {
"property1": null,
"property2": null
},
"result": {
"property1": null,
"property2": null
},
"progress": 0,
"errorMessage": "string",
"createdAt": "string",
"startedAt": "string",
"completedAt": "string"
}
}{
"error": "string"
}