Name | Type | Example Values | Description |
---|---|---|---|
depth |
Integer | 0, -1 | |
leaves |
Boolean | true |
Name | Type | Description |
---|---|---|
work | Integer | |
alerts | Array | |
created_at | String (Time ISO8601) | |
created_by | Integer | |
description | String | |
earliest_finish | String (Time ISO8601) | |
earliest_start | String (Time ISO8601) | |
expected_finish | String (Time ISO8601) | |
expected_start | String (Time ISO8601) | |
p98_finish | String (Time ISO8601) | |
high_effort_remaining | Float | |
is_done | Boolean | |
latest_finish | String (Time ISO8601) | |
low_effort_remaining | Float | |
name | String | |
updated_at | String (Time ISO8601) | |
updated_by | Integer | |
type | String | |
id | Integer | |
children | Array | |
children[].work | Integer | |
children[].alerts | Array | |
children[].created_at | String (Time ISO8601) | |
children[].created_by | Integer | |
children[].done_on | ||
children[].started_on | String | |
children[].delay_until | ||
children[].description | String | |
children[].earliest_finish | ||
children[].earliest_start | ||
children[].expected_finish | ||
children[].expected_start | ||
children[].p98_finish | ||
children[].global_priority | Array | |
children[].global_priority[] | Integer | |
children[].has_note | Boolean | |
children[].high_effort_remaining | Integer | |
children[].is_done | Boolean | |
children[].is_on_hold | Boolean | |
children[].effective_is_on_hold | Boolean | |
children[].latest_finish | ||
children[].low_effort_remaining | Integer | |
children[].manual_alert | String | |
children[].max_effort | ||
children[].name | String | |
children[].assignments | Array | |
children[].assignments[].person_id | Integer | |
children[].assignments[].team_id | ||
children[].assignments[].low_effort_remaining | Integer | |
children[].assignments[].high_effort_remaining | Integer | |
children[].assignments[].treeitem_id | Integer | |
children[].assignments[].space_id | Integer | |
children[].assignments[].activity_id | ||
children[].assignments[].is_done | Boolean | |
children[].assignments[].daily_limit | ||
children[].assignments[].position | Integer | |
children[].assignments[].hours_logged | Integer | |
children[].assignments[].expected_finish | ||
children[].assignments[].expected_start | ||
children[].assignments[].can_destroy | Boolean | |
children[].assignments[].type | String | |
children[].assignments[].id | Integer | |
children[].parent_id | Integer | |
children[].parent_ids | Array | |
children[].parent_ids[] | Integer | |
children[].parent_crumbs | Array | |
children[].promise_by | ||
children[].external_reference | ||
children[].updated_at | String (Time ISO8601) | |
children[].updated_by | Integer | |
children[].type | String | |
children[].id | Integer | |
children[].children | Array | |
children[].children[].activity_id | Integer | |
children[].children[].work | Integer | |
children[].children[].alerts | Array | |
children[].children[].project_id | ||
children[].children[].client_id | ||
children[].children[].client_name | ||
children[].children[].created_at | String (Time ISO8601) | |
children[].children[].created_by | Integer | |
children[].children[].custom_field_values.Custom Status | String | |
children[].children[].done_on | ||
children[].children[].started_on | String | |
children[].children[].delay_until | ||
children[].children[].parent_delay_until | ||
children[].children[].package_delay_until | ||
children[].children[].description | String | |
children[].children[].earliest_finish | ||
children[].children[].earliest_start | ||
children[].children[].expected_finish | ||
children[].children[].expected_start | ||
children[].children[].p98_finish | ||
children[].children[].global_priority | Array | |
children[].children[].global_priority[] | Integer | |
children[].children[].global_package_priority | ||
children[].children[].has_note | Boolean | |
children[].children[].high_effort_remaining | Integer | |
children[].children[].is_done | Boolean | |
children[].children[].is_on_hold | Boolean | |
children[].children[].effective_is_on_hold | Boolean | |
children[].children[].is_packaged_version | Boolean | |
children[].children[].is_estimated | Boolean | |
children[].children[].is_shared | Boolean | |
children[].children[].latest_finish | ||
children[].children[].low_effort_remaining | Integer | |
children[].children[].manual_alert | String | |
children[].children[].max_effort | ||
children[].children[].name | String | |
children[].children[].assignments | Array | |
children[].children[].assignments[].person_id | Integer | |
children[].children[].assignments[].team_id | ||
children[].children[].assignments[].low_effort_remaining | Integer | |
children[].children[].assignments[].high_effort_remaining | Integer | |
children[].children[].assignments[].treeitem_id | Integer | |
children[].children[].assignments[].space_id | Integer | |
children[].children[].assignments[].activity_id | Integer | |
children[].children[].assignments[].is_done | Boolean | |
children[].children[].assignments[].daily_limit | ||
children[].children[].assignments[].position | Integer | |
children[].children[].assignments[].hours_logged | Integer | |
children[].children[].assignments[].expected_finish | ||
children[].children[].assignments[].expected_start | ||
children[].children[].assignments[].can_destroy | Boolean | |
children[].children[].assignments[].type | String | |
children[].children[].assignments[].id | Integer | |
children[].children[].parent_id | Integer | |
children[].children[].promise_by | ||
children[].children[].parent_promise_by | ||
children[].children[].package_promise_by | ||
children[].children[].external_reference | ||
children[].children[].package_id | ||
children[].children[].parent_ids | Array | |
children[].children[].parent_ids[] | Integer | |
children[].children[].parent_crumbs | Array | |
children[].children[].parent_crumbs[] | String | |
children[].children[].package_ids | Array | |
children[].children[].package_crumbs | Array | |
children[].children[].updated_at | String (Time ISO8601) | |
children[].children[].updated_by | Integer | |
children[].children[].work_in_order | Boolean | |
children[].children[].type | String | |
children[].children[].id | Integer |
shows the list of treeitems in a workspaces for the user
2015-05-14 18:21:02 UTC
GET /api/workspaces/143500/treeitems?depth=0
depth: 0
authorization: FILTERED content-type: application/json user-agent: curl/7.37.1
transfer-encoding: chunked connection: close content-length: 611 x-xss-protection: 1; mode=block x-request-id: 63105fe7-5850-497c-b66f-8469c7dd1b4a x-lp-user: 552590 x-lp-space: 143500 x-lp-controller: Api::Treeitems x-lp-action: index x-frame-options: SAMEORIGIN, SAMEORIGIN x-forwarded-proto: https x-content-type-options: nosniff x-api-version: 3.0.0 vary: X-API-Version strict-transport-security: max-age=15768000 status: 200 OK server: ECD (pae/37CB) etag: W/"a124e8bc2235862a53f50558b055b311" date: Thu, 14 May 2015 18:21:02 GMT content-type: application/json; charset=utf-8 cache-control: max-age=0, private, must-revalidate
Shortened for readability
{ "work": 34, "alerts": [ ], "created_at": "2015-05-11T14:33:19+00:00", "created_by": 552590, "description": "This is the root for the workspace.", "earliest_finish": "2015-06-21T05:59:59+00:00", "earliest_start": "2015-05-14T18:16:00+00:00", "expected_finish": "2015-06-21T05:59:59+00:00", "expected_start": "2015-05-14T18:16:00+00:00", "p98_finish": "2015-06-21T05:59:59+00:00", "high_effort_remaining": 189.9446576005456, "is_done": false, "latest_finish": "2015-06-21T05:59:59+00:00", "low_effort_remaining": 155.5553423994544, "name": "Personal", "updated_at": "2015-05-11T14:33:19+00:00", "updated_by": 552590, "type": "Root", "id": 22473745 }
shows the entire tree under a workspace
2015-05-14 18:21:03 UTC
GET /api/workspaces/143500/treeitems?depth=-1&leaves=true
leaves: true depth: -1
authorization: FILTERED content-type: application/json user-agent: curl/7.37.1
connection: close transfer-encoding: chunked x-xss-protection: 1; mode=block x-request-id: 6c580ae1-fe83-48dd-9020-904629758c3e x-lp-user: 552590 x-lp-space: 143500 x-lp-controller: Api::Treeitems x-lp-action: index x-frame-options: SAMEORIGIN, SAMEORIGIN x-forwarded-proto: https x-content-type-options: nosniff x-api-version: 3.0.0 vary: X-API-Version strict-transport-security: max-age=15768000 status: 200 OK server: ECD (pae/37CB) etag: W/"3e875b4a1b5df9f0549a01ac8e0ddf6b" date: Thu, 14 May 2015 18:21:03 GMT content-type: application/json; charset=utf-8 cache-control: max-age=0, private, must-revalidate
Shortened for readability
{ "work": 34, "alerts": [ ], "created_at": "2015-05-11T14:33:19+00:00", "created_by": 552590, "description": "This is the root for the workspace.", "earliest_finish": "2015-06-21T05:59:59+00:00", "earliest_start": "2015-05-14T18:16:00+00:00", "expected_finish": "2015-06-21T05:59:59+00:00", "expected_start": "2015-05-14T18:16:00+00:00", "p98_finish": "2015-06-21T05:59:59+00:00", "high_effort_remaining": 189.9446576005456, "is_done": false, "latest_finish": "2015-06-21T05:59:59+00:00", "low_effort_remaining": 155.5553423994544, "name": "Personal", "updated_at": "2015-05-11T14:33:19+00:00", "updated_by": 552590, "type": "Root", "id": 22473745, "children": [ { "work": 0, "alerts": [ ], "created_at": "2015-05-11T14:33:19+00:00", "created_by": 552590, "done_on": null, "started_on": "2015-05-03", "delay_until": null, "description": "", "earliest_finish": null, "earliest_start": null, "expected_finish": null, "expected_start": null, "p98_finish": null, "global_priority": [ 1, 1 ], "has_note": false, "high_effort_remaining": 86, "is_done": false, "is_on_hold": false, "effective_is_on_hold": false, "latest_finish": null, "low_effort_remaining": 66, "manual_alert": "", "max_effort": null, "name": "INBOX", "assignments": [ { "person_id": 552590, "team_id": null, "low_effort_remaining": 0, "high_effort_remaining": 0, "treeitem_id": 22473746, "space_id": 143500, "activity_id": null, "is_done": false, "daily_limit": null, "position": 1, "hours_logged": 0, "expected_finish": null, "expected_start": null, "can_destroy": false, "type": "Assignment", "id": 15323049 } ], "parent_id": 22473745, "parent_ids": [ 22473745 ], "parent_crumbs": [ ], "promise_by": null, "external_reference": null, "updated_at": "2015-05-11T14:33:19+00:00", "updated_by": 552590, "type": "Inbox", "id": 22473746, "children": [ { "activity_id": 200404, "work": 34, "alerts": [ ], "project_id": null, "client_id": null, "client_name": null, "created_at": "2015-05-11T14:33:19+00:00", "created_by": 552590, "custom_field_values": { "Custom Status": "In Progress" }, "done_on": null, "started_on": "2015-05-04", "delay_until": null, "parent_delay_until": null, "package_delay_until": null, "description": "The tasks in the Getting Started package will help you build your workspace and get your team members up and running.\n\nClick on a task to see details on how to complete it.\n\nGo to the HELP tab for instant access to training videos, help guide articles, and webinars.", "earliest_finish": null, "earliest_start": null, "expected_finish": null, "expected_start": null, "p98_finish": null, "global_priority": [ 1, 1 ], "global_package_priority": null, "has_note": true, "high_effort_remaining": 86, "is_done": false, "is_on_hold": false, "effective_is_on_hold": false, "is_packaged_version": false, "is_estimated": true, "is_shared": false, "latest_finish": null, "low_effort_remaining": 66, "manual_alert": "", "max_effort": null, "name": "Welcome to LiquidPlanner", "assignments": [ { "person_id": 552590, "team_id": null, "low_effort_remaining": 66, "high_effort_remaining": 86, "treeitem_id": 22473747, "space_id": 143500, "activity_id": 200404, "is_done": false, "daily_limit": null, "position": 1, "hours_logged": 34, "expected_finish": null, "expected_start": null, "can_destroy": false, "type": "Assignment", "id": 15323050 } ], "parent_id": 22473746, "promise_by": null, "parent_promise_by": null, "package_promise_by": null, "external_reference": null, "package_id": null, "parent_ids": [ 22473745, 22473746 ], "parent_crumbs": [ "INBOX" ], "package_ids": [ ], "package_crumbs": [ ], "updated_at": "2015-05-11T15:10:32+00:00", "updated_by": 552590, "work_in_order": false, "type": "Task", "id": 22473747 }, { "activity_id": 200404, "work": 0, "alerts": [ ], "project_id": null, "client_id": null, "client_name": null, "created_at": "2015-05-11T15:15:12+00:00", "created_by": 552590, "custom_field_values": { }, "done_on": null, "started_on": null, "delay_until": null, "parent_delay_until": null, "package_delay_until": null, "description": "", "earliest_finish": null, "earliest_start": null, "expected_finish": null, "expected_start": null, "p98_finish": null, "global_priority": [ 1, 1 ], "global_package_priority": null, "has_note": false, "high_effort_remaining": 0, "is_done": false, "is_on_hold": false, "effective_is_on_hold": false, "is_packaged_version": false, "is_estimated": false, "is_shared": false, "latest_finish": null, "low_effort_remaining": 0, "manual_alert": "", "max_effort": null, "name": "A sample task", "assignments": [ { "person_id": 552590, "team_id": null, "low_effort_remaining": 0, "high_effort_remaining": 0, "treeitem_id": 22474804, "space_id": 143500, "activity_id": 200404, "is_done": false, "daily_limit": null, "position": 1, "hours_logged": 0, "expected_finish": null, "expected_start": null, "can_destroy": false, "type": "Assignment", "id": 15324809 } ], "parent_id": 22473746, "promise_by": null, "parent_promise_by": null, "package_promise_by": null, "external_reference": null, "package_id": null, "parent_ids": [ 22473745, 22473746 ], "parent_crumbs": [ "INBOX" ], "package_ids": [ ], "package_crumbs": [ ], "updated_at": "2015-05-11T15:15:12+00:00", "updated_by": 552590, "work_in_order": false, "type": "Task", "id": 22474804 } ] }, { "work": 0, "alerts": [ ], "created_at": "2015-05-11T14:33:19+00:00", "created_by": 552590, "done_on": null, "started_on": "2015-06-14", "delay_until": null, "parent_delay_until": null, "description": "The EVENTS package can be used to hold Events that block availability for specific periods of time (e.g. holidays, out of office events, meetings).", "earliest_finish": "2015-06-21T05:59:59+00:00", "earliest_start": "2015-06-15T06:00:00+00:00", "expected_finish": "2015-06-21T05:59:59+00:00", "expected_start": "2015-06-15T06:00:00+00:00", "p98_finish": "2015-06-21T05:59:59+00:00", "global_priority": [ 1, 101 ], "has_note": false, "high_effort_remaining": 40, "is_done": false, "is_on_hold": false, "effective_is_on_hold": false, "latest_finish": "2015-06-21T05:59:59+00:00", "low_effort_remaining": 40, "manual_alert": "", "max_effort": null, "name": "Events", "assignments": [ { "person_id": 552590, "team_id": null, "low_effort_remaining": 0, "high_effort_remaining": 0, "treeitem_id": 22473748, "space_id": 143500, "activity_id": null, "is_done": false, "daily_limit": null, "position": 1, "hours_logged": 0, "expected_finish": "2015-05-14T18:16:00+00:00", "expected_start": "2015-05-14T18:16:00+00:00", "can_destroy": false, "type": "Assignment", "id": 15323051 } ], "parent_id": 22473745, "parent_ids": [ 22473745 ], "parent_crumbs": [ ], "promise_by": null, "parent_promise_by": null, "external_reference": null, "updated_at": "2015-05-11T14:33:19+00:00", "updated_by": 552590, "type": "Package", "id": 22473748, "children": [ { "activity_id": 200404, "work": 0, "alerts": [ ], "project_id": null, "client_id": null, "client_name": null, "created_at": "2015-05-11T14:33:19+00:00", "created_by": 552590, "custom_field_values": { "Custom Status": "In Review" }, "done_on": null, "started_on": "2015-06-15", "start_date": "2015-06-15", "description": "", "earliest_finish": "2015-06-21T05:59:59+00:00", "earliest_start": "2015-06-15T06:00:00+00:00", "expected_finish": "2015-06-21T05:59:59+00:00", "expected_start": "2015-06-15T06:00:00+00:00", "p98_finish": "2015-06-21T05:59:59+00:00", "global_priority": [ 1, 101 ], "global_package_priority": null, "has_note": false, "high_effort_remaining": 40, "is_done": false, "is_on_hold": false, "effective_is_on_hold": false, "is_packaged_version": false, "is_shared": false, "latest_finish": "2015-06-21T05:59:59+00:00", "low_effort_remaining": 40, "manual_alert": "", "max_effort": null, "name": "Sample Vacation", "assignments": [ { "person_id": 552590, "team_id": null, "low_effort_remaining": 40, "high_effort_remaining": 40, "treeitem_id": 22473749, "space_id": 143500, "activity_id": 200404, "is_done": false, "daily_limit": null, "position": 1, "hours_logged": 0, "expected_finish": "2015-06-21T05:59:59+00:00", "expected_start": "2015-06-15T06:00:00+00:00", "can_destroy": false, "type": "Assignment", "id": 15323052 } ], "parent_id": 22473748, "finish_date": "2015-06-20", "external_reference": null, "package_id": null, "parent_ids": [ 22473745, 22473748 ], "parent_crumbs": [ "Events" ], "package_ids": [ ], "package_crumbs": [ ], "updated_at": "2015-05-11T14:33:19+00:00", "updated_by": 552590, "type": "Event", "id": 22473749 } ] } ] }