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": "489a6843-3999-42bd-b102-322e34f98b48",
"ParentTaskId": "6e18a93e-7eb0-4518-af49-1b8f6e6a0931",
"Integration": {
"IntegrationId": "e63776a0-826f-42b3-a70b-ad7015de07bb",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fc24b62f-47aa-4b23-a25d-ad2ce224da87": 2.0,
"e6717230-81c1-4466-81b6-e73a9ace7b31": 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": "78d5bfe4-d5c1-4272-b0b9-dc1b58071fc1",
"Name": "sample string 1",
"Created": "2026-11-02T17:18:10.9512075+00:00",
"Modified": "2026-11-02T17:18:10.9512075+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2c9f96cf-4bce-47fa-8d53-31d095d530e9",
"0c2b423f-b230-4781-822a-32b8dcddfbc5"
],
"NonLaborAssignments": [
{
"Id": "f5c8738a-0a77-438c-bfa1-6c15be2d230a",
"ResourceId": "9b9d5b6b-1d6c-4564-93e0-4bff6c56bbc2",
"Quantity": 3.0
},
{
"Id": "f5c8738a-0a77-438c-bfa1-6c15be2d230a",
"ResourceId": "9b9d5b6b-1d6c-4564-93e0-4bff6c56bbc2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "39e8e8ae-4cd6-433e-8956-a94080d21772",
"Type": 0,
"ResourceId": "4eb81e39-865c-4e48-b7ca-8637a882130d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3a60b9ac-770f-4b38-8a83-fe01f8351002",
"Start": "2026-11-02T17:18:10.9512075+00:00",
"Due": "2026-11-02T17:18:10.9512075+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3a60b9ac-770f-4b38-8a83-fe01f8351002",
"Start": "2026-11-02T17:18:10.9512075+00:00",
"Due": "2026-11-02T17:18:10.9512075+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "39e8e8ae-4cd6-433e-8956-a94080d21772",
"Type": 0,
"ResourceId": "4eb81e39-865c-4e48-b7ca-8637a882130d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3a60b9ac-770f-4b38-8a83-fe01f8351002",
"Start": "2026-11-02T17:18:10.9512075+00:00",
"Due": "2026-11-02T17:18:10.9512075+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3a60b9ac-770f-4b38-8a83-fe01f8351002",
"Start": "2026-11-02T17:18:10.9512075+00:00",
"Due": "2026-11-02T17:18:10.9512075+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "7f414fef-db91-41b0-a22f-1ed1c046efb4",
"WorkTypeParentId": "40638bc3-1db6-4400-bf03-0970b68fd8b8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e737fc8e-76c9-4d1c-b787-e53271752c70",
"UPN": "ae619418-9cdb-4c97-9101-a1e5611adb1a",
"PostDate": "2026-11-02T17:18:10.9512075+00:00",
"Comment": "sample string 4",
"CC": [
"eb3d4290-d025-4f2d-8e48-cb82eef7860a",
"d20bc7f0-6839-41bb-92ca-ba21db4a3231"
],
"Users": [
"9a888856-d724-403b-bfd9-d89cade02b71",
"8d789d21-5f14-4c19-80a4-6bfd45841cc0"
]
},
{
"Id": "e737fc8e-76c9-4d1c-b787-e53271752c70",
"UPN": "ae619418-9cdb-4c97-9101-a1e5611adb1a",
"PostDate": "2026-11-02T17:18:10.9512075+00:00",
"Comment": "sample string 4",
"CC": [
"eb3d4290-d025-4f2d-8e48-cb82eef7860a",
"d20bc7f0-6839-41bb-92ca-ba21db4a3231"
],
"Users": [
"9a888856-d724-403b-bfd9-d89cade02b71",
"8d789d21-5f14-4c19-80a4-6bfd45841cc0"
]
}
],
"StartDate": "2026-11-02T17:18:10.9512075+00:00",
"DueDate": "2026-11-02T17:18:10.9512075+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b0363119-ccbf-42c6-af69-6d8cfc48203b": "5db7cd3d-9fcd-4afc-94d2-94dd39d70447",
"dc77e198-d26b-4988-87c2-1cc69a7d000b": "ae1baaad-dbb9-48e4-b1b3-de4945509b1b"
},
"HasUpdates": true,
"Modified": "2026-11-02T17:18:10.9512075+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-11-02T17:18:10.9512075+00:00"
},
"LastComment": "2026-11-02T17:18:10.9512075+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6a5bf76a-3293-486b-ba9c-9f8cb3b67ada",
"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": "23688253-d25d-46eb-8082-6bcac0f4e865",
"id": "c1785655-ab8e-4e6a-be81-8113f81da474",
"ConfigId": "db07678f-e115-42c2-ba32-4c556bfd21e5"
}