Releases

Lists entity instances across all releases (and base).

Lists entity instances across all releases (and base). Default to draft state if entity supports it.

get/api/v1/entity-releases

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/entity-releases
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

projectIdstring uuid required
idstring uuid required

Matches entity by their ID

definitionType'composition' | 'entry' required

Entity type (i.e. composition, entry, ...). NOTE: New values may be added to this list without being considered a breaking API change

releaseStatesReleaseState[]

Matches entity instances where their release state is one of a list. NOTE: base instance, when present, is always included in the results.

offsetinteger

Number of records to skip

limitinteger

Maximum number of records to return

Response

List of entity instances across all releases (and base).

totalCountinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.