API Tree Structure

Walking the Tree

Walking the tree starts at the top of the hierarchy by selecting a Project Collection and retrieving a list of all the child Packages, Projects, Sub-Folders, Tasks and Assignments, then continuously looping through each of the parent items until everything has been retrieved.

The following is a visual representation of the tree structure in LiquidPlanner New:

Organization

• Workspace
  • Project Collections
    • Packages
      • Projects
        • Tasks
          • Assignments
        • Sub-Folders
          • Tasks
            • Assignments

Organization

The Organization is your account. The API Tree Structure is located within an Organization. Organizations with API access can have more than one Workspace under the same account. Each Workspace is a self-contained entity.

Workspace

A Workspace is made up of Plan Items, Members, Resources, Placeholders and Settings. Plan Items are part of the API Tree Structure. Packages, Projects, Sub-Folders and Tasks are all Plan Items. In the API, the Items Endpoint is used to interact with Plan Items.

Project Collections

A LiquidPlanner Workspace has four Project Collections: Scheduled, Pending, Archived and Templates. In the API, the Project Collection is identified by the packageStatus field on the Items endpoint when the itemType is a Package.

There are two scenarios that would cause you to start at the Collection to pull information from a Workspace: (1) to get a list of everything in the Workspace by Collection (2) when you do not have the LiquidPlanner ID for the plan items you need.

Packages

Packages are always associated with a Project Collection. A Package represents the highest level of Plan Item hierarchy. A Package can be moved to a different Collection by updating its packageStatus. Changing the packageStatus moves the Package and all of its contents.

Use the Items endpoint with the itemType filter[is]=”packages”to fetch all Packages from the Workspace.

https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1?itemType[is]=”packages”

To pull a list of packages from a specific collection, use the Items endpoint filtered by packageStatus:[is]=”scheduled”, [is]=”backlog”, [is]=”archived”or [is]=”templates”.

https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1?packageStatus[is]=”scheduled”

Projects

Each Package contains Projects. To pull all the immediate descendants from a specific Package, use the Items Endpoint filtered by parentId:[is]=”<Package ID>”.

https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1?parentId[is]=”<Package ID>”

Sub-Folders

Each Project may contain Sub-Folders and/or Tasks. Sub-Folders can also be nested within a Project. To pull all the immediate descendents from a specific Project, use the Items Endpoint filtered by parentId:[is]=”<ancestor ID>”.

https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1?parentId[is]=”<ancestor ID>”

Tasks

Tasks are always within a Project or Sub-Folder. To pull a list of tasks that are the immediate descendants of a specific parent item, use the Items Endpoint filtered by parentId:[is]=”<ancestor ID>”.

https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1?parentId[is]=”<ancestor ID>”

Assignments

Each Task contains Assignments. While they are part of the API Tree Structure, they are not independent Plan Items. They are always part of a Task and they can't be moved from one Task to another. To pull all Assignments from a specific Task, use the Items Endpoint filtered by parentId:[is]=”<Task ID>”.

https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1?parentId[is]=”<Task ID>”

To see a cURL example go to Get all Assignments on a Task