Skip to main content
GET
Get a factory task by ID
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/factories/getTask?id= returns one FactoryTaskDetail: the FactoryTask fields, including assigneeName, createdBy and github, plus description (null when the task has none). You see a task only through its factory: the task must belong to a factory, and you must hold factories:read at that factory’s home org unit or an org unit above it. A task with no factory is never returned. A missing, malformed, or unreadable ID, or a task with no factory, is 404 resource_missing with the message Task not found. The response does not say which. assigneeName is the holder’s name when Forge knows it, else null. createdBy is the creator’s recorded identity. github holds the linked pullRequest number, issue number and commitSha, each null when unset, and is null when the task has no GitHub link. A person assignee’s ID, the project, and other task links are not returned. The task writes return the same FactoryTaskDetail. Tasks are written with createTask, updateTask, assignTask and transitionTask. Starting factory work is done by a person in Console.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

taskId
string
required

Response

Factory task detail

data
object
required

A factory task with its description (null when it has none). Tasks are written with createTask, updateTask, assignTask and transitionTask; starting factory work is done by a person in Console.

meta
object
required