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": "9f932515-4aeb-415a-a660-910502a21717",
"ParentTaskId": "3111ae9a-b4d4-4622-b708-eb1af3900245",
"Integration": {
"IntegrationId": "f0264da5-8c0c-4da0-8c66-47a36ffa77ac",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"449de008-284b-48bd-a628-4bd6597d1ce0": 2.0,
"1a644e24-8873-4b93-833c-3489edc4046b": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "6c92bcf6-e36b-470a-972a-2fefedcaa4af",
"Name": "sample string 1",
"Created": "2026-02-11T15:36:21.3210373+00:00",
"Modified": "2026-02-11T15:36:21.3210373+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5d7a1e10-0645-47b3-b4d7-fdd91109f753",
"28d1c8df-0575-4e08-b318-f1ecf1a80aa3"
],
"NonLaborAssignments": [
{
"Id": "7ed7abf3-6a91-4d40-aceb-081a88bcff7d",
"ResourceId": "751e5e20-893c-4b29-8aee-b7a00ad4c76f",
"Quantity": 3.0
},
{
"Id": "7ed7abf3-6a91-4d40-aceb-081a88bcff7d",
"ResourceId": "751e5e20-893c-4b29-8aee-b7a00ad4c76f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "eaf9a283-aa15-4d89-ba7c-1d1728c9e6c8",
"Type": 0,
"ResourceId": "f3578c8d-e977-4433-8ac3-ab2951b222e2",
"Units": 3.0
},
{
"Id": "eaf9a283-aa15-4d89-ba7c-1d1728c9e6c8",
"Type": 0,
"ResourceId": "f3578c8d-e977-4433-8ac3-ab2951b222e2",
"Units": 3.0
}
],
"ParentId": "37bf977f-7130-41b8-827b-10b19691a931",
"WorkTypeParentId": "b282ae30-9237-4029-8fd0-5c5cfe71cb04",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "78eba49f-7401-41d2-b099-8fb56a8fa874",
"UPN": "f117e704-b24b-4a4b-807b-5a131838080a",
"PostDate": "2026-02-11T15:36:21.3210373+00:00",
"Comment": "sample string 4",
"CC": [
"7717178c-16d6-499e-b414-5ca8a3c2de31",
"bdfe2e11-c677-424e-ac70-a85897de8960"
],
"Users": [
"2e06fe4e-68e7-488d-8988-2b37d0c784fe",
"28731c89-f4bf-4792-8c4a-3d4f4cb81895"
]
},
{
"Id": "78eba49f-7401-41d2-b099-8fb56a8fa874",
"UPN": "f117e704-b24b-4a4b-807b-5a131838080a",
"PostDate": "2026-02-11T15:36:21.3210373+00:00",
"Comment": "sample string 4",
"CC": [
"7717178c-16d6-499e-b414-5ca8a3c2de31",
"bdfe2e11-c677-424e-ac70-a85897de8960"
],
"Users": [
"2e06fe4e-68e7-488d-8988-2b37d0c784fe",
"28731c89-f4bf-4792-8c4a-3d4f4cb81895"
]
}
],
"StartDate": "2026-02-11T15:36:21.3210373+00:00",
"DueDate": "2026-02-11T15:36:21.3210373+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fa8fecf6-aa1d-4b1c-b363-ecf7b9dbaf1c": "2b4444ab-22dd-40f7-a2c9-5e04224e0592",
"95bec320-758b-487a-9a89-54fcf21c56eb": "9f049584-d91b-4700-85a3-d384a0ba26b8"
},
"HasUpdates": true,
"Modified": "2026-02-11T15:36:21.3210373+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-02-11T15:36:21.3210373+00:00"
},
"LastComment": "2026-02-11T15:36:21.3210373+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "64b2c1ca-8f75-4f53-b875-939e43dbed8d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "057084e6-fca0-4543-b250-487bb483f61d",
"id": "83fab79c-5313-4c38-98da-4fbd20d5d783",
"ConfigId": "b25248ce-a83a-4d50-9f80-86d697eec8c9"
}