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": "1c04afe6-dbac-4f74-93d1-779f4e74e5b8",
"ParentTaskId": "f38a98ac-a421-42de-b756-12a5f9626a41",
"Integration": {
"IntegrationId": "e9895322-62e8-41fd-a5e0-8b196b3262ab",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"43f22af5-14fb-4f79-9821-782d0a1aec64": 2.0,
"885af082-2858-478f-999a-2558d2d0ec78": 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": "10a87de7-9559-44c9-905b-bdfbc9ba1c5b",
"Name": "sample string 1",
"Created": "2026-06-22T20:05:58.7231832+00:00",
"Modified": "2026-06-22T20:05:58.7231832+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"805096e8-df73-4ac8-98c3-4c5197ec4049",
"281c2b67-0140-4ab5-97ed-a9a99cad4635"
],
"NonLaborAssignments": [
{
"Id": "a9691643-2e35-48f5-8aed-7bce96f5445d",
"ResourceId": "df89de62-20dc-4029-998a-b381c70b70b4",
"Quantity": 3.0
},
{
"Id": "a9691643-2e35-48f5-8aed-7bce96f5445d",
"ResourceId": "df89de62-20dc-4029-998a-b381c70b70b4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3a4f293d-5f98-4f50-8f9b-4d1803846fb3",
"Type": 0,
"ResourceId": "8c84e892-e442-4b9e-9aa4-663202635d53",
"Units": 3.0
},
{
"Id": "3a4f293d-5f98-4f50-8f9b-4d1803846fb3",
"Type": 0,
"ResourceId": "8c84e892-e442-4b9e-9aa4-663202635d53",
"Units": 3.0
}
],
"ParentId": "41325644-7a96-42f4-893c-6dbea44f215a",
"WorkTypeParentId": "cfc98b75-bea4-4a98-a6d0-1edd70a55c4b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2e815c69-41be-46e1-b0d6-965860266789",
"UPN": "814a3952-e275-430e-a3bd-4dea9a245df1",
"PostDate": "2026-06-22T20:05:58.7231832+00:00",
"Comment": "sample string 4",
"CC": [
"000ac4ea-3c9d-4d39-bf14-4ca7e98b1072",
"5d60ef30-3f32-4eb9-b099-ebd7c726bb32"
],
"Users": [
"9bd5d675-0600-49fa-b90f-bcd4eee60aa9",
"0f19a329-74a8-4bfa-9a4b-ddff2b8eb7e8"
]
},
{
"Id": "2e815c69-41be-46e1-b0d6-965860266789",
"UPN": "814a3952-e275-430e-a3bd-4dea9a245df1",
"PostDate": "2026-06-22T20:05:58.7231832+00:00",
"Comment": "sample string 4",
"CC": [
"000ac4ea-3c9d-4d39-bf14-4ca7e98b1072",
"5d60ef30-3f32-4eb9-b099-ebd7c726bb32"
],
"Users": [
"9bd5d675-0600-49fa-b90f-bcd4eee60aa9",
"0f19a329-74a8-4bfa-9a4b-ddff2b8eb7e8"
]
}
],
"StartDate": "2026-06-22T20:05:58.7231832+00:00",
"DueDate": "2026-06-22T20:05:58.7231832+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"02b11e0e-e63e-4a72-be83-70715f10fb27": "88851a1a-85d1-497e-bc8d-2316caafddc8",
"671a6b16-45c7-4e9a-8eff-725b7493e2de": "ce4f7cf8-6a2b-45d8-b8cf-a09972adb8dd"
},
"HasUpdates": true,
"Modified": "2026-06-22T20:05:58.7231832+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-06-22T20:05:58.7231832+00:00"
},
"LastComment": "2026-06-22T20:05:58.7231832+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "21f4d733-fc21-4e8f-a4bd-fe8f2bf758df",
"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": "2b0e0357-1206-433e-b3e4-5f004080506e",
"id": "21f1b1e9-3172-4ec6-a19f-801b75769ddf",
"ConfigId": "7a8e37ef-0035-4162-b335-84a62f17e010"
}