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": "fcf01689-93bc-4c27-80a4-47836e945369",
"ParentTaskId": "8c5e4cbf-c7a7-4cb9-9799-3bd011c79f0e",
"Integration": {
"IntegrationId": "e7469195-a130-47ca-a4a6-674a2155560f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"21591a7e-0953-4cba-a97a-a39690fa56db": 2.0,
"7adc7f95-cb8a-42ad-a20b-86787de0ca09": 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": "b8ec4298-b3ff-4230-a645-27cb31834ced",
"Name": "sample string 1",
"Created": "2026-06-22T07:21:10.8866244+00:00",
"Modified": "2026-06-22T07:21:10.8866244+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"febe10b5-9bf5-4afb-9932-17fd044b76fa",
"981e9732-22dd-47a2-8684-a4362250212b"
],
"NonLaborAssignments": [
{
"Id": "49c94019-d177-4bb0-8932-af7fe5d1a6f0",
"ResourceId": "d0f593db-3372-40ef-8059-c90cb017e902",
"Quantity": 3.0
},
{
"Id": "49c94019-d177-4bb0-8932-af7fe5d1a6f0",
"ResourceId": "d0f593db-3372-40ef-8059-c90cb017e902",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ed8daea1-d592-4091-b534-cebe7edc6460",
"Type": 0,
"ResourceId": "f2e58ac0-c77c-419d-991f-16207cadb9a0",
"Units": 3.0
},
{
"Id": "ed8daea1-d592-4091-b534-cebe7edc6460",
"Type": 0,
"ResourceId": "f2e58ac0-c77c-419d-991f-16207cadb9a0",
"Units": 3.0
}
],
"ParentId": "5e96074d-96a4-4fec-a63c-2f0fb8bbf96e",
"WorkTypeParentId": "76fae99a-8a6d-4694-b3b3-7d06dac40360",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "23cd5dae-7072-46ad-b1bf-478f7da43a01",
"UPN": "3699b30b-aed5-4482-b876-04ce03608a68",
"PostDate": "2026-06-22T07:21:10.8866244+00:00",
"Comment": "sample string 4",
"CC": [
"78a24c56-0e4a-444d-a8a6-282145a88b64",
"6cd4d2f6-c92d-484b-aff9-e77882975c28"
],
"Users": [
"d86578b1-33d3-48b6-a561-f50e61b5e91d",
"5036200c-a8ec-4f62-9cc8-a9103db9ddbe"
]
},
{
"Id": "23cd5dae-7072-46ad-b1bf-478f7da43a01",
"UPN": "3699b30b-aed5-4482-b876-04ce03608a68",
"PostDate": "2026-06-22T07:21:10.8866244+00:00",
"Comment": "sample string 4",
"CC": [
"78a24c56-0e4a-444d-a8a6-282145a88b64",
"6cd4d2f6-c92d-484b-aff9-e77882975c28"
],
"Users": [
"d86578b1-33d3-48b6-a561-f50e61b5e91d",
"5036200c-a8ec-4f62-9cc8-a9103db9ddbe"
]
}
],
"StartDate": "2026-06-22T07:21:10.8866244+00:00",
"DueDate": "2026-06-22T07:21:10.8866244+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0f3d11d1-9ee3-42cc-b523-713eefe21c1a": "577b9ba8-d5b9-4b07-a90b-41ce64777fe0",
"c235f234-3585-4393-bd9d-886c898e426d": "07c28ee9-2176-4e5f-87c2-504ca969e9e6"
},
"HasUpdates": true,
"Modified": "2026-06-22T07:21:10.8866244+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-06-22T07:21:10.8866244+00:00"
},
"LastComment": "2026-06-22T07:21:10.8866244+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "14193810-bbcf-402d-bba4-5bd571c67196",
"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": "ac517269-6d28-4495-88cc-94bfdeb2d447",
"id": "3e024450-1515-45bc-9410-0a0708b66a0c",
"ConfigId": "bc2d8725-143e-4d74-aef6-3214a2c9d25a"
}