Project Map

Called to get a list of nodes belonging to a specific path or Id.

Called to get a list of nodes belonging to a specific path or Id.

Note on branch-scoped permissions: if the caller's role has a branch-scoped PrmNodeRead policy (i.e. read access is configured for specific project map branches only), the response is filtered server-side to nodes within those branches. Consumers should not assume the response contains the entire project map. Users with unscoped PrmNodeRead, PrmSchema, or composition-level read permissions receive the full set (backward-compatible behavior).

get/api/v1/project-map-nodes

Request

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

Query parameters

projectMapIdstring uuid

The project map id that the desired nodes belong

projectIdstring uuid required

The project id that contains the project map tree that this node belongs to

releaseIdstring uuid

The ID of a release to fetch the composition data for.

  • When unspecified, composition data is fetched from base.
  • When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.

Content copied to a release can be differentiated from base content by the releaseId property on the content. If the content is not copied to the release, this property will not be defined

idstring uuid

The id of the node to retrieve, cannot have both this parameter and path

pathstring

The path of the root node to retrieve, cannot have both this parameter and id

compositionIdstring uuid

Composition id to find associated project map node for

limitinteger

Limit the number or records returned by a number

offsetinteger

Number of records to skip before returning nodes

depthinteger

Depth of the tree to fetch. This only applies when fetching by path

statenumber

State of compositions to fetch. 0 = draft, 64 = published

treeboolean

should the data be returned as a json tree object (or a flat array)

searchstring

text search filter

includeAncestorsboolean

Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves. Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated

expandedboolean

include expanded helper computed properties, including isLeaf, parentPath, pathSegment etc

withCompositionDataboolean

include basic composition information. ID, type, state, name, and definition id

withCompositionUIStatusboolean

Returns the UI status string of the composition. This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data

withRedirectDataboolean

Include basic redirect information

Response

OK

Changes

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