at.happyproto.server.getJob
One of the caller's own background jobs, such as the one a change to an instance started. Customers only.
Details · query
| Kind | query |
|---|---|
| Authority | server.happyproto.at |
| Indexed |
Checks
Validunlimited-stringdefs.job.properties.errorNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.job.properties.idNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.job.properties.statusNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.parameters.properties.idNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"job": {
"description": "A background job. Never carries its session fields.",
"properties": {
"error": {
"description": "Why the job failed. For an instance change, the operation's error code, then its message.",
"type": "string"
},
"id": {
"description": "A UUID.",
"type": "string"
},
"progress": {
"description": "The job's last progress report. For an instance change: {status, step?}, the operation's.",
"type": "unknown"
},
"result": {
"description": "What the job returned, once completed.",
"type": "unknown"
},
"status": {
"knownValues": [
"pending",
"running",
"paused",
"pausing",
"cancelling",
"completed",
"failed",
"cancelled"
],
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"main": {
"description": "One of the caller's own background jobs, such as the one a change to an instance started. Customers only.",
"errors": [
{
"description": "This endpoint requires an authenticated caller.",
"name": "AuthRequired"
},
{
"description": "The caller is not a HappyProto customer.",
"name": "Forbidden"
},
{
"description": "id is not a UUID.",
"name": "InvalidRequest"
},
{
"description": "No such job, or the caller did not create it. The two are indistinguishable.",
"name": "NotFound"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"job": {
"ref": "#job",
"type": "ref"
}
},
"required": [
"job"
],
"type": "object"
}
},
"parameters": {
"properties": {
"id": {
"description": "The job's UUID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "params"
},
"type": "query"
}
},
"id": "at.happyproto.server.getJob",
"lexicon": 1
}