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": "4d2f0840-e31e-46b8-af28-88d144f52e18",
"ParentTaskId": "63ae42ba-81ce-4feb-858c-754702e2bde8",
"Integration": {
"IntegrationId": "560707d0-9411-401a-840a-b49317f3902c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"948a1f6a-a733-4b26-b515-607295ebf28b": 2.0,
"1ed0854f-e265-4e3d-9e30-b7b718623bf1": 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": "f7405dd1-326b-4480-9f6e-64ad338b013c",
"Name": "sample string 1",
"Created": "2026-07-16T18:50:12.731949+00:00",
"Modified": "2026-07-16T18:50:12.731949+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"490ae73a-48e1-4d61-8615-8318d1548080",
"5968dc3a-c1d2-42da-a1a0-02f689258c7d"
],
"NonLaborAssignments": [
{
"Id": "233d3117-5341-4f99-a8b8-9e34f793fd2e",
"ResourceId": "cef88420-abda-466b-b985-328c18392a40",
"Quantity": 3.0
},
{
"Id": "233d3117-5341-4f99-a8b8-9e34f793fd2e",
"ResourceId": "cef88420-abda-466b-b985-328c18392a40",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1d0c2624-7f6b-4432-af04-3cf1fcdf9be2",
"Type": 0,
"ResourceId": "250def05-29ac-442a-9643-e3a3ad1c4d54",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "1d0c2624-7f6b-4432-af04-3cf1fcdf9be2",
"Type": 0,
"ResourceId": "250def05-29ac-442a-9643-e3a3ad1c4d54",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9c63b127-9d4b-4e86-9479-2d896995d2f0",
"WorkTypeParentId": "280c2f5e-cd7e-49e4-93b0-f4b4342f09af",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f5629fb2-d580-4361-ae38-d49f0aceb91f",
"UPN": "d43343e2-bdba-4a3a-81bd-05685eb8cc52",
"PostDate": "2026-07-16T18:50:12.731949+00:00",
"Comment": "sample string 4",
"CC": [
"f174c233-6d95-4caf-9da0-1d1bdc50fdb4",
"ddec1236-f506-437f-9148-18ad8dcd0f4e"
],
"Users": [
"4fdfa9f4-b715-4a27-9954-69271eb84870",
"391113c0-4e20-42b9-bf59-11d4405b9013"
]
},
{
"Id": "f5629fb2-d580-4361-ae38-d49f0aceb91f",
"UPN": "d43343e2-bdba-4a3a-81bd-05685eb8cc52",
"PostDate": "2026-07-16T18:50:12.731949+00:00",
"Comment": "sample string 4",
"CC": [
"f174c233-6d95-4caf-9da0-1d1bdc50fdb4",
"ddec1236-f506-437f-9148-18ad8dcd0f4e"
],
"Users": [
"4fdfa9f4-b715-4a27-9954-69271eb84870",
"391113c0-4e20-42b9-bf59-11d4405b9013"
]
}
],
"StartDate": "2026-07-16T18:50:12.731949+00:00",
"DueDate": "2026-07-16T18:50:12.731949+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"54a99e8a-5087-4d60-bd78-0e4ead9840ed": "3a20a6ed-91c5-4e40-ab89-23422c2660fe",
"111d428f-a679-4bfe-a23c-1bd923c471b6": "249745b7-167f-42f9-b5d0-86bf836fc313"
},
"HasUpdates": true,
"Modified": "2026-07-16T18:50:12.731949+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-16T18:50:12.731949+00:00"
},
"LastComment": "2026-07-16T18:50:12.731949+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "bd48056c-afe7-4592-9a8c-dff986fe9f8a",
"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": "45d10d13-270f-4dc6-af4b-4ba6653c8e00",
"id": "32982dc1-0436-462d-8eff-bb006900cb41",
"ConfigId": "55bf50bc-6269-4d88-9c0e-27b90fd3175c"
}