This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Load an existing GenerationJob. This is used to monitor job progress.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:notepad-write.
stringThe unique identifier for a Template
stringThe unique identifier for a GenerationJob
objectstringThe unique identifier for a GenerationJob
unionThe status of a GenerationJob
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/notepad/templates/ri.notepad.main.notepad-template.bef90a51-d37d-4983-abde-56e5bd0fcf52/generationJobs/ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c?preview=true"1
2
3
4
5
6
{
"rid": "ri.notepad.main.generation-job.ab12c039-353c-4555-9704-eacfdfaa2c1c",
"status": {
"type": "running"
}
}| Error Name | ||
|---|---|---|
Generation | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given GenerationJob could not be found. | |
| Parameters | generationJobRid, templateRid | |
See Errors for a general overview of errors in the platform.