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": "39583f1c-b50a-43f3-8ff4-afc73906d277",
"ParentTaskId": "ccf0157f-e139-433f-a28b-a9561f4ad50e",
"Integration": {
"IntegrationId": "0a6c7a75-3729-4c6a-9633-9f03fa8a691f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e69ca17b-4b9c-4652-b73f-c7cc534d842e": 2.0,
"1c3dbcba-73db-4b56-9475-0e87e599c268": 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": "e9cb14fe-4216-43fd-a271-5d4fbcc78a78",
"Name": "sample string 1",
"Created": "2025-10-26T01:11:54.5298687+00:00",
"Modified": "2025-10-26T01:11:54.5298687+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"45b85fe5-878b-455f-b3b5-1c75d8f28272",
"30d21433-27a8-4144-9b6d-a930c4f8f990"
],
"NonLaborAssignments": [
{
"Id": "ffff25de-47e7-4b40-b794-c74c4bda5303",
"ResourceId": "0df363ee-758d-40bf-b081-dc0e787b187a",
"Quantity": 3.0
},
{
"Id": "ffff25de-47e7-4b40-b794-c74c4bda5303",
"ResourceId": "0df363ee-758d-40bf-b081-dc0e787b187a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7f1f13d5-07f8-4f40-993e-de6dd5d3b3e0",
"Type": 0,
"ResourceId": "83ca008f-a761-4a62-85ca-aa2f531ea4ca",
"Units": 3.0
},
{
"Id": "7f1f13d5-07f8-4f40-993e-de6dd5d3b3e0",
"Type": 0,
"ResourceId": "83ca008f-a761-4a62-85ca-aa2f531ea4ca",
"Units": 3.0
}
],
"ParentId": "3c1a4f58-cb69-4082-b511-e37a45d78719",
"WorkTypeParentId": "55fb20d8-2ab9-4aab-b150-1ffc5603f9b4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a576baee-398e-49dc-b619-36fee881e178",
"UPN": "a03c38d3-9ac1-417f-bfb5-b33c058a439a",
"PostDate": "2025-10-26T01:11:54.5454911+00:00",
"Comment": "sample string 4",
"CC": [
"fa61c90f-8c57-4583-9c1d-324b799fa30d",
"81a14919-9d60-4dfb-b583-13fdf4857fea"
],
"Users": [
"fe17d727-0420-4d20-92d6-fe3bb9680445",
"ba1d0587-f391-49e7-b529-d9bff5bfd484"
]
},
{
"Id": "a576baee-398e-49dc-b619-36fee881e178",
"UPN": "a03c38d3-9ac1-417f-bfb5-b33c058a439a",
"PostDate": "2025-10-26T01:11:54.5454911+00:00",
"Comment": "sample string 4",
"CC": [
"fa61c90f-8c57-4583-9c1d-324b799fa30d",
"81a14919-9d60-4dfb-b583-13fdf4857fea"
],
"Users": [
"fe17d727-0420-4d20-92d6-fe3bb9680445",
"ba1d0587-f391-49e7-b529-d9bff5bfd484"
]
}
],
"StartDate": "2025-10-26T01:11:54.5454911+00:00",
"DueDate": "2025-10-26T01:11:54.5454911+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"89d2c6a7-4875-4772-9015-645c408ad3c0": "c1dcf91a-79a8-47d7-9ee5-c701940c655b",
"487f454c-3b52-4387-a366-ec6af4a4e198": "b74db515-3dd3-4005-8358-922f1369a040"
},
"HasUpdates": true,
"Modified": "2025-10-26T01:11:54.5454911+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": "2025-10-26T01:11:54.5454911+00:00"
},
"LastComment": "2025-10-26T01:11:54.5454911+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d0d2ab82-7939-4c08-a14f-cacc3c0e9050",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "d3f855be-629f-4fca-8086-b334e0ebffd1",
"id": "45199cd8-1a46-4dfe-8fa9-58bbcdc6cb82",
"ConfigId": "9f63cf0d-a2da-407a-8722-661d0ebe2a9b"
}