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": "e1df059f-22a8-49b7-9465-859b427deec6",
"ParentTaskId": "82547ee0-bf8d-4d2c-9bea-fe245eae4e44",
"Integration": {
"IntegrationId": "af7529e8-e063-45c7-ab8e-e7c772d0ed58",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"add3f45d-51f4-42c9-afa9-0aa89b952fe5": 2.0,
"11afa0b8-d245-4080-b8de-309c76ec101f": 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": "69a7e219-b66c-4d5d-918d-0d6aa0869f29",
"Name": "sample string 1",
"Created": "2026-07-18T19:04:39.09836+00:00",
"Modified": "2026-07-18T19:04:39.09836+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"77d9dc47-8b67-4ee4-a5c3-68dea68f8907",
"a5f30c16-f04c-42df-aa70-46ddb95ac495"
],
"NonLaborAssignments": [
{
"Id": "eb05bad4-858f-47c7-b702-27fa00116140",
"ResourceId": "506817de-d9e9-4b91-9d5b-fda8b1bd89bc",
"Quantity": 3.0
},
{
"Id": "eb05bad4-858f-47c7-b702-27fa00116140",
"ResourceId": "506817de-d9e9-4b91-9d5b-fda8b1bd89bc",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "27e7bac3-7978-4e54-ad69-0e6a0fc6d073",
"Type": 0,
"ResourceId": "7c6e1dca-c050-4335-bd47-141cd4781619",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "27e7bac3-7978-4e54-ad69-0e6a0fc6d073",
"Type": 0,
"ResourceId": "7c6e1dca-c050-4335-bd47-141cd4781619",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "222e5f6d-eeb8-40cf-b355-dfa16550f8aa",
"WorkTypeParentId": "87991933-38ab-47f6-b122-99c7c860142e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7c4fe32f-5976-45ce-abaf-ce849e5b1f49",
"UPN": "12329f41-34cc-4d32-85e2-fc7ecc859ba0",
"PostDate": "2026-07-18T19:04:39.09836+00:00",
"Comment": "sample string 4",
"CC": [
"1a538e38-42be-43f2-aead-87ca00e80f2b",
"94449a1e-b9bb-4484-a79f-c66360af8c4d"
],
"Users": [
"82a81baf-53b3-42bc-b3c3-aa6b275335b4",
"9ed6ee38-8aa9-472d-b2a9-6a9c058459ce"
]
},
{
"Id": "7c4fe32f-5976-45ce-abaf-ce849e5b1f49",
"UPN": "12329f41-34cc-4d32-85e2-fc7ecc859ba0",
"PostDate": "2026-07-18T19:04:39.09836+00:00",
"Comment": "sample string 4",
"CC": [
"1a538e38-42be-43f2-aead-87ca00e80f2b",
"94449a1e-b9bb-4484-a79f-c66360af8c4d"
],
"Users": [
"82a81baf-53b3-42bc-b3c3-aa6b275335b4",
"9ed6ee38-8aa9-472d-b2a9-6a9c058459ce"
]
}
],
"StartDate": "2026-07-18T19:04:39.09836+00:00",
"DueDate": "2026-07-18T19:04:39.09836+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"11b11057-1241-4471-9e10-da04575cb1e0": "2e962b73-7e7d-4f15-9f0a-32393d8138c9",
"f959e625-fc9e-4ba0-9bbe-d9ca275e7413": "7abe5827-87a6-4ee3-9a48-40b72043b35a"
},
"HasUpdates": true,
"Modified": "2026-07-18T19:04:39.09836+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-18T19:04:39.09836+00:00"
},
"LastComment": "2026-07-18T19:04:39.09836+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "31ff887f-2841-4a4b-8186-7005dd7550bf",
"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": "6dff3161-cd4d-473f-9d70-d065fe0fe16f",
"id": "578ca50d-bb2d-4588-ad72-0e99454ed489",
"ConfigId": "ce43e922-f533-47be-aa5a-b8e2b1f6f395"
}