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": "fbaff0f6-1115-4210-ab6d-d97f778d58f1",
"ParentTaskId": "f39cac4d-a8fb-4d55-bb94-5aa04ccdb39d",
"Integration": {
"IntegrationId": "ddaf1951-3522-4ea7-891a-b55fe7d9ff64",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"97d3d633-6d97-4fea-9cd6-8b2721792934": 2.0,
"24347de8-3c65-4bbf-8147-2a67f6c1f8ee": 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": "b3274cba-dcbd-4f5c-9e1c-80cb4fc23a9a",
"Name": "sample string 1",
"Created": "2026-07-21T13:04:05.0762926+00:00",
"Modified": "2026-07-21T13:04:05.0762926+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c45c4486-81ce-44b9-913c-274d41cdd341",
"3b5326a4-ca8b-46bc-8998-ef0d6756d3b5"
],
"NonLaborAssignments": [
{
"Id": "eba68b2f-2b51-44aa-9523-f7af9b65c07b",
"ResourceId": "944be607-db11-47c7-a7df-4ec346437906",
"Quantity": 3.0
},
{
"Id": "eba68b2f-2b51-44aa-9523-f7af9b65c07b",
"ResourceId": "944be607-db11-47c7-a7df-4ec346437906",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "33f8e4d6-3fb5-4890-aea9-e50b02943ef5",
"Type": 0,
"ResourceId": "efa24618-9bdd-4ba4-9ab5-91f4fd06746c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "33f8e4d6-3fb5-4890-aea9-e50b02943ef5",
"Type": 0,
"ResourceId": "efa24618-9bdd-4ba4-9ab5-91f4fd06746c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "81b45766-9d10-42f6-8b6d-62c887fb6d38",
"WorkTypeParentId": "51fb3fcb-4900-46e3-a9a0-780a194ddd2f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3f5bc35c-c4f5-44af-915d-8b8cf1af58b6",
"UPN": "35aeeb77-85ad-4af5-8291-9e7a192c0001",
"PostDate": "2026-07-21T13:04:05.0762926+00:00",
"Comment": "sample string 4",
"CC": [
"ceaa3761-0a01-4ebd-8b5e-31cbdc555965",
"5439ccdb-f4ce-4be8-867d-29a0ec65337e"
],
"Users": [
"27c5e28d-cf22-4313-83be-299535818ff0",
"6d168ba9-67bd-41ae-946d-fd51846a6f28"
]
},
{
"Id": "3f5bc35c-c4f5-44af-915d-8b8cf1af58b6",
"UPN": "35aeeb77-85ad-4af5-8291-9e7a192c0001",
"PostDate": "2026-07-21T13:04:05.0762926+00:00",
"Comment": "sample string 4",
"CC": [
"ceaa3761-0a01-4ebd-8b5e-31cbdc555965",
"5439ccdb-f4ce-4be8-867d-29a0ec65337e"
],
"Users": [
"27c5e28d-cf22-4313-83be-299535818ff0",
"6d168ba9-67bd-41ae-946d-fd51846a6f28"
]
}
],
"StartDate": "2026-07-21T13:04:05.0762926+00:00",
"DueDate": "2026-07-21T13:04:05.0762926+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"abd7784e-4173-4e55-9a70-c84d39464774": "a0178de1-013f-4f01-aea9-68923cdbf4a8",
"724564b4-2ef6-41c8-8aef-beee2f9b8118": "75bb85d2-cbde-4839-8fe0-cf6b610338a2"
},
"HasUpdates": true,
"Modified": "2026-07-21T13:04:05.0762926+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-21T13:04:05.0762926+00:00"
},
"LastComment": "2026-07-21T13:04:05.0762926+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "85c60e26-03de-42e2-8286-2c048bf97bbc",
"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": "4428ddb3-f59e-4ae3-8873-23f9b48627e8",
"id": "d44c0d4f-7b94-47c8-9069-d7c57f027077",
"ConfigId": "eee67d40-8322-48bb-bca4-6db3677e8ad9"
}