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": "6a755063-97b6-42a3-b237-8d30138860d9",
"ParentTaskId": "5c6b672e-8692-4509-af10-19935d1363eb",
"Integration": {
"IntegrationId": "65340713-ab4f-4513-a858-42adc9112656",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b8304f32-64e7-41ff-85fa-40ee6a64b041": 2.0,
"5c2c0093-332f-48e4-b81c-0a8ee6815b91": 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": "a9f19cdb-d2d9-4a2c-bd4c-1141ef56772d",
"Name": "sample string 1",
"Created": "2026-04-26T10:06:45.4625682+00:00",
"Modified": "2026-04-26T10:06:45.4625682+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e4af29be-2e1b-487d-9735-60a1104c6224",
"65b5b2a6-08c5-459a-8f1a-9a3808e4aacc"
],
"NonLaborAssignments": [
{
"Id": "eb382228-6f31-4701-90dd-9e9c3b4a303a",
"ResourceId": "0b31abd4-420a-4524-b556-cbe010d3a846",
"Quantity": 3.0
},
{
"Id": "eb382228-6f31-4701-90dd-9e9c3b4a303a",
"ResourceId": "0b31abd4-420a-4524-b556-cbe010d3a846",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5a3e0513-965b-460d-aa07-e4ab4c8cbf0d",
"Type": 0,
"ResourceId": "afde5d8f-f9b4-4ede-b2ef-915573a76135",
"Units": 3.0
},
{
"Id": "5a3e0513-965b-460d-aa07-e4ab4c8cbf0d",
"Type": 0,
"ResourceId": "afde5d8f-f9b4-4ede-b2ef-915573a76135",
"Units": 3.0
}
],
"ParentId": "38479a3a-41ed-4c81-a251-362cdbe37479",
"WorkTypeParentId": "e5eb9423-d8ea-46e0-8bac-42a518c4da3c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1ff49aa7-6d79-46bc-b24f-d6b371aef046",
"UPN": "f55f9dd0-1dbc-4883-8cee-df8bb5c5f8f1",
"PostDate": "2026-04-26T10:06:45.4625682+00:00",
"Comment": "sample string 4",
"CC": [
"b67a6e80-9316-48a0-9183-65c29070341e",
"815136a0-79b9-4e5d-b23a-ea5b4f492ce9"
],
"Users": [
"e8e909eb-263b-4201-b7ce-9c78f73bf834",
"0c9ea761-ef82-4717-a1ca-e38f2ae979aa"
]
},
{
"Id": "1ff49aa7-6d79-46bc-b24f-d6b371aef046",
"UPN": "f55f9dd0-1dbc-4883-8cee-df8bb5c5f8f1",
"PostDate": "2026-04-26T10:06:45.4625682+00:00",
"Comment": "sample string 4",
"CC": [
"b67a6e80-9316-48a0-9183-65c29070341e",
"815136a0-79b9-4e5d-b23a-ea5b4f492ce9"
],
"Users": [
"e8e909eb-263b-4201-b7ce-9c78f73bf834",
"0c9ea761-ef82-4717-a1ca-e38f2ae979aa"
]
}
],
"StartDate": "2026-04-26T10:06:45.4625682+00:00",
"DueDate": "2026-04-26T10:06:45.4625682+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d52e6879-d465-45a7-b939-3975a1e758fa": "78090f09-cdea-4c27-9bc1-90249cb4b7d4",
"78c74d97-4e32-42e9-a176-3658a8d149fe": "aa09c2fb-f912-440d-bce8-6a7bad7d4550"
},
"HasUpdates": true,
"Modified": "2026-04-26T10:06:45.4625682+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-04-26T10:06:45.4625682+00:00"
},
"LastComment": "2026-04-26T10:06:45.4625682+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4d40d9d8-c351-4249-af15-7d1438b2cd2f",
"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": "7234ef2c-be6a-45fa-80f8-1379f0c9310a",
"id": "5c68ca7f-a701-4384-b1b5-3315de5947e2",
"ConfigId": "a1e4aa30-4362-4fb7-bc26-fd128f0a8013"
}