at.happyproto.server.getJob

happyproto.at

Documentation

One of the caller's own background jobs, such as the one a change to an instance started. Customers only.

main query

One of the caller's own background jobs, such as the one a change to an instance started. Customers only.

Parameters

id string Required

The job's UUID.

Output

Encodingapplication/json
job ref#job Required

No description available.

Errors

AuthRequired This endpoint requires an authenticated caller.
Forbidden The caller is not a HappyProto customer.
InvalidRequest id is not a UUID.
NotFound No such job, or the caller did not create it. The two are indistinguishable.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The job's UUID.
View raw schema 
{
  "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"
}
job object

A background job. Never carries its session fields.

Properties

error string Optional

Why the job failed. For an instance change, the operation's error code, then its message.

id string Required

A UUID.

progress unknown Optional

The job's last progress report. For an instance change: {status, step?}, the operation's.

result unknown Optional

What the job returned, once completed.

status string Required

No description available.

Known values: pending, running, paused, pausing, cancelling, completed, failed, cancelled
View raw schema 
{
  "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"
}

Lexicon Garden

@