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": "9e6a0c2e-d81e-4833-afca-d5ca73705a85",
"ParentTaskId": "5d3cf83d-2c0b-4b00-8ef0-e9e1d023696a",
"Integration": {
"IntegrationId": "43b66a33-87e2-42f2-aa3f-aa217e1c2fab",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2f72f788-5e39-4e53-9b1c-73e898afd08c": 2.0,
"caf89e57-7fa6-48cd-9aba-3b1d7b21d3b2": 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": "b5a015b0-1e7e-430e-8f88-b7add649abfa",
"Name": "sample string 1",
"Created": "2026-06-17T00:29:46.8986535+00:00",
"Modified": "2026-06-17T00:29:46.8986535+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1402dc0d-478e-4370-9e5a-f20efd759a23",
"a65624a4-8be2-4f42-b00b-f4548c87f298"
],
"NonLaborAssignments": [
{
"Id": "09c3e059-e1ea-4c6a-8cbb-28f6551f2903",
"ResourceId": "c6be656a-e054-4aa0-a75a-9184bde5d27f",
"Quantity": 3.0
},
{
"Id": "09c3e059-e1ea-4c6a-8cbb-28f6551f2903",
"ResourceId": "c6be656a-e054-4aa0-a75a-9184bde5d27f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4ca36bc6-22ca-40a8-b077-7ce99b531e00",
"Type": 0,
"ResourceId": "c76205de-001e-47ef-9ed9-83cfe2dd1bb8",
"Units": 3.0
},
{
"Id": "4ca36bc6-22ca-40a8-b077-7ce99b531e00",
"Type": 0,
"ResourceId": "c76205de-001e-47ef-9ed9-83cfe2dd1bb8",
"Units": 3.0
}
],
"ParentId": "e03e9e06-7d02-4c6f-b991-479487d1b580",
"WorkTypeParentId": "0db5e95f-21a7-446e-b3aa-954616e26de7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "971ece3b-1e1d-4162-8842-86394fd50750",
"UPN": "22c7c0af-308d-44ff-a169-3afaf67aff89",
"PostDate": "2026-06-17T00:29:46.8986535+00:00",
"Comment": "sample string 4",
"CC": [
"01a574df-619a-46e7-9e35-803d359accb4",
"809f2501-8f73-461e-ad32-3aae856901de"
],
"Users": [
"77718190-0d11-4712-84df-2572648079d4",
"d7b29cab-3e3a-456c-884e-1712e247fdaa"
]
},
{
"Id": "971ece3b-1e1d-4162-8842-86394fd50750",
"UPN": "22c7c0af-308d-44ff-a169-3afaf67aff89",
"PostDate": "2026-06-17T00:29:46.8986535+00:00",
"Comment": "sample string 4",
"CC": [
"01a574df-619a-46e7-9e35-803d359accb4",
"809f2501-8f73-461e-ad32-3aae856901de"
],
"Users": [
"77718190-0d11-4712-84df-2572648079d4",
"d7b29cab-3e3a-456c-884e-1712e247fdaa"
]
}
],
"StartDate": "2026-06-17T00:29:46.8986535+00:00",
"DueDate": "2026-06-17T00:29:46.8986535+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"11e52f84-2428-4981-989b-85d5440ca3bc": "a5aa5c1f-f0ed-4684-89f7-ca8dd7797f24",
"def97526-dc79-43b7-a65b-3ee5833d3a5a": "08106365-d50f-4190-a7e3-02da3477e9d5"
},
"HasUpdates": true,
"Modified": "2026-06-17T00:29:46.8986535+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-17T00:29:46.8986535+00:00"
},
"LastComment": "2026-06-17T00:29:46.8986535+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e62b5b1c-6463-486b-afe8-dd85407a7691",
"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": "dd94a560-4f72-4ac2-b288-a20cf2443e0b",
"id": "03a3c765-2bee-4527-9a49-1c9500e230c2",
"ConfigId": "c99a45d3-e264-4390-9a1e-f19871566216"
}