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": "1430c226-6698-47f0-93d4-278162dc6c91",
"ParentTaskId": "a244461a-278e-4996-b9be-66ed1c0305c3",
"Integration": {
"IntegrationId": "322f6c11-a2ca-40eb-b856-70ddaddeb699",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"93ce269f-84bc-4b1a-8d81-23331b225380": 2.0,
"88514413-d997-40ca-b577-c6fe29c31d08": 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": "b254f6c9-2694-4418-8808-2209ba439255",
"Name": "sample string 1",
"Created": "2026-07-28T03:09:39.8572987+00:00",
"Modified": "2026-07-28T03:09:39.8572987+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8f64afb6-f14e-4c33-b70a-4715ac5886f5",
"e1d390fc-c2cd-4cc1-a828-c5e5fcff1cbc"
],
"NonLaborAssignments": [
{
"Id": "a9cd0437-cdaf-47e7-a624-d4e6d8c7cda8",
"ResourceId": "154843ad-46b6-4458-b175-749c0b0f55e3",
"Quantity": 3.0
},
{
"Id": "a9cd0437-cdaf-47e7-a624-d4e6d8c7cda8",
"ResourceId": "154843ad-46b6-4458-b175-749c0b0f55e3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4296aea9-c022-4021-a105-0026e6435771",
"Type": 0,
"ResourceId": "cdf1bb5a-3e9a-499a-b14c-1a9ff6aa5b6c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "4296aea9-c022-4021-a105-0026e6435771",
"Type": 0,
"ResourceId": "cdf1bb5a-3e9a-499a-b14c-1a9ff6aa5b6c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3a9ee85f-518c-4f0a-844d-2bfc01383066",
"WorkTypeParentId": "c1a4285a-4413-4797-8a64-ce337adde797",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8056b963-f742-4590-a649-c99ca1dac066",
"UPN": "96d86949-537e-448e-b003-0a20910455ce",
"PostDate": "2026-07-28T03:09:39.8572987+00:00",
"Comment": "sample string 4",
"CC": [
"53c03395-ca41-44f1-9be8-e5b1196cda70",
"ba38de6c-0cd4-44e0-b58b-8682c1516d01"
],
"Users": [
"974e3629-562f-4cd2-9562-aab00addae41",
"2461dc0a-3342-4f49-8f4d-fec2de538e92"
]
},
{
"Id": "8056b963-f742-4590-a649-c99ca1dac066",
"UPN": "96d86949-537e-448e-b003-0a20910455ce",
"PostDate": "2026-07-28T03:09:39.8572987+00:00",
"Comment": "sample string 4",
"CC": [
"53c03395-ca41-44f1-9be8-e5b1196cda70",
"ba38de6c-0cd4-44e0-b58b-8682c1516d01"
],
"Users": [
"974e3629-562f-4cd2-9562-aab00addae41",
"2461dc0a-3342-4f49-8f4d-fec2de538e92"
]
}
],
"StartDate": "2026-07-28T03:09:39.8572987+00:00",
"DueDate": "2026-07-28T03:09:39.8572987+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"72abee54-1890-4df8-b76a-578e21ce18e5": "76d8e394-4a11-4b1b-b8ed-3e889631c196",
"56db3136-1d81-4302-b5e1-8fc5706e2e3e": "e3c7818f-3ea7-4cad-8cd4-a273932817a6"
},
"HasUpdates": true,
"Modified": "2026-07-28T03:09:39.8572987+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-28T03:09:39.8572987+00:00"
},
"LastComment": "2026-07-28T03:09:39.8572987+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2d42178b-8bc1-40fc-bf9a-216e9602325e",
"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": "e4deb210-c08c-481e-8623-c68d9d9b58a1",
"id": "34ef02e4-6acf-4c7c-a720-b40c017b4e9f",
"ConfigId": "09d21e28-123e-44e3-aa63-644385bad1d2"
}