Sign in
Library

Add a global to a project

Add a workspace global to a project. Adding it again keeps project edits. Use reset=true to restore workspace values.

post/projects/{projectId}/library/globals

Request

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

Path parameters

projectIdstring required

Project ID or slug.

Query parameters

resetboolean

Restore workspace values and replace project edits.

Request body

sourceIdstring required

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

Example request

{
  "sourceId": "txn_8f2a1c9e"
}

Response

The existing 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.