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": "3796b966-6d30-4629-9dc3-9d737fe080a0",
"ParentTaskId": "1752e0e6-09b1-4b28-8ba9-81d9e134df3b",
"Integration": {
"IntegrationId": "16eeb7b5-9c9f-40e0-b638-665ced64a009",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"05064698-d05c-4965-b136-694981932b6d": 2.0,
"fc34a8b7-c384-435f-a41e-9e04ffb823ad": 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": "92cbe0bb-bee2-4c8a-9fa0-9a30355a4351",
"Name": "sample string 1",
"Created": "2026-10-08T12:22:33.5627364+00:00",
"Modified": "2026-10-08T12:22:33.5627364+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"01f6cf7b-3baf-4cfa-8023-ba4d81520b02",
"d55c2300-f5c0-44de-9d73-fbf451240bf1"
],
"NonLaborAssignments": [
{
"Id": "9b4aa064-8aa4-4511-b96a-419869e7941f",
"ResourceId": "99934b1b-1e5d-4c4e-98b8-aedefff99f6b",
"Quantity": 3.0
},
{
"Id": "9b4aa064-8aa4-4511-b96a-419869e7941f",
"ResourceId": "99934b1b-1e5d-4c4e-98b8-aedefff99f6b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6b5c7725-4729-4e3b-a1a3-4a95bc6f5e74",
"Type": 0,
"ResourceId": "7324228a-4682-4c48-849c-5fc66467dfb9",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "17830824-bc2b-4d1a-999d-453c3b70cefe",
"Start": "2026-10-08T12:22:33.5627364+00:00",
"Due": "2026-10-08T12:22:33.5627364+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "17830824-bc2b-4d1a-999d-453c3b70cefe",
"Start": "2026-10-08T12:22:33.5627364+00:00",
"Due": "2026-10-08T12:22:33.5627364+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "6b5c7725-4729-4e3b-a1a3-4a95bc6f5e74",
"Type": 0,
"ResourceId": "7324228a-4682-4c48-849c-5fc66467dfb9",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "17830824-bc2b-4d1a-999d-453c3b70cefe",
"Start": "2026-10-08T12:22:33.5627364+00:00",
"Due": "2026-10-08T12:22:33.5627364+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "17830824-bc2b-4d1a-999d-453c3b70cefe",
"Start": "2026-10-08T12:22:33.5627364+00:00",
"Due": "2026-10-08T12:22:33.5627364+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "9ca9f84a-6d4f-4944-ac21-f2a6773275cf",
"WorkTypeParentId": "b40f899b-6ccd-4965-ab92-dfbdac35bfed",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "0e801e24-582c-402a-9e80-073ade2440b3",
"UPN": "f9657ec4-fc83-435a-8c0e-26456aa3d838",
"PostDate": "2026-10-08T12:22:33.5627364+00:00",
"Comment": "sample string 4",
"CC": [
"c5f81339-d186-4023-985a-26752c45bf0c",
"e9be4293-34b6-4067-96ed-57fabbba749b"
],
"Users": [
"c178f789-97b0-42b1-a08e-45438c9288df",
"33f6d43d-b76c-479b-8e91-c4272ec7c993"
]
},
{
"Id": "0e801e24-582c-402a-9e80-073ade2440b3",
"UPN": "f9657ec4-fc83-435a-8c0e-26456aa3d838",
"PostDate": "2026-10-08T12:22:33.5627364+00:00",
"Comment": "sample string 4",
"CC": [
"c5f81339-d186-4023-985a-26752c45bf0c",
"e9be4293-34b6-4067-96ed-57fabbba749b"
],
"Users": [
"c178f789-97b0-42b1-a08e-45438c9288df",
"33f6d43d-b76c-479b-8e91-c4272ec7c993"
]
}
],
"StartDate": "2026-10-08T12:22:33.5627364+00:00",
"DueDate": "2026-10-08T12:22:33.5627364+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b9e9afc5-8fb7-44ba-9244-94f6fae7013a": "a31fc67a-e653-4446-a1b8-925342cd7625",
"48c2a754-912f-4d70-ac52-a3f6d262845d": "af6e3c93-b705-4b95-b953-a58fc34ebe74"
},
"HasUpdates": true,
"Modified": "2026-10-08T12:22:33.5627364+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-10-08T12:22:33.5627364+00:00"
},
"LastComment": "2026-10-08T12:22:33.5627364+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "21793228-4064-41be-aa8b-c007d11eb737",
"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": "df0971ae-87d6-44be-8aa5-fc3275c4e57c",
"id": "a65ace82-d0e4-42b3-b9c4-fe86f23eaca1",
"ConfigId": "3c7697f9-7bff-48c7-81db-b5313fe129b4"
}