{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/projects/{projectId}/tasks.json","auth":"required","examples":{"codes":[{"language":"javascript","code":"$.ajax({\n\t\ttype: \"GET\", \n  \turl: \"/api/v1/projects/\" + projectId + \"/tasks.json\", \n  \tcontentType: 'application/json', \n  \tdataType: \"json\", \n  \tsuccess: worked,\n  \theaders: { apiKey: apiKey }\n});"},{"code":"<?\n$context = stream_context_create(array(\n  'http'=>array(\n    'method'=>\"GET\",\n    'header'=>\"apiKey: [yourApiKey]\")\n));\n$data = file_get_contents('https://api.projectmanager.com/api/v1/projects/1234/tasks.json', false, $context);\nprint_r(json_decode($data));\n?>","language":"php"}]},"method":"get","params":[{"name":"projectId","type":"int","default":"","desc":"The Id of the project to retrieve tasks for.","required":true,"in":"path","ref":"","_id":"557218121cd8283500a8b5ce"}],"results":{"codes":[{"name":"","code":"{\n    \"status\": \"Okay\",\n    \"tasks\": [\n        {\n            \"children\": [\n            {\n                \"actual\": {\n                    \"cost\": 0.0,\n                    \"duration\": null,\n                    \"effort\": 480,\n                    \"finish\": null,\n                    \"resourceCost\": 0.0,\n                    \"start\": null\n                },\n                \"assignments\": [\n                    932618\n                ],\n                \"baseline\":   {\n                    \"cost\": 0.0,\n                    \"duration\": null,\n                    \"effort\": 300,\n                    \"finish\": null,              \n                    \"start\": null\n            \t\t},\n                \"isMilestone\": false,\n                \"isSummary\": false,\n                \"notes\": null,\n                \"percentComplete\": null,\n                \"planned\": {\n                    \"cost\": 0.0,\n                    \"duration\": 3840,\n                    \"effort\": 1200,\n                    \"finish\": null,\n                    \"resourceCost\": 0.0,\n                    \"start\": \"2015-05-07T00:00:00\"\n                },\n                \"predeccesors\": null,\n                \"priority\": 600,\n                \"successors\": [\n                    28178220\n                ],\n                \"wbs\": \"1.1\",\n                \"id\": 28178219,\n                \"name\": \"a1\",\n                \"customColumns\":\n                  [\n                    { name: \"MyCurrencyCol\", type: \"currency\", data: \"95.99\", extendedColumnId=567},\n                    { name: \"MyNumberCol\", type: \"number\", data: \"1234\", extendedColumnId=568},\n                    { name: \"MyDateCol\", type: \"currency\", data: \"27-01-2018\", extendedColumnId=569},\n                    { name: \"MyStringCol\", type: \"string\", data: \"Spiffy Sprockets\", extendedColumnId=570},\n                    { name: \"MyBoolCol\", type: \"bool\", data: \"true\", extendedColumnId=571}\n                  ]\n            }\n            ],\n            \"actual\": {\n                \"cost\": 0.0,\n                \"duration\": null,\n                \"effort\": 480,\n                \"finish\": null,\n                \"resourceCost\": 0.0,\n                \"start\": null\n            },\n            \"assignments\": null,\n            \"baseline\": {\n                    \"cost\": 0.0,\n                    \"duration\": null,\n                    \"effort\": 300,\n                    \"finish\": null,              \n                    \"start\": null\n            },\n            \"isMilestone\": false,\n            \"isSummary\": true,\n            \"notes\": null,\n            \"percentComplete\": null,\n            \"planned\": {\n                \"cost\": 0.0,\n                \"duration\": 3840,\n                \"effort\": 1200,\n                \"finish\": null,\n                \"resourceCost\": 0.0,\n                \"start\": \"2015-05-07T00:00:00\"\n            },\n            \"predeccesors\": null,\n            \"priority\": 600,\n            \"successors\": null,\n            \"wbs\": \"1\",\n            \"id\": 28178218,\n            \"name\": \"a\"\n        },\n        {\n            \"children\": [],\n            \"actual\": {\n                \"cost\": 0.0,\n                \"duration\": null,\n                \"effort\": 300,\n                \"finish\": null,\n                \"resourceCost\": 0.0,\n                \"start\": null\n            },\n            \"assignments\": [\n            1259379,\n            1259380\n            ],\n            \"baseline\": {\n                    \"cost\": 0.0,\n                    \"duration\": null,\n                    \"effort\": 300,\n                    \"finish\": null,              \n                    \"start\": null\n            },\n            \"isMilestone\": false,\n            \"isSummary\": false,\n            \"notes\": null,\n            \"percentComplete\": null,\n            \"planned\": {\n                \"cost\": 0.0,\n                \"duration\": 3120,\n                \"effort\": 600,\n                \"finish\": null,\n                \"resourceCost\": 0.0,\n                \"start\": \"2015-05-19T00:00:00\"\n            },\n            \"predeccesors\": [\n            28178219\n            ],\n            \"priority\": 600,\n            \"successors\": null,\n            \"wbs\": \"2\",\n            \"id\": 28178220,\n            \"name\": \"b\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":""},"next":{"description":"","pages":[]},"title":"Tasks by Project","type":"endpoint","slug":"retrieve-a-projects-tasks","excerpt":"A Task instance represents a task created within a Project. It may be a high level summary task, or a task within a task.\n\nUse this API to retrieve the full list of Tasks for a given project.","body":"Use this API to retrieve all the tasks for a given project.\n\nA task is represented by the following properties:\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Id\",\n    \"1-0\": \"Name\",\n    \"0-1\": \"The unique identifier of the task.\",\n    \"1-1\": \"The name of the task.\",\n    \"2-0\": \"Priority\",\n    \"3-0\": \"Wbs\",\n    \"4-0\": \"Successors\",\n    \"5-0\": \"Predeccesors\",\n    \"6-0\": \"Planned\",\n    \"7-0\": \"PercentComplete\",\n    \"8-0\": \"Notes\",\n    \"9-0\": \"IsSummary\",\n    \"10-0\": \"IsMilestone\",\n    \"11-0\": \"Baseline\",\n    \"12-0\": \"Assignments\",\n    \"13-0\": \"Actual\",\n    \"14-0\": \"Children\",\n    \"14-1\": \"The child tasks of this task, if any.\",\n    \"13-1\": \"Actual task attributes, including, actual cost, effort, duration, start date, and finish date.\",\n    \"12-1\": \"Assigned resources for this task. Represented by resource Ids.\",\n    \"10-1\": \"Denotes whether a task is a milestone.\",\n    \"7-1\": \"Denotes how much of the task is complete.\",\n    \"6-1\": \"Planned task attributes including planned cost, duration, effort, start and end dates.\",\n    \"3-1\": \"The work break down structure setting for the task. This equates to the WBS setting in   Microsoft Project\",\n    \"4-1\": \"A list of succeeding tasks of this task. Only applicable for linked tasks.\",\n    \"5-1\": \"A list of preceding tasks for this task. Only applicable for linked tasks.\",\n    \"8-1\": \"Notes and comments that have been added against the task.\",\n    \"9-1\": \"Indicates whether this is a summary task.\",\n    \"2-1\": \"The priority of the task.\",\n    \"11-1\": \"The baseline information for the task, including baseline start date, finish date and effort information.\"\n  },\n  \"cols\": 2,\n  \"rows\": 15\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"554a7fa0d665ae0d00383f65","category":{"sync":{"isSync":false,"url":""},"pages":["554a7f3d6b448d0d00646b97","554a7f5e6b448d0d00646b99","554a7fa0d665ae0d00383f65","554a8077d665ae0d00383f75","554a8088d665ae0d00383f77"],"title":"Tasks","slug":"tasks","order":2,"from_sync":false,"reference":false,"_id":"554a7f3338e3620d0082192e","version":"5548466bd2c8410d006c2146","project":"5548466bd2c8410d006c2143","__v":5,"createdAt":"2015-05-06T20:53:07.204Z"},"project":"5548466bd2c8410d006c2143","user":"55484649b2581a0d00913ff3","__v":8,"editedParams":true,"editedParams2":true,"githubsync":"","parentDoc":null,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5548466cd2c8410d006c2147","554a69ba0b54d30d007fe128","554a7f3338e3620d0082192e","5565162e03b6710d00916942","55651a0c65a1130d00400c2b","55651d4565a1130d00400c2f","55651e0165a1130d00400c32","5565217903b6710d0091695f"],"_id":"5548466bd2c8410d006c2146","createdAt":"2015-05-05T04:26:19.796Z","project":"5548466bd2c8410d006c2143","__v":8,"releaseDate":"2015-05-05T04:26:19.796Z"},"createdAt":"2015-05-06T20:54:56.101Z"}

getTasks by Project

A Task instance represents a task created within a Project. It may be a high level summary task, or a task within a task. Use this API to retrieve the full list of Tasks for a given project.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

projectId:
required
integer
The Id of the project to retrieve tasks for.

Examples


Result Format


Documentation

Use this API to retrieve all the tasks for a given project. A task is represented by the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "Id", "1-0": "Name", "0-1": "The unique identifier of the task.", "1-1": "The name of the task.", "2-0": "Priority", "3-0": "Wbs", "4-0": "Successors", "5-0": "Predeccesors", "6-0": "Planned", "7-0": "PercentComplete", "8-0": "Notes", "9-0": "IsSummary", "10-0": "IsMilestone", "11-0": "Baseline", "12-0": "Assignments", "13-0": "Actual", "14-0": "Children", "14-1": "The child tasks of this task, if any.", "13-1": "Actual task attributes, including, actual cost, effort, duration, start date, and finish date.", "12-1": "Assigned resources for this task. Represented by resource Ids.", "10-1": "Denotes whether a task is a milestone.", "7-1": "Denotes how much of the task is complete.", "6-1": "Planned task attributes including planned cost, duration, effort, start and end dates.", "3-1": "The work break down structure setting for the task. This equates to the WBS setting in Microsoft Project", "4-1": "A list of succeeding tasks of this task. Only applicable for linked tasks.", "5-1": "A list of preceding tasks for this task. Only applicable for linked tasks.", "8-1": "Notes and comments that have been added against the task.", "9-1": "Indicates whether this is a summary task.", "2-1": "The priority of the task.", "11-1": "The baseline information for the task, including baseline start date, finish date and effort information." }, "cols": 2, "rows": 15 } [/block]