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": "069fc2ca-963b-4947-9c4e-8d701446540c",
"ParentTaskId": "b40ae7b0-62db-4be3-8dbd-692e374f9eb5",
"Integration": {
"IntegrationId": "c3b6c838-3f55-4428-9fde-33d8e8f8d27c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"65f04423-ff4d-427f-a62b-25573772074d": 2.0,
"ae414e9d-5f88-4f2e-8097-a1c83f237b67": 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": "a2ba3bed-f273-4366-a755-316db5ce1550",
"Name": "sample string 1",
"Created": "2025-12-22T14:01:24.8188434+00:00",
"Modified": "2025-12-22T14:01:24.8188434+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bdaebd63-31f3-4db1-aef6-ad14b5cbf8c4",
"4ac161f7-b210-47a3-8fa8-8b2e34ad1ce2"
],
"NonLaborAssignments": [
{
"Id": "9e5f3b1c-a6ec-4451-b391-02443c89d117",
"ResourceId": "508e1669-a79c-4f67-b5ad-2dc5244d7f06",
"Quantity": 3.0
},
{
"Id": "9e5f3b1c-a6ec-4451-b391-02443c89d117",
"ResourceId": "508e1669-a79c-4f67-b5ad-2dc5244d7f06",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "33e66ad9-4779-4242-9bcd-b06a2722f8cb",
"Type": 0,
"ResourceId": "482fc099-a7d8-4ff1-98a4-4567b84ba22b",
"Units": 3.0
},
{
"Id": "33e66ad9-4779-4242-9bcd-b06a2722f8cb",
"Type": 0,
"ResourceId": "482fc099-a7d8-4ff1-98a4-4567b84ba22b",
"Units": 3.0
}
],
"ParentId": "08aeded0-41a4-4847-8dc8-ba880e7ffd47",
"WorkTypeParentId": "1be29d9b-c9bb-494c-a4dc-5e2773029f22",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b8a29879-a951-4d51-8d5a-167e57ca6c1b",
"UPN": "366733ed-b708-46fd-8fe4-2f8959e1973c",
"PostDate": "2025-12-22T14:01:24.8188434+00:00",
"Comment": "sample string 4",
"CC": [
"a0ed1820-c8da-40c2-ac5a-72c7f2afcb03",
"c4526645-e709-47e2-9fdc-d0222d7ee02b"
],
"Users": [
"6d668845-38c9-4efa-93c9-93227a44fb28",
"cabf927d-009e-494b-884d-806946569549"
]
},
{
"Id": "b8a29879-a951-4d51-8d5a-167e57ca6c1b",
"UPN": "366733ed-b708-46fd-8fe4-2f8959e1973c",
"PostDate": "2025-12-22T14:01:24.8188434+00:00",
"Comment": "sample string 4",
"CC": [
"a0ed1820-c8da-40c2-ac5a-72c7f2afcb03",
"c4526645-e709-47e2-9fdc-d0222d7ee02b"
],
"Users": [
"6d668845-38c9-4efa-93c9-93227a44fb28",
"cabf927d-009e-494b-884d-806946569549"
]
}
],
"StartDate": "2025-12-22T14:01:24.8188434+00:00",
"DueDate": "2025-12-22T14:01:24.8188434+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bf46fe85-58f8-48ba-b2bf-a3996d333bb8": "b6a259ef-3028-43e5-abbe-c31e7329836a",
"3484fae6-d8bb-4e96-bbe0-d92c4aa647db": "4d75e93c-9aaa-4f44-9323-f8c673921bab"
},
"HasUpdates": true,
"Modified": "2025-12-22T14:01:24.8188434+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": "2025-12-22T14:01:24.8188434+00:00"
},
"LastComment": "2025-12-22T14:01:24.8188434+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1093a42d-16ef-4441-a448-683dca8d2c42",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "95079f31-8305-422f-ac91-821b012631dc",
"id": "fbdb5fd5-70fd-46f7-afa4-fe430abc938b",
"ConfigId": "35594ece-af9b-4c73-acd8-6a156069b97b"
}