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": "b6f81fa7-c91e-45c7-a7c9-f0926a213fdd",
"ParentTaskId": "d84f6c18-a5cc-44f3-a218-d1f8706d59ed",
"Integration": {
"IntegrationId": "c2507d47-67f7-44a5-bde1-5acae3433b88",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"504ecebc-f9a7-48d3-9b9b-0e443f43bf8a": 2.0,
"1d83ab21-dc8a-4b1f-8e90-d785fd623023": 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": "b2fcd35a-7eac-41fe-a92d-37fcffb0ea23",
"Name": "sample string 1",
"Created": "2025-12-08T06:37:17.1555597+00:00",
"Modified": "2025-12-08T06:37:17.1555597+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5684f02d-3a44-4b8d-8038-872a93e7578d",
"9d997488-4a36-4d5d-9256-e9bc296b47b7"
],
"NonLaborAssignments": [
{
"Id": "8a41c1da-d667-4894-b57c-333958fc9475",
"ResourceId": "ad5f5b8a-83dd-4dc2-8092-f81316785c1d",
"Quantity": 3.0
},
{
"Id": "8a41c1da-d667-4894-b57c-333958fc9475",
"ResourceId": "ad5f5b8a-83dd-4dc2-8092-f81316785c1d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b0f015f6-84b2-41cf-ab74-ff3194bd354d",
"Type": 0,
"ResourceId": "16a7cba9-436b-4c69-ba87-c1eb1b1f9675",
"Units": 3.0
},
{
"Id": "b0f015f6-84b2-41cf-ab74-ff3194bd354d",
"Type": 0,
"ResourceId": "16a7cba9-436b-4c69-ba87-c1eb1b1f9675",
"Units": 3.0
}
],
"ParentId": "de5dea2a-9226-4ef4-ba94-61f6a3d0c653",
"WorkTypeParentId": "8ca7dbc2-f799-4c02-8ac8-7443a2b72328",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3fb74fa1-48df-441f-bcfb-e98dc9739fda",
"UPN": "3cf09068-cfc8-4cd4-abd1-c0a98d007fe4",
"PostDate": "2025-12-08T06:37:17.1555597+00:00",
"Comment": "sample string 4",
"CC": [
"673a3e17-291b-485d-8396-72aa577ffffe",
"e54bb6fa-ef21-4425-ba66-d899bab319af"
],
"Users": [
"5504bd20-d191-4c65-952e-407651229e39",
"4e86158d-fdc4-4501-90dd-63319e829c6f"
]
},
{
"Id": "3fb74fa1-48df-441f-bcfb-e98dc9739fda",
"UPN": "3cf09068-cfc8-4cd4-abd1-c0a98d007fe4",
"PostDate": "2025-12-08T06:37:17.1555597+00:00",
"Comment": "sample string 4",
"CC": [
"673a3e17-291b-485d-8396-72aa577ffffe",
"e54bb6fa-ef21-4425-ba66-d899bab319af"
],
"Users": [
"5504bd20-d191-4c65-952e-407651229e39",
"4e86158d-fdc4-4501-90dd-63319e829c6f"
]
}
],
"StartDate": "2025-12-08T06:37:17.1555597+00:00",
"DueDate": "2025-12-08T06:37:17.1555597+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6a08ab59-5950-47ff-8539-a6631cd7fa8c": "6c90816d-17e3-43f8-baa5-1df8715cd175",
"914d667c-53cc-484d-bdc4-ae4d0dec2c8b": "0f7da371-cc4e-491f-a632-6fa316696bd9"
},
"HasUpdates": true,
"Modified": "2025-12-08T06:37:17.1555597+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-08T06:37:17.1555597+00:00"
},
"LastComment": "2025-12-08T06:37:17.1555597+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c54edd28-8290-45b5-9e78-fb0d6dedf6f9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "3c5577a2-c472-42cd-9671-540b7cf47ee9",
"id": "ec677e50-c7dc-418e-9a19-22c260c11300",
"ConfigId": "582b00bb-139e-4d26-8c1b-11d01a34dcff"
}