Skip to main content
GET
List a factory's release milestones
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/listReleases?factoryId=&limit= returns up to limit release milestones of one factory as FactoryRelease objects, most recently updated first. A milestone is included when a task of the factory points at it, or a task of one of the factory’s projects does. A project is followed only when you hold factories:read at the project’s home org unit. 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. Page with limit and cursor: limit is 1 to 100 and defaults to 50; a larger value is 400 too_big. A malformed limit or a repeated parameter is 400 bad_request. meta.partial is always present: it is true when a read bound stopped the scan, or when milestones past limit were held back. targetDate and releaseVersion are null when unset.

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

limit
integer
default:50

Items per page, 1 to 100 (default 50); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

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

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Release milestone 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.