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": "16113810-acc7-4db5-85f9-f10809678cd3",
"ParentTaskId": "35628d97-2bce-47f5-8e98-d65b3a16f86b",
"Integration": {
"IntegrationId": "ee71deec-2081-4b91-802e-22856e3e4418",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6eb82044-474b-4b0e-a181-851d777ddf24": 2.0,
"cc695009-2c38-42a8-9424-7567693ca798": 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": "37ee64e4-02a2-4c03-a432-fa0b4dacda85",
"Name": "sample string 1",
"Created": "2026-09-01T19:52:20.5323369+00:00",
"Modified": "2026-09-01T19:52:20.5323369+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"35b3380b-b170-497b-8f38-d78b73e1d3dd",
"f3658f99-a946-4e08-9275-723173d03248"
],
"NonLaborAssignments": [
{
"Id": "51d81ce6-b545-4efa-8cfc-346ce1969022",
"ResourceId": "9044907c-8ce4-482a-a633-544b0dedf22b",
"Quantity": 3.0
},
{
"Id": "51d81ce6-b545-4efa-8cfc-346ce1969022",
"ResourceId": "9044907c-8ce4-482a-a633-544b0dedf22b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "733797b8-2fae-4f01-bb5c-f618ae1e87f9",
"Type": 0,
"ResourceId": "09ad5c37-b661-4581-a5fb-11897a1407ed",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2d012bd2-3d39-43e5-bb58-43a0b15be266",
"Start": "2026-09-01T19:52:20.5323369+00:00",
"Due": "2026-09-01T19:52:20.5323369+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2d012bd2-3d39-43e5-bb58-43a0b15be266",
"Start": "2026-09-01T19:52:20.5323369+00:00",
"Due": "2026-09-01T19:52:20.5323369+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "733797b8-2fae-4f01-bb5c-f618ae1e87f9",
"Type": 0,
"ResourceId": "09ad5c37-b661-4581-a5fb-11897a1407ed",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2d012bd2-3d39-43e5-bb58-43a0b15be266",
"Start": "2026-09-01T19:52:20.5323369+00:00",
"Due": "2026-09-01T19:52:20.5323369+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2d012bd2-3d39-43e5-bb58-43a0b15be266",
"Start": "2026-09-01T19:52:20.5323369+00:00",
"Due": "2026-09-01T19:52:20.5323369+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "e4b65b99-e24f-4179-8054-95c12742950b",
"WorkTypeParentId": "5e1172d2-4074-4c1b-a65a-2ec3773912e4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e89dd945-7e86-4075-8ff3-639837f7811f",
"UPN": "ce478b23-4272-4b54-8231-06545f9ddbb8",
"PostDate": "2026-09-01T19:52:20.5479346+00:00",
"Comment": "sample string 4",
"CC": [
"2b221462-472d-4658-8e2f-f14b54988086",
"61c77e2a-8e54-49fa-8213-4bc44db6ede7"
],
"Users": [
"820f1e28-c69d-42bd-92ae-ac21a6bba420",
"84a70d15-d7a5-445c-9e74-aad074b8b816"
]
},
{
"Id": "e89dd945-7e86-4075-8ff3-639837f7811f",
"UPN": "ce478b23-4272-4b54-8231-06545f9ddbb8",
"PostDate": "2026-09-01T19:52:20.5479346+00:00",
"Comment": "sample string 4",
"CC": [
"2b221462-472d-4658-8e2f-f14b54988086",
"61c77e2a-8e54-49fa-8213-4bc44db6ede7"
],
"Users": [
"820f1e28-c69d-42bd-92ae-ac21a6bba420",
"84a70d15-d7a5-445c-9e74-aad074b8b816"
]
}
],
"StartDate": "2026-09-01T19:52:20.5479346+00:00",
"DueDate": "2026-09-01T19:52:20.5479346+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ab2b1b38-14d5-4fd6-a272-2c51ae956787": "0eeb9bf6-a751-4bab-ae04-6ca7f93d62da",
"fcf0e09f-f339-4232-8fb7-ae14d7a93508": "7828aaa1-919e-4417-953d-c6bc4500c1a3"
},
"HasUpdates": true,
"Modified": "2026-09-01T19:52:20.5479346+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-09-01T19:52:20.5479346+00:00"
},
"LastComment": "2026-09-01T19:52:20.5479346+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b3ee5ca9-9d81-466b-b9f5-05e36a894e14",
"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": "fa06ec5b-5128-4f05-8de5-c26bae01d254",
"id": "b8ca6263-38cb-4c32-ba8c-40fec6402e4e",
"ConfigId": "ebefd23e-7d46-4014-907b-ced7d0eddf37"
}