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": "5e550a90-c694-4db9-8aae-6239295273f3",
"ParentTaskId": "0e848867-773a-4842-9847-ce15cdf5a13a",
"Integration": {
"IntegrationId": "a7c116ec-e7d0-47ae-8016-076b11588131",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f11b28b6-bd51-4f09-b367-7a2af5d1027c": 2.0,
"7b26185c-96b0-4b26-9b37-8dc68ce161fc": 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": "2edbcc04-1cfe-45c5-80c1-5d9fbce26a41",
"Name": "sample string 1",
"Created": "2026-04-06T00:49:35.2338282+00:00",
"Modified": "2026-04-06T00:49:35.2338282+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ca500169-ce1a-407b-8fff-866df4619585",
"5837cd3d-0b28-4548-9ad1-3ec9f34a51e5"
],
"NonLaborAssignments": [
{
"Id": "61b3467c-426a-45e2-aaf9-31cdf985ab12",
"ResourceId": "f087f606-a96e-4035-85bb-ce42cc6783ba",
"Quantity": 3.0
},
{
"Id": "61b3467c-426a-45e2-aaf9-31cdf985ab12",
"ResourceId": "f087f606-a96e-4035-85bb-ce42cc6783ba",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "48ba6c5b-3f96-4852-9462-45c952be9ef9",
"Type": 0,
"ResourceId": "1a2f6092-e78f-4c4e-a40e-53f711411c4e",
"Units": 3.0
},
{
"Id": "48ba6c5b-3f96-4852-9462-45c952be9ef9",
"Type": 0,
"ResourceId": "1a2f6092-e78f-4c4e-a40e-53f711411c4e",
"Units": 3.0
}
],
"ParentId": "a25efe5d-bc10-4edc-b35c-664d0bee5fcb",
"WorkTypeParentId": "32a39844-7860-48a7-be64-470e1725454d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1e854e1d-ac64-4395-a982-bdad8b01511b",
"UPN": "7487dba1-3111-443c-87e1-1f71001dd728",
"PostDate": "2026-04-06T00:49:35.2338282+00:00",
"Comment": "sample string 4",
"CC": [
"ebf9513a-db2f-4709-aa4b-5efa582d3270",
"8d2d46ec-e6d1-422a-ac6b-3450f0a4ca95"
],
"Users": [
"dc8d5829-653f-457a-b41f-53638d98b9c9",
"d4f17514-e449-4e4d-a6ba-a9ea16c70241"
]
},
{
"Id": "1e854e1d-ac64-4395-a982-bdad8b01511b",
"UPN": "7487dba1-3111-443c-87e1-1f71001dd728",
"PostDate": "2026-04-06T00:49:35.2338282+00:00",
"Comment": "sample string 4",
"CC": [
"ebf9513a-db2f-4709-aa4b-5efa582d3270",
"8d2d46ec-e6d1-422a-ac6b-3450f0a4ca95"
],
"Users": [
"dc8d5829-653f-457a-b41f-53638d98b9c9",
"d4f17514-e449-4e4d-a6ba-a9ea16c70241"
]
}
],
"StartDate": "2026-04-06T00:49:35.2338282+00:00",
"DueDate": "2026-04-06T00:49:35.2338282+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f12b18d6-dd4b-4ff4-bb86-ded6a570d482": "da30ca7c-ad52-43b9-ad33-286edfc9eac1",
"947f1c82-4c64-4366-bca3-4574ee0528c0": "7b1a316e-bc09-4170-a638-0d1acfd8b15a"
},
"HasUpdates": true,
"Modified": "2026-04-06T00:49:35.2338282+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-04-06T00:49:35.2338282+00:00"
},
"LastComment": "2026-04-06T00:49:35.2338282+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "be5c0330-7714-4204-b1c9-5b9d4f6205f3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "30af8c04-5ee1-4bea-aabf-d4c81224b5ac",
"id": "d2039c2e-4242-40ce-be4f-b4b7ac6b5e8a",
"ConfigId": "e7ae3fee-9742-4bc9-9507-e0dcf109c4a2"
}