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": "000b7e1c-ce1e-4a41-a02f-2cbc1e6607eb",
"ParentTaskId": "bc578e62-6e57-4bfb-ba92-294f161ae93e",
"Integration": {
"IntegrationId": "99c57be9-6d77-49f0-9fde-b027611352a7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7ba8e5c3-4eaa-4bba-b7a7-cc4c7b97c416": 2.0,
"4de09345-18a2-43d0-b120-b1074a52728d": 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": "cac5b1cb-1115-4dc4-9417-07e9f1e286fb",
"Name": "sample string 1",
"Created": "2026-06-29T16:51:56.3023179+00:00",
"Modified": "2026-06-29T16:51:56.3023179+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"64099239-f966-4664-883d-c1f60d024bcf",
"705ac01a-5c7d-496e-b7a2-d51951013362"
],
"NonLaborAssignments": [
{
"Id": "c1c07e07-1239-4c24-bebc-ed6225bb5002",
"ResourceId": "74de4139-d46c-4898-bc26-2288c06644f2",
"Quantity": 3.0
},
{
"Id": "c1c07e07-1239-4c24-bebc-ed6225bb5002",
"ResourceId": "74de4139-d46c-4898-bc26-2288c06644f2",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ae109ee3-c35e-49fe-8ca7-2cc9062fdbbe",
"Type": 0,
"ResourceId": "c17f9a4f-bedd-47a0-938b-f4b2ee89932e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "ae109ee3-c35e-49fe-8ca7-2cc9062fdbbe",
"Type": 0,
"ResourceId": "c17f9a4f-bedd-47a0-938b-f4b2ee89932e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "95500244-2d73-4d14-9424-9033cfb87c6e",
"WorkTypeParentId": "ef97137b-1b4d-4114-a9c2-a27c604e84b3",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8865fc6f-4cbf-48d1-b173-28b50fd21b70",
"UPN": "1c473062-1c00-4127-bc1c-daec5c73c70e",
"PostDate": "2026-06-29T16:51:56.3023179+00:00",
"Comment": "sample string 4",
"CC": [
"69a42802-10b3-43cc-8ccc-c35c3dd45822",
"014fcb15-49d3-44ee-94ea-56eb04fd36c6"
],
"Users": [
"fb1c171c-28b7-478e-9f97-d91a9be79eca",
"0682625d-ff5f-4131-9b06-55c43f5dec95"
]
},
{
"Id": "8865fc6f-4cbf-48d1-b173-28b50fd21b70",
"UPN": "1c473062-1c00-4127-bc1c-daec5c73c70e",
"PostDate": "2026-06-29T16:51:56.3023179+00:00",
"Comment": "sample string 4",
"CC": [
"69a42802-10b3-43cc-8ccc-c35c3dd45822",
"014fcb15-49d3-44ee-94ea-56eb04fd36c6"
],
"Users": [
"fb1c171c-28b7-478e-9f97-d91a9be79eca",
"0682625d-ff5f-4131-9b06-55c43f5dec95"
]
}
],
"StartDate": "2026-06-29T16:51:56.3023179+00:00",
"DueDate": "2026-06-29T16:51:56.3023179+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d96f9bac-97c3-4106-a4e7-42e0ceb08089": "8a6f0dee-0ac8-46e5-926c-b245ef38a19b",
"7aed10a7-c1f8-4b87-948f-9e43ff4f6b44": "b00d3eec-baed-4b20-8ee5-23dd0c176cb5"
},
"HasUpdates": true,
"Modified": "2026-06-29T16:51:56.3023179+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-06-29T16:51:56.3023179+00:00"
},
"LastComment": "2026-06-29T16:51:56.3023179+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0dd1b91d-2034-4f1c-88e3-efe941843c51",
"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": "dc6c4d25-67ad-4769-9afe-2496ff2f240f",
"id": "d09c72c8-97d9-46a8-86b3-83dde785c46d",
"ConfigId": "b76e601f-06ba-497a-90c7-75b5321aa66b"
}