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": "7b693f87-a9d8-4b1b-b47f-c507fe1a8dab",
"ParentTaskId": "28aa4a27-c49c-46ea-9db0-9bdf77396bde",
"Integration": {
"IntegrationId": "75cfe0a7-f9d2-45ef-9816-e9b6548997e1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b9899b53-cefc-4832-9c66-d9f35524a9af": 2.0,
"167793b0-c403-4073-9e2c-ff9dce42a2a1": 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": "50bfc0e6-a999-4263-8721-04fc68c769e4",
"Name": "sample string 1",
"Created": "2026-07-08T21:11:10.9641685+00:00",
"Modified": "2026-07-08T21:11:10.9641685+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ff41b547-3c15-42b8-b539-b294bc292be8",
"dde573eb-0749-48af-8d70-9c59428a3fb4"
],
"NonLaborAssignments": [
{
"Id": "dfb311f8-77a5-4f79-b539-d714cb6b1bce",
"ResourceId": "fa008711-e2db-48f1-97a8-9682c5a160f2",
"Quantity": 3.0
},
{
"Id": "dfb311f8-77a5-4f79-b539-d714cb6b1bce",
"ResourceId": "fa008711-e2db-48f1-97a8-9682c5a160f2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "358639fe-ee70-4712-95ce-4b6f9e397bc6",
"Type": 0,
"ResourceId": "abfef1cc-6bf7-4bb6-9854-35f7eff98a41",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "358639fe-ee70-4712-95ce-4b6f9e397bc6",
"Type": 0,
"ResourceId": "abfef1cc-6bf7-4bb6-9854-35f7eff98a41",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "41760501-e34d-4271-a14b-34420dbd5ccd",
"WorkTypeParentId": "bb76ecb8-8aa6-430f-a4a0-1588acc3c5cf",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "13ee9c98-a925-4266-89ee-0b27c3c8558e",
"UPN": "506faa68-2493-4afd-8640-8367325acb24",
"PostDate": "2026-07-08T21:11:10.9641685+00:00",
"Comment": "sample string 4",
"CC": [
"bc81946b-c569-4939-8db4-9573449f0c82",
"96b494e5-a852-4849-bb73-afd427f847a2"
],
"Users": [
"e6e2ffc3-f3f5-43bf-8f05-cfae1166a6b5",
"0ae50d7b-4e12-4352-a947-a4cd225b27f0"
]
},
{
"Id": "13ee9c98-a925-4266-89ee-0b27c3c8558e",
"UPN": "506faa68-2493-4afd-8640-8367325acb24",
"PostDate": "2026-07-08T21:11:10.9641685+00:00",
"Comment": "sample string 4",
"CC": [
"bc81946b-c569-4939-8db4-9573449f0c82",
"96b494e5-a852-4849-bb73-afd427f847a2"
],
"Users": [
"e6e2ffc3-f3f5-43bf-8f05-cfae1166a6b5",
"0ae50d7b-4e12-4352-a947-a4cd225b27f0"
]
}
],
"StartDate": "2026-07-08T21:11:10.9641685+00:00",
"DueDate": "2026-07-08T21:11:10.9641685+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9e7b7eb2-5659-4331-9124-835f5d513b3f": "1214ed34-bb75-4fba-8f2f-b3eae74caf17",
"a9295635-4f0e-41e7-971a-9c3051db204a": "0b6a2a1a-b204-4ec5-abc7-2644696b4830"
},
"HasUpdates": true,
"Modified": "2026-07-08T21:11:10.9641685+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-08T21:11:10.9641685+00:00"
},
"LastComment": "2026-07-08T21:11:10.9641685+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e6d7d080-152d-40fa-80a7-30e249e48f9e",
"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": "ad56e6a2-dbd6-4bb3-8a84-e96cff382990",
"id": "0df88db5-de20-44a9-bf90-268819c02583",
"ConfigId": "a80df66d-47d3-4482-bc7c-bbbf713b83fc"
}