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": "68c009a9-b350-4481-9432-8ea0b22aeadd",
"ParentTaskId": "e4c40ced-83de-4213-888c-c66789d07bf2",
"Integration": {
"IntegrationId": "ad6a0496-1dbe-4928-956f-e67326f33663",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a2eeeaed-657f-478a-b208-a0af303616a0": 2.0,
"a6377cf2-2a76-4e47-80b0-eadee1728ce2": 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": "2641cd39-0edf-4feb-9db0-3452585df3c3",
"Name": "sample string 1",
"Created": "2026-07-23T08:37:45.9324596+00:00",
"Modified": "2026-07-23T08:37:45.9324596+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3780cb4f-0c46-4304-994a-ba94d4a05dd4",
"97b1afa2-431e-4bc1-8de5-a8732aaf37ad"
],
"NonLaborAssignments": [
{
"Id": "014c26db-3d7c-4276-b81b-c3ffd454939b",
"ResourceId": "1b39c5f0-0740-4fe5-b3a2-e9834a138217",
"Quantity": 3.0
},
{
"Id": "014c26db-3d7c-4276-b81b-c3ffd454939b",
"ResourceId": "1b39c5f0-0740-4fe5-b3a2-e9834a138217",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f4510a1a-acce-4cea-99e7-e0a4e32eb955",
"Type": 0,
"ResourceId": "b7c9fae7-df22-47d0-a430-4fcc7bb23827",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "f4510a1a-acce-4cea-99e7-e0a4e32eb955",
"Type": 0,
"ResourceId": "b7c9fae7-df22-47d0-a430-4fcc7bb23827",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "7d6bf91d-81cd-49e3-b09c-31e177391ee3",
"WorkTypeParentId": "b15173af-d09a-411a-a943-7f4ae3cd43c7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4e1dad91-0e88-4568-b8b3-3d3171e31402",
"UPN": "02f4c8bd-19e9-4081-bd48-ef1da9285eb7",
"PostDate": "2026-07-23T08:37:45.9324596+00:00",
"Comment": "sample string 4",
"CC": [
"db59e92e-3112-453f-aee9-bb88125c0014",
"889f1fd3-73e7-46bb-b908-1757400bb3c9"
],
"Users": [
"59e90e1f-8397-46a2-aee0-d82c5ec3f6e7",
"9cdb9f86-eefa-4caa-b4fa-a35fe6449017"
]
},
{
"Id": "4e1dad91-0e88-4568-b8b3-3d3171e31402",
"UPN": "02f4c8bd-19e9-4081-bd48-ef1da9285eb7",
"PostDate": "2026-07-23T08:37:45.9324596+00:00",
"Comment": "sample string 4",
"CC": [
"db59e92e-3112-453f-aee9-bb88125c0014",
"889f1fd3-73e7-46bb-b908-1757400bb3c9"
],
"Users": [
"59e90e1f-8397-46a2-aee0-d82c5ec3f6e7",
"9cdb9f86-eefa-4caa-b4fa-a35fe6449017"
]
}
],
"StartDate": "2026-07-23T08:37:45.9324596+00:00",
"DueDate": "2026-07-23T08:37:45.9324596+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4cd73ae6-d4a6-46f5-b331-60338643f2b6": "fc2012fa-3c0c-4d51-b527-c6f72346e568",
"5510bf4e-5045-4af6-b435-c540d87e9768": "ee8d6800-bc2b-4eea-8444-1009e73490e2"
},
"HasUpdates": true,
"Modified": "2026-07-23T08:37:45.9324596+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-23T08:37:45.9324596+00:00"
},
"LastComment": "2026-07-23T08:37:45.9324596+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7966f42f-d617-4c95-b0ec-b003e44e2525",
"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": "641d9e8c-2e77-467f-a4a2-0b7653d5dda6",
"id": "bc5e2b51-c7ad-4c76-b3a2-313b844cd793",
"ConfigId": "871271eb-a4d3-479a-bb93-1c3f2fcfec4c"
}