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": "ebf62255-bc0b-46aa-b4b9-13899bd561ab",
"ParentTaskId": "c8ede92c-9a39-4582-86ed-9d7d29f79ed3",
"Integration": {
"IntegrationId": "eb57acf4-7dae-4bad-aaee-7b2ec32bd983",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"291c307a-2bf0-4b58-aeb0-d37e3d26b57e": 2.0,
"8dd5d4e9-2081-487a-85ac-7d1181971bf8": 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": "e37913c6-48ed-404b-993e-b8518767de78",
"Name": "sample string 1",
"Created": "2026-07-24T23:02:56.049403+00:00",
"Modified": "2026-07-24T23:02:56.049403+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"35634e86-b664-46fe-a08b-83e950e19e42",
"6959db96-e8c3-454f-b285-1f8ef8200d35"
],
"NonLaborAssignments": [
{
"Id": "b86433e7-d015-4a3e-bb75-417599e0cbec",
"ResourceId": "24deeb1a-cfa5-4793-9eb7-53478c0f9a30",
"Quantity": 3.0
},
{
"Id": "b86433e7-d015-4a3e-bb75-417599e0cbec",
"ResourceId": "24deeb1a-cfa5-4793-9eb7-53478c0f9a30",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9ec9c59c-2279-4342-8f7e-79feed4c495f",
"Type": 0,
"ResourceId": "c3defae0-b6ef-4963-a610-13faca5aeb00",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "9ec9c59c-2279-4342-8f7e-79feed4c495f",
"Type": 0,
"ResourceId": "c3defae0-b6ef-4963-a610-13faca5aeb00",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "deff54f0-c3e0-48df-9c07-c84e67fabd26",
"WorkTypeParentId": "adf8cb8d-0095-47e4-be87-a16f14826a93",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6a477633-a933-40c5-aceb-9257f89336fd",
"UPN": "22d5020a-21b0-4ed8-bc95-7fc0181646aa",
"PostDate": "2026-07-24T23:02:56.049403+00:00",
"Comment": "sample string 4",
"CC": [
"65376fd4-0742-43ab-962f-c7b7c4cfb22c",
"45db5834-c800-4a9b-b020-cd3d223016fe"
],
"Users": [
"f6d17667-cbb8-4360-86b6-d57952c34c41",
"2360f3e6-6fce-4c1f-99ad-e6e1a985851a"
]
},
{
"Id": "6a477633-a933-40c5-aceb-9257f89336fd",
"UPN": "22d5020a-21b0-4ed8-bc95-7fc0181646aa",
"PostDate": "2026-07-24T23:02:56.049403+00:00",
"Comment": "sample string 4",
"CC": [
"65376fd4-0742-43ab-962f-c7b7c4cfb22c",
"45db5834-c800-4a9b-b020-cd3d223016fe"
],
"Users": [
"f6d17667-cbb8-4360-86b6-d57952c34c41",
"2360f3e6-6fce-4c1f-99ad-e6e1a985851a"
]
}
],
"StartDate": "2026-07-24T23:02:56.049403+00:00",
"DueDate": "2026-07-24T23:02:56.049403+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1c813701-147f-44f9-b304-4382d9d81bb3": "6a2942f0-5750-423a-92be-9efa4859b9d7",
"fa805061-c7ff-4c09-a627-bee6d9384c05": "9015e008-4df0-41ab-992e-3a0aa16ba3e4"
},
"HasUpdates": true,
"Modified": "2026-07-24T23:02:56.049403+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-07-24T23:02:56.049403+00:00"
},
"LastComment": "2026-07-24T23:02:56.049403+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9804a420-f37f-472c-b354-97ccba4c2712",
"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": "b25536fe-3963-4eb2-93de-e5d96dcb76e4",
"id": "88023be6-da93-4bc3-a3ec-d2f84f796de2",
"ConfigId": "55f46400-3197-4740-8c40-7113df4996ed"
}