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": "b9b70dbf-3817-459e-93e0-9285a0ce356b",
"ParentTaskId": "1a581b9b-bcd3-42c1-9461-0b8c1df2f5ae",
"Integration": {
"IntegrationId": "46a4fe84-43e2-486d-8e9a-880c34af062e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2c0e1568-62b2-45fd-8bda-2d544b1d75ee": 2.0,
"f08c12bf-da77-4f60-8a5c-d1e6e7ab9544": 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": "76ae0f77-ed24-4967-a107-8441b0885a8d",
"Name": "sample string 1",
"Created": "2026-09-17T20:14:52.9888496+00:00",
"Modified": "2026-09-17T20:14:52.9888496+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7cdc91f9-b082-4649-b2d4-43324f372023",
"0c1f6a74-3c3c-4213-be28-d463a10406c5"
],
"NonLaborAssignments": [
{
"Id": "573dd33f-129c-430f-bb5c-0106132e72d3",
"ResourceId": "7fcd82c6-0fba-46cc-a63f-ffbfe47b675b",
"Quantity": 3.0
},
{
"Id": "573dd33f-129c-430f-bb5c-0106132e72d3",
"ResourceId": "7fcd82c6-0fba-46cc-a63f-ffbfe47b675b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "19a2a692-c771-4580-93d5-4c75ef21a8d4",
"Type": 0,
"ResourceId": "f85b448f-a1d1-498d-a02d-8c31f954df41",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c9c3233a-1309-4b94-8cb9-f63dd81178eb",
"Start": "2026-09-17T20:14:52.9888496+00:00",
"Due": "2026-09-17T20:14:52.9888496+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c9c3233a-1309-4b94-8cb9-f63dd81178eb",
"Start": "2026-09-17T20:14:52.9888496+00:00",
"Due": "2026-09-17T20:14:52.9888496+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "19a2a692-c771-4580-93d5-4c75ef21a8d4",
"Type": 0,
"ResourceId": "f85b448f-a1d1-498d-a02d-8c31f954df41",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c9c3233a-1309-4b94-8cb9-f63dd81178eb",
"Start": "2026-09-17T20:14:52.9888496+00:00",
"Due": "2026-09-17T20:14:52.9888496+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c9c3233a-1309-4b94-8cb9-f63dd81178eb",
"Start": "2026-09-17T20:14:52.9888496+00:00",
"Due": "2026-09-17T20:14:52.9888496+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "fdb621e4-a947-40a2-a66c-2a1cd971d843",
"WorkTypeParentId": "7b87fe4c-bfa0-4b48-b899-07519adf4a58",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c0f9b908-5b14-4bec-a60b-5bf375aef1dc",
"UPN": "045eec23-88c5-4f7a-84c1-bf50d0a5cc64",
"PostDate": "2026-09-17T20:14:52.9888496+00:00",
"Comment": "sample string 4",
"CC": [
"37c79b7f-6c95-490c-83b2-53911a652117",
"8240a9e8-36e5-4f3d-a1e0-7d8c8c029f1e"
],
"Users": [
"5dd70443-62a6-4c89-aa04-28a74718223d",
"9a62e048-90da-4879-8a69-f216f0f90146"
]
},
{
"Id": "c0f9b908-5b14-4bec-a60b-5bf375aef1dc",
"UPN": "045eec23-88c5-4f7a-84c1-bf50d0a5cc64",
"PostDate": "2026-09-17T20:14:52.9888496+00:00",
"Comment": "sample string 4",
"CC": [
"37c79b7f-6c95-490c-83b2-53911a652117",
"8240a9e8-36e5-4f3d-a1e0-7d8c8c029f1e"
],
"Users": [
"5dd70443-62a6-4c89-aa04-28a74718223d",
"9a62e048-90da-4879-8a69-f216f0f90146"
]
}
],
"StartDate": "2026-09-17T20:14:52.9888496+00:00",
"DueDate": "2026-09-17T20:14:52.9888496+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f7f748cd-2f9b-4f7e-9ac0-143fa7db2a09": "e38001bc-3e73-4cd3-a167-6a879be7c46b",
"006624e6-aafa-47b2-83cf-7f5ff91be52e": "c5b05cc0-c3e2-426d-8d2d-c4779c1b99cf"
},
"HasUpdates": true,
"Modified": "2026-09-17T20:14:52.9888496+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-17T20:14:52.9888496+00:00"
},
"LastComment": "2026-09-17T20:14:52.9888496+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "06a2b77f-6036-4181-99c3-772b6cf707c7",
"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": "7fb41b67-3018-4820-8338-ad94e22eb321",
"id": "a62e3b2b-a682-4f75-960c-7db08e0dc190",
"ConfigId": "54b0068a-23f5-4492-8c1f-826ca857f8f1"
}