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": "6cb63404-8d33-450d-b78e-bf3cfe9410ca",
"ParentTaskId": "ecff33ca-0a15-4ae2-9722-7333533a70ba",
"Integration": {
"IntegrationId": "d88858bc-57b9-4782-be75-be6aa74b8a10",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2deefb47-26de-4568-b0db-02807a4ecb1e": 2.0,
"e66e59ad-cb41-4d7d-9ce6-ec59c773f19f": 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": "b4f85ee0-d742-4aed-b63d-0f59bddbf1ae",
"Name": "sample string 1",
"Created": "2026-08-21T12:18:48.7851594+00:00",
"Modified": "2026-08-21T12:18:48.7851594+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f39ac322-d2e2-4135-8279-826ca08d4e1a",
"089071f1-28fb-47e3-85f7-63a932957c5b"
],
"NonLaborAssignments": [
{
"Id": "9365fc09-4dc7-4bff-a7b2-c56ffd98d85b",
"ResourceId": "174865ed-4292-4ac8-948b-56d70e47b526",
"Quantity": 3.0
},
{
"Id": "9365fc09-4dc7-4bff-a7b2-c56ffd98d85b",
"ResourceId": "174865ed-4292-4ac8-948b-56d70e47b526",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e2669076-f4b9-47b7-8f3c-d5ec33416264",
"Type": 0,
"ResourceId": "143d16d0-592b-431d-bd50-29015ec3ef0d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "e2669076-f4b9-47b7-8f3c-d5ec33416264",
"Type": 0,
"ResourceId": "143d16d0-592b-431d-bd50-29015ec3ef0d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "70a33f4e-c1e5-40bb-a564-a9155e7a0467",
"WorkTypeParentId": "85cfa091-c06e-4267-ab74-d212e8489b6c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7004e2e6-b426-4657-b012-444d7773a5ee",
"UPN": "e4835e39-6634-48f4-9839-cc682701e2d5",
"PostDate": "2026-08-21T12:18:48.7851594+00:00",
"Comment": "sample string 4",
"CC": [
"d62b0af7-6f7c-4adf-8564-b95a5f11d3c9",
"8502797a-d465-4091-886b-1bd3078f368c"
],
"Users": [
"15c4bf81-39b2-457a-8100-c8b38a43c467",
"043a58ea-e409-4ddf-aed1-c27c321ec8b9"
]
},
{
"Id": "7004e2e6-b426-4657-b012-444d7773a5ee",
"UPN": "e4835e39-6634-48f4-9839-cc682701e2d5",
"PostDate": "2026-08-21T12:18:48.7851594+00:00",
"Comment": "sample string 4",
"CC": [
"d62b0af7-6f7c-4adf-8564-b95a5f11d3c9",
"8502797a-d465-4091-886b-1bd3078f368c"
],
"Users": [
"15c4bf81-39b2-457a-8100-c8b38a43c467",
"043a58ea-e409-4ddf-aed1-c27c321ec8b9"
]
}
],
"StartDate": "2026-08-21T12:18:48.7851594+00:00",
"DueDate": "2026-08-21T12:18:48.7851594+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"02cbb90f-2fc4-4284-975d-8f9268125e4d": "1fc8f396-e547-4384-9f42-d53cf461f2e2",
"59617c92-50cd-434d-8f8b-48f00d345ef3": "b2fb015c-e0f7-406a-b0bb-61e979d550ae"
},
"HasUpdates": true,
"Modified": "2026-08-21T12:18:48.7851594+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-08-21T12:18:48.7851594+00:00"
},
"LastComment": "2026-08-21T12:18:48.7851594+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2a147a97-079f-4c01-a9e6-2a76c6dd1e16",
"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": "4c9f9386-81be-412c-9a99-b566f146b4f0",
"id": "5f505a8a-c64f-4c2f-8902-dba9367f5533",
"ConfigId": "d9e4cde8-c1d3-4eb1-a2d6-153ea3cc0bef"
}