POST api/workplan/{id}/tasks
Add Task
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Work Plan Id |
globally unique identifier |
Required |
Body Parameters
TasksRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| WorkTypeId | globally unique identifier |
None. |
|
| ParentTaskId | globally unique identifier |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| Assignments | Dictionary of globally unique identifier [key] and decimal number [value] |
None. |
|
| ProcessAssignments | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"WorkTypeId": "01b049b6-8d09-4152-b75e-a5e3c96bed5c",
"ParentTaskId": "e5f7263e-51f4-4b7a-b15e-5bd054492dcd",
"Integration": {
"IntegrationId": "8b9d5431-4d0d-493d-83c2-ee1a17177a28",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f1d92e84-5a50-44b9-b7c1-78ef2b581dc1": 2.0,
"960f6000-0fba-480f-99b0-cdcfe09c4a7e": 4.0
},
"ProcessAssignments": true
}
Response Information
Resource Description
WorkPlanTask| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Author | string |
None. |
|
| Editor | string |
None. |
|
| AssignedTo | Collection of globally unique identifier |
None. |
|
| NonLaborAssignments | Collection of TaskNonLaborAssignment |
None. |
|
| Assignments | Collection of TaskAssignment |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| WorkTypeParentId | globally unique identifier |
None. |
|
| WorkTypeIndex | integer |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| Index | integer |
None. |
|
| Complete | boolean |
None. |
|
| Comments | Collection of TaskComment |
None. |
|
| StartDate | date |
None. |
|
| DueDate | date |
None. |
|
| TaskScheduleType | TaskType |
None. |
|
| StatusUpdate | StatusUpdateClass |
None. |
|
| LastComment | date |
None. |
|
| IsScheduled | boolean |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "576adb4c-5a02-439c-9e6f-b67db257be4c",
"Name": "sample string 1",
"Created": "2026-02-02T00:40:23.1356863+00:00",
"Modified": "2026-02-02T00:40:23.1356863+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7d23fd18-45e5-40b4-b394-e0f3c37a02fd",
"defb8bd0-83c7-4df4-8f6b-05d295ad2dc0"
],
"NonLaborAssignments": [
{
"Id": "95001c40-df36-4891-8aab-5fdccd9b7158",
"ResourceId": "512bab85-3309-4413-b8cc-78733b71dd02",
"Quantity": 3.0
},
{
"Id": "95001c40-df36-4891-8aab-5fdccd9b7158",
"ResourceId": "512bab85-3309-4413-b8cc-78733b71dd02",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "17e42025-51f3-4754-bd0c-159dcb4cffb1",
"Type": 0,
"ResourceId": "ede6ae7c-3506-49c4-98ad-f852cbdf90df",
"Units": 3.0
},
{
"Id": "17e42025-51f3-4754-bd0c-159dcb4cffb1",
"Type": 0,
"ResourceId": "ede6ae7c-3506-49c4-98ad-f852cbdf90df",
"Units": 3.0
}
],
"ParentId": "6ad71817-2c38-4065-9d6b-49804f5a8087",
"WorkTypeParentId": "54f15868-f625-4a0f-83c6-b32cd46d0e3f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3a5b2ec4-ff48-4ace-b372-b12a82fb6412",
"UPN": "d3bbe0bf-c9a5-44af-91b0-07a56a6bb5bc",
"PostDate": "2026-02-02T00:40:23.1356863+00:00",
"Comment": "sample string 4",
"CC": [
"6a423ca3-66e6-47ef-865a-4dd834761651",
"1db42bd0-f3b5-41f2-a9ae-daf36bb71774"
],
"Users": [
"5cb9a016-c258-4b33-8854-8b77df71089a",
"9d9389b9-62cc-47c5-bf7a-60e6e44b3078"
]
},
{
"Id": "3a5b2ec4-ff48-4ace-b372-b12a82fb6412",
"UPN": "d3bbe0bf-c9a5-44af-91b0-07a56a6bb5bc",
"PostDate": "2026-02-02T00:40:23.1356863+00:00",
"Comment": "sample string 4",
"CC": [
"6a423ca3-66e6-47ef-865a-4dd834761651",
"1db42bd0-f3b5-41f2-a9ae-daf36bb71774"
],
"Users": [
"5cb9a016-c258-4b33-8854-8b77df71089a",
"9d9389b9-62cc-47c5-bf7a-60e6e44b3078"
]
}
],
"StartDate": "2026-02-02T00:40:23.1356863+00:00",
"DueDate": "2026-02-02T00:40:23.1356863+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"35fe5112-c1ea-49cb-8ec0-cc6bc86ae18a": "9f214f81-376e-49ba-8b9e-77b52c01766e",
"27e7314b-0575-4ebc-9cf9-2cce8f8a8be7": "dad7c3cb-4c23-44e0-a97e-5f9bbdc35d31"
},
"HasUpdates": true,
"Modified": "2026-02-02T00:40:23.1356863+00:00",
"Editor": "sample string 3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"CalcFields": {
"sample string 1": {},
"sample string 3": {}
},
"State": 0,
"ApproveRejectBy": "sample string 4",
"ApproveRejectDate": "2026-02-02T00:40:23.1356863+00:00"
},
"LastComment": "2026-02-02T00:40:23.1356863+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cede42c4-ff28-4898-9243-5fcf0e881b6e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "fc1d3d9f-a77b-447c-a3c4-b26b5b5cb74b",
"id": "7f9d892f-d72d-4b96-ac12-cd29fafd7d01",
"ConfigId": "ece5a69a-344d-4446-9c1f-6653cdd9ec43"
}