Release a held job
Changed onAdmin only. Restores a held job to pending status.
Request
- Base URLhttps://localhost/index.php/api
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Response
Job released
Example response
{
"status": "success",
"job": {
"payload": {
"project_id": 123,
"options": {}
},
"result": {
"pdf_path": "/path/to/project_123.pdf",
"project_id": 123,
"generated_at": "2025-01-11 16:30:45"
}
}
}Changes
- breaking
added to the
/response propertyoneOflist for the response status - breaking
added to the
/response propertyoneOflist for the response status - breaking
the
/response's property type changed fromobjectto no type for status - breaking
the
/response's property type changed fromobjectto no type for status - warning
added the new
generate_microdata_resourceenum value to the/response property for the response status - warning
added the new
generate_pdfenum value to the/response property for the response status - warning
added the new
hello_worldenum value to the/response property for the response status - warning
added the new
import_indicator_dataenum value to the/response property for the response status - warning
added the new
import_microdataenum value to the/response property for the response status - warning
added the new
publish_projectenum value to the/response property for the response status
- breaking
- info
endpoint added
- info