Skip to main content
GET
List a factory's assignments
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/listAssignments?factoryId=&status=&cursor=&limit= returns one page of the projects, workflows and tasks assigned to a factory as FactoryAssignment objects. Without status only ACTIVE assignments are listed; pass COMPLETED or CANCELLED for the others. Paging follows the same rules as List factories: limit defaults to 50, its maximum (a larger value is 400 too_big), and you follow meta.nextCursor while meta.hasMore is true. You must hold factories:read at the factory’s home org unit or an org unit above it. A missing, malformed, or unreadable factoryId is 404 resource_missing with the message Factory not found. An assignment of a project or workflow you may not read (factories:read at its home) is left out of the page, so a page can hold fewer rows than limit, or none, while meta.hasMore is still true. Exactly one of projectId, workflowId and taskId is set, matching assignmentType. completedAt is null until the assignment ends. An unknown status, a repeated parameter, or a malformed limit or cursor is 400 bad_request.

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

factoryId
string
required

Query Parameters

status
enum<string>
default:ACTIVE

Only assignments in this status.

Available options:
ACTIVE,
COMPLETED,
CANCELLED
limit
integer
default:50

Rows to read for this page, 1 to 50; a larger value is 400 too_big.

Required range: 1 <= x <= 50
cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1

Response

Assignment page

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.