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": "d13bcb2a-5bc9-4e78-9a83-07c16a312c82",
"ParentTaskId": "baa1a83e-b4be-4e65-8b00-1223989aa14f",
"Integration": {
"IntegrationId": "0e0417a2-8390-416a-9a40-983802b2facc",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4bfbe069-0b9a-429a-91f5-eb37e38cf597": 2.0,
"e21ea4a9-e626-4653-a256-4805725a799d": 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": "2186339a-a8b8-4b4b-aefa-3416eac0a878",
"Name": "sample string 1",
"Created": "2026-08-14T23:17:22.9466258+00:00",
"Modified": "2026-08-14T23:17:22.9466258+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b8da041e-de26-4890-a215-c5c4469dc075",
"94e45866-11aa-49b7-98a8-a03195ace513"
],
"NonLaborAssignments": [
{
"Id": "66ae6bde-4076-4888-bfc8-1c1bca19160d",
"ResourceId": "f9893c1e-44c2-4345-bb65-40d62e30c31c",
"Quantity": 3.0
},
{
"Id": "66ae6bde-4076-4888-bfc8-1c1bca19160d",
"ResourceId": "f9893c1e-44c2-4345-bb65-40d62e30c31c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "665d60f8-0286-4e31-99d9-b141d2cc9012",
"Type": 0,
"ResourceId": "de5e820c-e050-45d0-b356-67ec96eb286f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "665d60f8-0286-4e31-99d9-b141d2cc9012",
"Type": 0,
"ResourceId": "de5e820c-e050-45d0-b356-67ec96eb286f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "87c83d62-2965-4829-978d-e69c43ba76b3",
"WorkTypeParentId": "cc52db3d-78d4-4d9a-b218-a69f7e92a3b1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f2feee26-addf-4f57-a202-1fb350081a22",
"UPN": "14cdbc22-5796-4faa-b7ac-6309302a06a3",
"PostDate": "2026-08-14T23:17:22.9466258+00:00",
"Comment": "sample string 4",
"CC": [
"53ca22ff-ad79-4de6-8b59-f768e218cb58",
"331e0ce3-90ea-4b4a-a9c1-09eb3757e260"
],
"Users": [
"dff102a5-75c3-4b00-a08f-9a2056fbc0c4",
"da91dfcc-71a4-40a8-a48c-ba7a4044d6a2"
]
},
{
"Id": "f2feee26-addf-4f57-a202-1fb350081a22",
"UPN": "14cdbc22-5796-4faa-b7ac-6309302a06a3",
"PostDate": "2026-08-14T23:17:22.9466258+00:00",
"Comment": "sample string 4",
"CC": [
"53ca22ff-ad79-4de6-8b59-f768e218cb58",
"331e0ce3-90ea-4b4a-a9c1-09eb3757e260"
],
"Users": [
"dff102a5-75c3-4b00-a08f-9a2056fbc0c4",
"da91dfcc-71a4-40a8-a48c-ba7a4044d6a2"
]
}
],
"StartDate": "2026-08-14T23:17:22.9466258+00:00",
"DueDate": "2026-08-14T23:17:22.9466258+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a5822682-a84e-4cd2-990f-0081773ec66e": "457c6848-d0a3-475e-8df4-5d2eac2bebeb",
"fea92aad-308a-4927-b0d5-1339fd4b25ed": "7af86851-c803-4714-b224-36d5d4d03131"
},
"HasUpdates": true,
"Modified": "2026-08-14T23:17:22.9466258+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-14T23:17:22.9466258+00:00"
},
"LastComment": "2026-08-14T23:17:22.9466258+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "72e30f99-8351-4e32-9e21-ad6af92cfe0e",
"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": "56b601dd-7d8a-41ce-99c0-65b6e34f7db1",
"id": "d42414be-80d0-4dcf-90da-1d9f1dbaf018",
"ConfigId": "03cc9fee-0e4b-4df2-b03f-bce8c8bd461a"
}