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": "64940594-e682-4396-a1a6-102b7a7dc947",
"ParentTaskId": "e43f9e40-a1a1-4b8f-8596-dba7a8260fd7",
"Integration": {
"IntegrationId": "0d22a6e0-ecf4-454e-b003-003cb9f6686b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"cdec4e96-45d4-45f2-8c32-590a9c706007": 2.0,
"061edfa1-8ca7-45ba-97db-9d6516332ca3": 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": "343bbb72-2658-4d43-898f-8b86b7006f4a",
"Name": "sample string 1",
"Created": "2026-07-01T10:24:51.6492508+00:00",
"Modified": "2026-07-01T10:24:51.6492508+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e256eaec-800f-4b4a-ba14-a37efcbd4dbe",
"bd5a0d8a-e960-47aa-9ed2-36b22d41250c"
],
"NonLaborAssignments": [
{
"Id": "521d9498-9d18-4bba-a092-8e2d0592dc74",
"ResourceId": "939b79a5-fa73-45fe-89df-48fdb115ea72",
"Quantity": 3.0
},
{
"Id": "521d9498-9d18-4bba-a092-8e2d0592dc74",
"ResourceId": "939b79a5-fa73-45fe-89df-48fdb115ea72",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "120f1951-06f6-4bf9-9d4a-14b41bdffa20",
"Type": 0,
"ResourceId": "eeef5980-d01b-4fad-8976-bb097d233a94",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "120f1951-06f6-4bf9-9d4a-14b41bdffa20",
"Type": 0,
"ResourceId": "eeef5980-d01b-4fad-8976-bb097d233a94",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "20a13959-1bce-4ae3-a501-faa9d28ba017",
"WorkTypeParentId": "4c99e46b-1ed1-480b-b015-f3b757c39a2f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "24608a4c-34e0-4e06-9d30-22abead4c054",
"UPN": "24911b20-c747-4061-a3da-9200e7a7869e",
"PostDate": "2026-07-01T10:24:51.6492508+00:00",
"Comment": "sample string 4",
"CC": [
"4610fe48-81d4-4f23-bf5e-1f58c69b28e2",
"49ca5500-cc6f-434d-8829-42db84ecb6e2"
],
"Users": [
"31cde092-2af7-4a69-9fc8-5a73ae36ed4a",
"a18b5d7d-d808-463a-8872-9b08de6e402e"
]
},
{
"Id": "24608a4c-34e0-4e06-9d30-22abead4c054",
"UPN": "24911b20-c747-4061-a3da-9200e7a7869e",
"PostDate": "2026-07-01T10:24:51.6492508+00:00",
"Comment": "sample string 4",
"CC": [
"4610fe48-81d4-4f23-bf5e-1f58c69b28e2",
"49ca5500-cc6f-434d-8829-42db84ecb6e2"
],
"Users": [
"31cde092-2af7-4a69-9fc8-5a73ae36ed4a",
"a18b5d7d-d808-463a-8872-9b08de6e402e"
]
}
],
"StartDate": "2026-07-01T10:24:51.6492508+00:00",
"DueDate": "2026-07-01T10:24:51.6492508+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bb3789e0-105b-4f7d-8bbd-59a9103f2fe6": "3ec0fb11-e72f-4b04-90bd-c3c910c3a9e3",
"977ef9c6-bb71-440e-85d1-3ba3e7bb984a": "8534724d-098e-4aa5-8110-724adbbcd7e5"
},
"HasUpdates": true,
"Modified": "2026-07-01T10:24:51.6492508+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-07-01T10:24:51.6492508+00:00"
},
"LastComment": "2026-07-01T10:24:51.6492508+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5abbaaa9-b338-4a78-9194-f1cbdfbad431",
"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": "c2ed1189-dfa9-4058-ab48-54e3cd976d1f",
"id": "b6c77f96-b199-4858-974c-05c8224e7056",
"ConfigId": "4b44e2f2-3899-4602-bd81-c2a83051a2ab"
}