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": "3ba743e3-1c8c-493c-b649-af46b317cadc",
"ParentTaskId": "dcdbae27-d5bc-4280-b381-97a51cc28a32",
"Integration": {
"IntegrationId": "9875f53b-e490-4ee4-9903-3d612b03c77f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7c58cd99-6ebb-4a40-a260-9f3894257297": 2.0,
"74305e4e-be1f-4586-967e-780c00fe1956": 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": "ad1e20a3-cd8b-463a-baef-1f933df9fded",
"Name": "sample string 1",
"Created": "2026-02-02T12:37:20.6846687+00:00",
"Modified": "2026-02-02T12:37:20.6846687+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"85ff3791-f337-47bf-b81b-deff435d7fe0",
"c1510061-4aea-4ca7-a12f-eb04a4cfc038"
],
"NonLaborAssignments": [
{
"Id": "74b1770a-8838-4301-8267-fd57c38e1573",
"ResourceId": "f9558214-c14a-4dfd-9f9c-883ba9fae6b3",
"Quantity": 3.0
},
{
"Id": "74b1770a-8838-4301-8267-fd57c38e1573",
"ResourceId": "f9558214-c14a-4dfd-9f9c-883ba9fae6b3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c3b48efa-1eea-44b3-aa30-fa6632867e3e",
"Type": 0,
"ResourceId": "0b9062c7-8d8d-4352-ad2e-233acd9ac2f4",
"Units": 3.0
},
{
"Id": "c3b48efa-1eea-44b3-aa30-fa6632867e3e",
"Type": 0,
"ResourceId": "0b9062c7-8d8d-4352-ad2e-233acd9ac2f4",
"Units": 3.0
}
],
"ParentId": "8fd41af4-1cae-4edf-931e-372253290e32",
"WorkTypeParentId": "4fe0aac9-5b73-4986-b56a-be28a087d705",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bc0075a9-6b8e-414c-b208-3e6682a97d02",
"UPN": "54b7195c-eab0-4938-b601-a6ea8b197c02",
"PostDate": "2026-02-02T12:37:20.6846687+00:00",
"Comment": "sample string 4",
"CC": [
"e5924bcf-658f-44ab-8e74-f3de4a47b629",
"076286e4-a425-4314-9ad4-7965dc038d69"
],
"Users": [
"15cf4fd2-98ea-4570-81c6-da81e5044176",
"64fda355-7c7b-4f06-aac2-ecc64f55c410"
]
},
{
"Id": "bc0075a9-6b8e-414c-b208-3e6682a97d02",
"UPN": "54b7195c-eab0-4938-b601-a6ea8b197c02",
"PostDate": "2026-02-02T12:37:20.6846687+00:00",
"Comment": "sample string 4",
"CC": [
"e5924bcf-658f-44ab-8e74-f3de4a47b629",
"076286e4-a425-4314-9ad4-7965dc038d69"
],
"Users": [
"15cf4fd2-98ea-4570-81c6-da81e5044176",
"64fda355-7c7b-4f06-aac2-ecc64f55c410"
]
}
],
"StartDate": "2026-02-02T12:37:20.6846687+00:00",
"DueDate": "2026-02-02T12:37:20.6846687+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b90c88b7-1f39-4252-b34f-d310730b2e57": "74516bff-f37c-4c74-a752-3ad433042ff5",
"0842a8c3-55d0-4577-b18e-3e22a06ac265": "d151bd86-cff3-4175-b940-2f228b9d49b7"
},
"HasUpdates": true,
"Modified": "2026-02-02T12:37:20.6846687+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-02T12:37:20.6846687+00:00"
},
"LastComment": "2026-02-02T12:37:20.6846687+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a6246b22-5fdd-4db1-8b94-e1941b69b89d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "069b91ff-58fb-4f66-ab12-3b6d03d16e21",
"id": "6743c0f7-1b26-49f6-bb6c-d6911aaec6ff",
"ConfigId": "7334197d-a2d6-45e0-84c7-95bc152e3ac4"
}