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": "75f41d53-26cf-47e4-aa42-8454c4e94e40",
"ParentTaskId": "e6dc8ab7-4dd2-4e37-a069-13847b8936a3",
"Integration": {
"IntegrationId": "9de9e351-c912-4276-b9df-87b762ee1dcf",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b77c4a5f-a5df-4c0a-bf04-aaf0c91e3e75": 2.0,
"a21062a8-5e82-4522-9cba-e59b2f2d8f12": 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": "aad56275-5885-490e-9506-9328c896e54f",
"Name": "sample string 1",
"Created": "2026-07-12T01:46:42.4962388+00:00",
"Modified": "2026-07-12T01:46:42.4962388+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"566e9db9-d496-4b68-acf6-c69cd2bec0b1",
"126407e4-8392-4079-83a8-aaa3ef49b140"
],
"NonLaborAssignments": [
{
"Id": "34c4296b-81e2-4649-bcea-6f0066425016",
"ResourceId": "90af703e-806f-4fd6-8539-354886f45b37",
"Quantity": 3.0
},
{
"Id": "34c4296b-81e2-4649-bcea-6f0066425016",
"ResourceId": "90af703e-806f-4fd6-8539-354886f45b37",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "94630fa9-548e-4b25-baee-1157424387d5",
"Type": 0,
"ResourceId": "19899c77-c923-4b62-a141-d7d58cae4a08",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "94630fa9-548e-4b25-baee-1157424387d5",
"Type": 0,
"ResourceId": "19899c77-c923-4b62-a141-d7d58cae4a08",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "b2a8b09f-7588-4cb9-8c93-83e8658b4cec",
"WorkTypeParentId": "ca7a2851-5033-4291-8701-99ee0e4246e6",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7344c611-39b8-469a-9461-1e86497dce0c",
"UPN": "a4e9a47f-0a2a-4fb6-9d13-547b7ba13dd9",
"PostDate": "2026-07-12T01:46:42.4962388+00:00",
"Comment": "sample string 4",
"CC": [
"5a834df3-9833-4867-9018-f6218da76a66",
"49a6edc3-9377-45a1-9f13-b9892b615036"
],
"Users": [
"b7b61907-9656-40c6-b18d-f67730d527b8",
"fcc9d916-c761-42a2-a318-dc1680a5f37c"
]
},
{
"Id": "7344c611-39b8-469a-9461-1e86497dce0c",
"UPN": "a4e9a47f-0a2a-4fb6-9d13-547b7ba13dd9",
"PostDate": "2026-07-12T01:46:42.4962388+00:00",
"Comment": "sample string 4",
"CC": [
"5a834df3-9833-4867-9018-f6218da76a66",
"49a6edc3-9377-45a1-9f13-b9892b615036"
],
"Users": [
"b7b61907-9656-40c6-b18d-f67730d527b8",
"fcc9d916-c761-42a2-a318-dc1680a5f37c"
]
}
],
"StartDate": "2026-07-12T01:46:42.4962388+00:00",
"DueDate": "2026-07-12T01:46:42.4962388+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7a6d52df-692b-4330-a057-4203268448fa": "9cbd85c4-5e4e-42dc-aa5a-60acd1797f6b",
"dcf2fdc7-7a95-409c-8fa2-ce41a3b8cf32": "e4961515-008a-458d-ad95-84e4b7499463"
},
"HasUpdates": true,
"Modified": "2026-07-12T01:46:42.4962388+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-12T01:46:42.4962388+00:00"
},
"LastComment": "2026-07-12T01:46:42.4962388+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "71f0d160-df0b-41a1-98ad-7c4869867b64",
"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": "5ba9470b-4022-4a15-8914-954bc0fcc78e",
"id": "73b7f815-8bbb-486e-89ef-c72adf786c32",
"ConfigId": "33689a6c-6c3b-45eb-b6c0-a61a2a2bf42b"
}