Library

Get a project global

get/projects/{projectId}/library/globals/{globalId}

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/projects/{projectId}/library/globals/{globalId}
Auth: HTTP bearer

Path parameters

projectIdstring required

Project ID or slug.

globalIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Query parameters

expandLibraryExpand[]

Comma list of related data to inline on a project copy (depth ≤ 2). Unknown key returns 400 expand_invalid.

Response

The project global.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

symbolstring nullable required

descriptionstring nullable required

formulastring nullable required

unitstring nullable

customUnitIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

phaseOverridesobject nullable

sourceType'workspace' | 'saturation' required

Where the project Library item came from.

sourceIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example response

{
  "id": "txn_8f2a1c9e",
  "customUnitId": "txn_8f2a1c9e",
  "sourceId": "txn_8f2a1c9e",
  "source": {
    "id": "txn_8f2a1c9e",
    "customUnitId": "txn_8f2a1c9e"
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.