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": "8243145f-2dca-467b-be9f-796114a3bae6",
"ParentTaskId": "f4134b05-4fdd-44c0-9ea7-a2ac4e5b618e",
"Integration": {
"IntegrationId": "00e00605-6500-4e08-84f4-deaf43eeb710",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"aec4b53a-5bb4-4bdc-aaf1-4a0546ae8f3d": 2.0,
"e07cd193-956c-4017-8830-1e02996a8fe9": 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": "ef565f2c-8de7-42ac-92af-ee0634979c8a",
"Name": "sample string 1",
"Created": "2025-12-09T09:42:50.9899973+00:00",
"Modified": "2025-12-09T09:42:50.9899973+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4071dbb7-915d-407b-acc9-e5e8b583b320",
"266e18cc-0c4c-4eb9-9a01-0bad1d1249d2"
],
"NonLaborAssignments": [
{
"Id": "b3d9ecb9-bd64-4f32-afcc-d394e5d2c02a",
"ResourceId": "76be7a46-d02e-49ff-85a3-33bef539d9bb",
"Quantity": 3.0
},
{
"Id": "b3d9ecb9-bd64-4f32-afcc-d394e5d2c02a",
"ResourceId": "76be7a46-d02e-49ff-85a3-33bef539d9bb",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "682acd20-cc1a-41c6-aec0-6654474ccc25",
"Type": 0,
"ResourceId": "e028933b-e24e-4072-9d4c-57b3f753d3e9",
"Units": 3.0
},
{
"Id": "682acd20-cc1a-41c6-aec0-6654474ccc25",
"Type": 0,
"ResourceId": "e028933b-e24e-4072-9d4c-57b3f753d3e9",
"Units": 3.0
}
],
"ParentId": "27fcc5f8-0c56-42d3-8a65-711e7088eaee",
"WorkTypeParentId": "7bd40369-383a-4db1-bad1-cbfa1ec0988c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ce5be336-698f-40b9-8855-6851df3e9ea7",
"UPN": "15034973-b83e-490b-a1e1-61189974e488",
"PostDate": "2025-12-09T09:42:50.9899973+00:00",
"Comment": "sample string 4",
"CC": [
"e78e279f-26ee-430b-845a-7fa745e09953",
"2044e2a4-a4ae-4d53-a89c-f5e6f9165613"
],
"Users": [
"6f44d392-3560-49b4-9f56-bb49d490c5fb",
"00c80e7f-d6e1-4747-a841-64e4beb9869e"
]
},
{
"Id": "ce5be336-698f-40b9-8855-6851df3e9ea7",
"UPN": "15034973-b83e-490b-a1e1-61189974e488",
"PostDate": "2025-12-09T09:42:50.9899973+00:00",
"Comment": "sample string 4",
"CC": [
"e78e279f-26ee-430b-845a-7fa745e09953",
"2044e2a4-a4ae-4d53-a89c-f5e6f9165613"
],
"Users": [
"6f44d392-3560-49b4-9f56-bb49d490c5fb",
"00c80e7f-d6e1-4747-a841-64e4beb9869e"
]
}
],
"StartDate": "2025-12-09T09:42:51.0056184+00:00",
"DueDate": "2025-12-09T09:42:51.0056184+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9580fade-8046-4147-85bb-0607adcc4280": "cc4d8601-9397-4537-9917-9df6bd884e23",
"063e9ac6-294f-43f6-8e7b-31ec59736854": "154520a8-8054-4ca9-8013-3addc44a3363"
},
"HasUpdates": true,
"Modified": "2025-12-09T09:42:51.0056184+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": "2025-12-09T09:42:51.0056184+00:00"
},
"LastComment": "2025-12-09T09:42:51.0056184+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "181de6b5-8fd9-4f8f-bd56-8254f973a894",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "35b9e961-5e0e-4395-8ffa-74753ccccb62",
"id": "8f848dc6-ed6b-4402-878a-d9f846068f62",
"ConfigId": "8af9b512-945c-470b-81bf-077b8068c44f"
}