Pikbase Docs
Open console (opens the console)
Esc

Type to search.

API reference

getJobStatus() — Application Service

Summary for 'getJobStatus' not found. Available operations: getById, getCopy, query, queryMapped, save, saveMulti, delete, deleteQuery, saveMappedItems,…

Contract sourcePikbase verified platform contract

Reads the state of an asynchronous platform task. Use it after operations such as installResourcePack return a jobId.

Endpoint

POST /api/task/getJobStatus

{
  "jobId": "returned-job-id"
}

The caller must use the same authorized tenant context that created or owns the task. A job identifier is a correlation value, not authorization.

Polling

Poll with bounded backoff and stop at a terminal success or failure state. Do not treat request acceptance as installation success, and do not start a duplicate installation merely because a task is still pending. Surface the server's terminal failure without logging tokens, credentials, or tenant-sensitive payloads.

Cancellation

Where the task type supports cancellation, use POST /api/task/cancelTask with the same jobId. Cancellation is a separate mutation and may be rejected after the task commits.