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": "b694ba5e-c8ab-4139-bb89-65b3cf328f70",
"ParentTaskId": "13ff5d7f-b4d8-49a0-b96f-c9d4fb6f2a7f",
"Integration": {
"IntegrationId": "b9ed9618-5824-40d1-a9cc-4971c8994f0d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e3466e6a-02cf-485f-b31f-99a308bb5ef2": 2.0,
"54ebbd93-2777-4bd0-a0ab-16c16d3c8138": 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": "324ec10e-571c-42c3-b0e1-43fc80440eb5",
"Name": "sample string 1",
"Created": "2026-01-21T22:16:31.2937072+00:00",
"Modified": "2026-01-21T22:16:31.2937072+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"06ed4682-d25c-49a1-8143-d28c94ff61a6",
"51308079-eb6a-4a54-8691-14e36f770150"
],
"NonLaborAssignments": [
{
"Id": "02ed4242-6322-4911-9b5e-7a6e0a913d09",
"ResourceId": "4248e51a-cf5b-4555-9b92-5b4b62e25f8b",
"Quantity": 3.0
},
{
"Id": "02ed4242-6322-4911-9b5e-7a6e0a913d09",
"ResourceId": "4248e51a-cf5b-4555-9b92-5b4b62e25f8b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ab955693-ac66-4ce8-93f8-ed34bc5f7f51",
"Type": 0,
"ResourceId": "1c9c0fb1-6149-4a7c-94bd-a3244ae01cf2",
"Units": 3.0
},
{
"Id": "ab955693-ac66-4ce8-93f8-ed34bc5f7f51",
"Type": 0,
"ResourceId": "1c9c0fb1-6149-4a7c-94bd-a3244ae01cf2",
"Units": 3.0
}
],
"ParentId": "3906db72-d00a-4fbb-94fd-761bc13de273",
"WorkTypeParentId": "841dcd3b-da87-4396-a656-2172bf5dc154",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "09d5ab5a-73e2-4beb-a7e7-43a1216e68b4",
"UPN": "0366e6de-eb3e-409a-8f9b-4f4aacd35eb7",
"PostDate": "2026-01-21T22:16:31.2937072+00:00",
"Comment": "sample string 4",
"CC": [
"816367f6-48b4-4845-929b-fd6818d79f87",
"27b445fe-2cbc-4c85-9a11-8988c4352001"
],
"Users": [
"db61e588-0006-4281-aa7d-32fd04351439",
"fd434b09-514b-4209-8458-7b0adbfbd0b9"
]
},
{
"Id": "09d5ab5a-73e2-4beb-a7e7-43a1216e68b4",
"UPN": "0366e6de-eb3e-409a-8f9b-4f4aacd35eb7",
"PostDate": "2026-01-21T22:16:31.2937072+00:00",
"Comment": "sample string 4",
"CC": [
"816367f6-48b4-4845-929b-fd6818d79f87",
"27b445fe-2cbc-4c85-9a11-8988c4352001"
],
"Users": [
"db61e588-0006-4281-aa7d-32fd04351439",
"fd434b09-514b-4209-8458-7b0adbfbd0b9"
]
}
],
"StartDate": "2026-01-21T22:16:31.2937072+00:00",
"DueDate": "2026-01-21T22:16:31.2937072+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"778d195a-a5ca-4884-be13-21f883c450ab": "4428b194-a5a1-4c27-ac7e-dee3300ea4e9",
"1be7bd8a-c595-4a60-921f-2f077f6eb217": "57e702af-0cdc-4ea1-96fb-10a590f515f7"
},
"HasUpdates": true,
"Modified": "2026-01-21T22:16:31.2937072+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-01-21T22:16:31.2937072+00:00"
},
"LastComment": "2026-01-21T22:16:31.2937072+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ed5e0346-44c3-477e-81ef-2d894a40fcca",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "7ff73311-6fae-42ce-ae97-091816e1030d",
"id": "b7658e59-7185-4335-b507-562af3f8a97e",
"ConfigId": "5cdc8ba5-badc-4daa-89da-cfb888db3cb6"
}