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": "ea5620bc-c214-48dd-93b3-0af0a823eaeb",
"ParentTaskId": "603a4e3c-1601-463f-8440-7deb7ff8b1f0",
"Integration": {
"IntegrationId": "72175741-0448-4e70-90f7-4ca506e6e1f8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"8842b840-c9ea-48dc-97d8-f3f782f04032": 2.0,
"1f72724f-04e2-4ece-8976-460361ce0ead": 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": "38d47b5e-ff08-4f89-9832-a46aa6832824",
"Name": "sample string 1",
"Created": "2026-10-10T18:46:15.3266836+00:00",
"Modified": "2026-10-10T18:46:15.3266836+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"19731883-ea32-4a1c-b986-f3469f832309",
"840bff8c-f192-42f6-801b-3e64871801c1"
],
"NonLaborAssignments": [
{
"Id": "00712f2b-0098-428a-be50-29bee7a5d6f3",
"ResourceId": "73e2fec9-91d9-4835-bc1b-79c9d6392683",
"Quantity": 3.0
},
{
"Id": "00712f2b-0098-428a-be50-29bee7a5d6f3",
"ResourceId": "73e2fec9-91d9-4835-bc1b-79c9d6392683",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1b2c290e-a09a-47a3-b09b-e5a2d983f945",
"Type": 0,
"ResourceId": "3ed5622f-9a66-4028-9a7d-cb7efe30f06f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7f89ef48-0097-4c02-9359-00206076faed",
"Start": "2026-10-10T18:46:15.3266836+00:00",
"Due": "2026-10-10T18:46:15.3266836+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7f89ef48-0097-4c02-9359-00206076faed",
"Start": "2026-10-10T18:46:15.3266836+00:00",
"Due": "2026-10-10T18:46:15.3266836+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "1b2c290e-a09a-47a3-b09b-e5a2d983f945",
"Type": 0,
"ResourceId": "3ed5622f-9a66-4028-9a7d-cb7efe30f06f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7f89ef48-0097-4c02-9359-00206076faed",
"Start": "2026-10-10T18:46:15.3266836+00:00",
"Due": "2026-10-10T18:46:15.3266836+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7f89ef48-0097-4c02-9359-00206076faed",
"Start": "2026-10-10T18:46:15.3266836+00:00",
"Due": "2026-10-10T18:46:15.3266836+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "8d802496-22c1-4535-9cb0-38631606fa52",
"WorkTypeParentId": "1f94d0ba-4ae0-42c6-8b5d-93eda59a366e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "09dc35b3-1428-43f8-8162-bbc9e8535eab",
"UPN": "57663be9-595f-4d79-88bf-8058a1983b2d",
"PostDate": "2026-10-10T18:46:15.3266836+00:00",
"Comment": "sample string 4",
"CC": [
"79e0d3a5-96c2-4cd3-beef-0f2f00bdb6f0",
"a7e74124-6c2a-4ca7-a8a3-cefc9ff66a0f"
],
"Users": [
"55ab8c4b-b383-4c7e-a673-c0fb5e74fceb",
"c221aaff-61e2-41ef-a4b7-3ecb876b4992"
]
},
{
"Id": "09dc35b3-1428-43f8-8162-bbc9e8535eab",
"UPN": "57663be9-595f-4d79-88bf-8058a1983b2d",
"PostDate": "2026-10-10T18:46:15.3266836+00:00",
"Comment": "sample string 4",
"CC": [
"79e0d3a5-96c2-4cd3-beef-0f2f00bdb6f0",
"a7e74124-6c2a-4ca7-a8a3-cefc9ff66a0f"
],
"Users": [
"55ab8c4b-b383-4c7e-a673-c0fb5e74fceb",
"c221aaff-61e2-41ef-a4b7-3ecb876b4992"
]
}
],
"StartDate": "2026-10-10T18:46:15.3266836+00:00",
"DueDate": "2026-10-10T18:46:15.3266836+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"287345bb-0e35-4d9f-93f8-98f589080f9d": "cf8f3605-ed51-436e-84a7-ce36381a4097",
"32bdc169-abb0-4c0e-9fdb-b7c720074808": "dae815f1-7c03-46f5-8976-c2bd54fc824c"
},
"HasUpdates": true,
"Modified": "2026-10-10T18:46:15.3266836+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-10T18:46:15.3266836+00:00"
},
"LastComment": "2026-10-10T18:46:15.3266836+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2b24317a-c5bc-451c-b0d8-0bce36b98527",
"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": "7a24d4e1-73df-459e-9011-72fcdae22a64",
"id": "2f3a9bef-de2a-4162-af7f-f9faa1380d8d",
"ConfigId": "6905f054-4367-4962-9542-7fa4a9055630"
}