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": "72e3beac-c62e-479b-a2c4-8b2816afa811",
"ParentTaskId": "e4302af6-95de-4307-b6ad-b23b9c584e51",
"Integration": {
"IntegrationId": "d06e8f97-6aba-4745-a7f2-0659685e864f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"64a2df67-3fdf-40b5-ade1-ee82fa4bb27d": 2.0,
"6a3a238c-311d-4a2e-9698-fcb00ebc5371": 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": "384d3a1a-3224-463c-9c39-93a2c1e5790a",
"Name": "sample string 1",
"Created": "2026-06-09T02:05:01.1300295+00:00",
"Modified": "2026-06-09T02:05:01.1300295+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"aa263ba2-2352-48ee-98f5-9ce65221499b",
"d9006207-4733-41a0-afb4-5037903e12a9"
],
"NonLaborAssignments": [
{
"Id": "ce3d84b8-8019-4be1-aa29-4f835dbfda03",
"ResourceId": "8f2e4de9-81eb-46b5-83c6-0843bffec0a5",
"Quantity": 3.0
},
{
"Id": "ce3d84b8-8019-4be1-aa29-4f835dbfda03",
"ResourceId": "8f2e4de9-81eb-46b5-83c6-0843bffec0a5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "fa1ff25c-051c-4339-842f-11bfef4b0300",
"Type": 0,
"ResourceId": "6b72123c-a66f-4970-b137-58796a3bfc54",
"Units": 3.0
},
{
"Id": "fa1ff25c-051c-4339-842f-11bfef4b0300",
"Type": 0,
"ResourceId": "6b72123c-a66f-4970-b137-58796a3bfc54",
"Units": 3.0
}
],
"ParentId": "41bb5f69-73ea-43d7-a6b1-66428013b600",
"WorkTypeParentId": "2bcc6625-53cc-48fc-8337-10f89468db5d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ee70b595-819a-4a32-9a51-32ca61055213",
"UPN": "af8cce03-95aa-46dd-8c83-eb70c43a0e6f",
"PostDate": "2026-06-09T02:05:01.1300295+00:00",
"Comment": "sample string 4",
"CC": [
"f7dab52f-e1c8-4e45-b3a8-e5c73ffe1376",
"850ee6ae-a46b-452d-b912-c658214cda99"
],
"Users": [
"34298d1b-5f84-4d69-90e1-f2d228933cc8",
"b9632cbd-ffc0-45f8-83d0-158a81b63921"
]
},
{
"Id": "ee70b595-819a-4a32-9a51-32ca61055213",
"UPN": "af8cce03-95aa-46dd-8c83-eb70c43a0e6f",
"PostDate": "2026-06-09T02:05:01.1300295+00:00",
"Comment": "sample string 4",
"CC": [
"f7dab52f-e1c8-4e45-b3a8-e5c73ffe1376",
"850ee6ae-a46b-452d-b912-c658214cda99"
],
"Users": [
"34298d1b-5f84-4d69-90e1-f2d228933cc8",
"b9632cbd-ffc0-45f8-83d0-158a81b63921"
]
}
],
"StartDate": "2026-06-09T02:05:01.1300295+00:00",
"DueDate": "2026-06-09T02:05:01.1300295+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4a1bbbe5-b0bb-4319-a7c9-8541310671db": "cf217fc6-710f-47cf-8ad8-841eea73c0e6",
"183f4ae5-2597-493b-89af-60b34d3c15cb": "cc25a490-f3e4-4460-b7b3-3b563241fa5e"
},
"HasUpdates": true,
"Modified": "2026-06-09T02:05:01.1300295+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-09T02:05:01.1300295+00:00"
},
"LastComment": "2026-06-09T02:05:01.1300295+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6e643e8c-d1d8-4fee-847a-5c1c0174cbf8",
"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": "284de13c-fe52-405c-96e4-2feee06849ef",
"id": "c45f8df7-adf0-4062-ad78-44aa298df49d",
"ConfigId": "7ca1c6fa-8b06-4a27-93a3-758fd4527ae0"
}