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": "cb17aaeb-7c89-4faa-9f49-07d7f691b01f",
"ParentTaskId": "b2bd3b52-7617-4933-bd53-ff859959c618",
"Integration": {
"IntegrationId": "d30f63aa-d4f9-4d88-b930-92185519cd18",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"8fc85e80-89d3-4476-865e-59c615fd65b6": 2.0,
"65dfa8c1-f5c1-4338-a6c7-aad2fe02fea7": 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. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "1883111b-1ec2-468c-b643-5ce27d71cc0d",
"Name": "sample string 1",
"Created": "2026-05-06T06:21:39.1060543+00:00",
"Modified": "2026-05-06T06:21:39.1060543+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"aba8cebd-23f5-4e19-aaae-bf8554b17511",
"d29797f0-65b1-42ef-8cf7-ca21145d1b82"
],
"NonLaborAssignments": [
{
"Id": "bbf7f7ca-dc97-4c9b-a862-957c3a376e1a",
"ResourceId": "0d094808-7b2f-4b5e-b99d-89d8af0b32ef",
"Quantity": 3.0
},
{
"Id": "bbf7f7ca-dc97-4c9b-a862-957c3a376e1a",
"ResourceId": "0d094808-7b2f-4b5e-b99d-89d8af0b32ef",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8aff734e-e1ef-4c5c-9591-ade9a562d70c",
"Type": 0,
"ResourceId": "0130b7a5-6214-4133-8fd7-52b2f9c00af7",
"Units": 3.0
},
{
"Id": "8aff734e-e1ef-4c5c-9591-ade9a562d70c",
"Type": 0,
"ResourceId": "0130b7a5-6214-4133-8fd7-52b2f9c00af7",
"Units": 3.0
}
],
"ParentId": "7127a8a2-f83c-4531-843a-fb5731d6d7a8",
"WorkTypeParentId": "26fba841-f9bb-43f0-8fb1-19e3b2d9d153",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "328bb5f5-37fe-4fb1-86ac-4578d2465f83",
"UPN": "9fa5288d-3fb9-4519-a37d-bfbd2853b100",
"PostDate": "2026-05-06T06:21:39.1060543+00:00",
"Comment": "sample string 4",
"CC": [
"a0f7290f-c049-421a-ae9f-2c74eea17b18",
"67003aab-29cf-44be-bc44-4c4424662e79"
],
"Users": [
"ae41e346-a7e5-4528-b10f-bf78c35a15f5",
"3e37b7c9-aa90-40f9-83df-71bc3a9f110c"
]
},
{
"Id": "328bb5f5-37fe-4fb1-86ac-4578d2465f83",
"UPN": "9fa5288d-3fb9-4519-a37d-bfbd2853b100",
"PostDate": "2026-05-06T06:21:39.1060543+00:00",
"Comment": "sample string 4",
"CC": [
"a0f7290f-c049-421a-ae9f-2c74eea17b18",
"67003aab-29cf-44be-bc44-4c4424662e79"
],
"Users": [
"ae41e346-a7e5-4528-b10f-bf78c35a15f5",
"3e37b7c9-aa90-40f9-83df-71bc3a9f110c"
]
}
],
"StartDate": "2026-05-06T06:21:39.1060543+00:00",
"DueDate": "2026-05-06T06:21:39.1060543+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"839bb1a1-3684-42a5-bca0-cab5e96f4f27": "c029a435-c492-48f6-bcf9-881fe99d81a8",
"c981ef57-b81d-4df0-b100-c5cce121a3ee": "b6751b5f-4e0a-4e55-9509-00123ab6a7fb"
},
"HasUpdates": true,
"Modified": "2026-05-06T06:21:39.1060543+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-05-06T06:21:39.1060543+00:00"
},
"LastComment": "2026-05-06T06:21:39.1060543+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "fac24e3c-0e8c-4f1b-ad09-587d7bcedd7d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "bf419b66-f5b2-42df-9354-c1e854d3ab7f",
"id": "230f0078-0330-4df7-946b-57bd89740649",
"ConfigId": "760250e5-fd28-466c-978c-c39d53d4a5fc"
}