Show progress of a job
How far a job is that another route started, by its job_token.
Returns the status of a background job of the account - a restart or snapshot of a virtual server, a database copy and the like - by the job_token the route that started it answered (job_token_malformed if it is not one). status pending or running: not finished yet; succeeded: finished; failed: it failed, result.error_list may say why. result holds what the job left once finished - an installed application's administrator and where to log in, the versions of an update. Refused when the access may not see the package or server the job works on (permission_missing, primary_access_required), and when there is no such job (resource_not_found). Changes nothing.
manitu_job_get on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Shows the status of a background job (how far it is) that a manitu tool started in the manitu customer account this connection works in - a restart or snapshot of a virtual server, a database copy and the like - by the job_token that tool answered, passed as it is. status pending or running: not finished yet - wait and ask again, not more often than about once a minute; some take many minutes. succeeded: finished. failed: it failed - tell the user, do not simply start it again (result.error_list may say why). result has what it left for the user once finished - an installed application's administrator and where to log in, the versions of an update. Refused (forbidden) when this access may not see the package or server the job works on. The token is a secret of this job: never show it.
Reasons it may answer: resource_not_found, permission_missing, primary_access_required, job_token_malformed.
Arguments
job_token (required)stringwrite-onlyThe job_token the starting tool answered - passed as it is, never built.
Result structuredContent, checked against the schema
kindstring | nullWhat is being done, a lower_snake_case code of the backend, e.g. power_reboot - its values are the backend's own, an open set. null where the backend does not name it.
job_idstring | nulloptionalThe id of this run, where the backend keeps one; null otherwise.
statusanypending: waiting to start; running: started, not finished; succeeded: finished, everything went through; failed: finished, but it or part of it failed. cancelled is reserved and not sent.
created_atstring | nullWhen it was asked for.
started_atstring | nulloptionalWhen it started; null while pending, and where the backend does not record it.
ended_atstring | nulloptionalWhen it finished; null until then.
updated_atstring | nulloptionalWhen it last changed.
job_tokenstring | nullWhat the operation that follows a job takes to find this one - passed as it is, never built or changed. A secret of this job: not to be shown to anyone. null where there is none.
resultobject | nullWhat it left for the user, when it is finished - null for a job that keeps none.
result.adminobject | nullThe administrator of an application manitu installed.
result.admin.usernamestringresult.admin.passwordstring | nullA secret; null where it is withheld (secrets_withheld).
result.admin.mail_addressstringresult.administration_urlstring | nullWhere an installed application is administered.
result.versionobject | nullThe versions of an application update.
result.version.oldstring | nullresult.version.newstring | nullresult.dumpobject | nullThe dump files a database copy wrote, relative to the package.
result.dump.sourcestring | nullresult.dump.targetstring | nullresult.error_listarray of stringWhy it failed, as codes - e.g. quota_exceeded, extra_files_found, nextcloud_too_old.
secrets_withheldbooleanA secret in result is left out here (an answer to an agent).
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
job_token (required)stringwrite-onlyThe job_token the starting tool answered - passed as it is, never built.
Response in data; the rest of the body as on every call
kindstring | nullWhat is being done, a lower_snake_case code of the backend, e.g. power_reboot - its values are the backend's own, an open set. null where the backend does not name it.
job_idstring | nulloptionalThe id of this run, where the backend keeps one; null otherwise.
statusanypending: waiting to start; running: started, not finished; succeeded: finished, everything went through; failed: finished, but it or part of it failed. cancelled is reserved and not sent.
created_atstring | nullWhen it was asked for.
started_atstring | nulloptionalWhen it started; null while pending, and where the backend does not record it.
ended_atstring | nulloptionalWhen it finished; null until then.
updated_atstring | nulloptionalWhen it last changed.
job_tokenstring | nullWhat the operation that follows a job takes to find this one - passed as it is, never built or changed. A secret of this job: not to be shown to anyone. null where there is none.
resultobject | nullWhat it left for the user, when it is finished - null for a job that keeps none.
result.adminobject | nullThe administrator of an application manitu installed.
result.admin.usernamestringresult.admin.passwordstring | nullA secret; null where it is withheld (secrets_withheld).
result.admin.mail_addressstringresult.administration_urlstring | nullWhere an installed application is administered.
result.versionobject | nullThe versions of an application update.
result.version.oldstring | nullresult.version.newstring | nullresult.dumpobject | nullThe dump files a database copy wrote, relative to the package.
result.dump.sourcestring | nullresult.dump.targetstring | nullresult.error_listarray of stringWhy it failed, as codes - e.g. quota_exceeded, extra_files_found, nextcloud_too_old.
secrets_withheldbooleanA secret in result is left out here (an answer to an agent).
Statuses
200Success.400The input is wrong, or the request itself (INVALID_INPUT). Each entry names its field and its reason - correct the input and call again.401No credential was presented, or it was not recognised (UNAUTHENTICATED).403The credential is valid, but may not do this (PERMISSION_DENIED). The reason says why - another credential is the way, not a repeat.404What the call names does not exist, or not for this caller (NOT_FOUND). Look it up again - do not guess another.429Too many calls. The Retry-After header says when to try again.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.Errors reasons it is known to fail with - all of them
resource_not_foundWhat the call names does not exist in the account, or not for this access.NOT_FOUNDpermission_missingThis access lacks a permission the call needs; the main access of the account can grant it.PERMISSION_DENIEDprimary_access_requiredOnly the main access of the account may see this job.PERMISSION_DENIEDjob_token_malformedThe job_token is none - pass it as the starting tool answered it.INVALID_INPUT