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": "637c5e4c-17f0-45d6-bc90-25e22f6c1091",
"ParentTaskId": "d0b64901-46f6-4764-85fa-551737da9e11",
"Integration": {
"IntegrationId": "4710fb21-4a6b-4abb-a75a-76887760511c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"550b33cd-7588-4da6-bc39-1e2c2117bb3a": 2.0,
"d9482e3e-e544-44cc-9b59-e29c58b98bbe": 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": "cdd720b5-cdc8-4bbf-a856-6c4983267411",
"Name": "sample string 1",
"Created": "2026-07-18T20:51:45.607081+00:00",
"Modified": "2026-07-18T20:51:45.607081+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"958af9c0-c382-4206-9c3b-1252be60cdd4",
"e961b66f-0bfd-42d3-9623-665d3d674de8"
],
"NonLaborAssignments": [
{
"Id": "f9c742e8-82f8-4255-80bd-4ef220857b31",
"ResourceId": "dde1be81-f4a3-452d-b3d9-29b01f80869a",
"Quantity": 3.0
},
{
"Id": "f9c742e8-82f8-4255-80bd-4ef220857b31",
"ResourceId": "dde1be81-f4a3-452d-b3d9-29b01f80869a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "df32475a-d5b2-4bdb-a02b-a0745039d7bb",
"Type": 0,
"ResourceId": "fc3320b3-46af-4ee9-b6c2-1534bdca63a5",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "df32475a-d5b2-4bdb-a02b-a0745039d7bb",
"Type": 0,
"ResourceId": "fc3320b3-46af-4ee9-b6c2-1534bdca63a5",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "7fc173e5-ac9f-487f-b197-7ad601a1c7fd",
"WorkTypeParentId": "767b8380-15ba-42c5-a831-e4d3bed3746e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bbb384fd-9c3f-4977-97f0-f26fd7b5f2b2",
"UPN": "5e3e80e2-fad8-4c29-8113-e451b9c161b2",
"PostDate": "2026-07-18T20:51:45.607081+00:00",
"Comment": "sample string 4",
"CC": [
"1a6484e2-c05b-43d5-ab08-e55636b1d1c6",
"915b6fae-7fbc-4005-a6fc-01c36a9165ee"
],
"Users": [
"74d67aa1-3982-4ef0-a2e0-271556fa0c52",
"705619f5-b1b2-491a-be12-ac05795d8798"
]
},
{
"Id": "bbb384fd-9c3f-4977-97f0-f26fd7b5f2b2",
"UPN": "5e3e80e2-fad8-4c29-8113-e451b9c161b2",
"PostDate": "2026-07-18T20:51:45.607081+00:00",
"Comment": "sample string 4",
"CC": [
"1a6484e2-c05b-43d5-ab08-e55636b1d1c6",
"915b6fae-7fbc-4005-a6fc-01c36a9165ee"
],
"Users": [
"74d67aa1-3982-4ef0-a2e0-271556fa0c52",
"705619f5-b1b2-491a-be12-ac05795d8798"
]
}
],
"StartDate": "2026-07-18T20:51:45.607081+00:00",
"DueDate": "2026-07-18T20:51:45.607081+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"42d7a2ec-92b6-4472-ae6e-9a9394d09488": "5944fe57-03f0-4421-9494-18b583683769",
"bbc965ff-a200-4d1c-a825-d08565038eb5": "f35d9163-3fc8-4237-86ab-56830cefd0a8"
},
"HasUpdates": true,
"Modified": "2026-07-18T20:51:45.607081+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-18T20:51:45.607081+00:00"
},
"LastComment": "2026-07-18T20:51:45.607081+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c777ea75-54c2-4f13-94b6-0151f5811679",
"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": "4ab1483c-4284-408d-b817-a61ea9446bb7",
"id": "1d4c77d1-d18b-42bf-a90d-8801c0c0a387",
"ConfigId": "494eaf13-58fc-401e-8131-244114946fdc"
}