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": "770cb408-c2c1-4af0-bfa2-a97e2a022b82",
"ParentTaskId": "4ae64218-215d-4117-a7c9-369c09bb361c",
"Integration": {
"IntegrationId": "85fce0ea-12dd-4b9d-ab01-6af101ce291d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c9cd4b5f-6117-424e-a59f-c85f1632f987": 2.0,
"5ad0cb51-7334-4de7-8e45-654b366647ec": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "07add729-53a4-4d06-8c26-7554a9f0dbca",
"Name": "sample string 1",
"Created": "2026-01-27T04:36:36.9040579+00:00",
"Modified": "2026-01-27T04:36:36.9040579+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"805ad89b-3b39-496c-a0be-1f1d8dc80b64",
"e644fb22-9e26-4673-8f58-99b23dab19d0"
],
"NonLaborAssignments": [
{
"Id": "3de2437e-683b-4d53-8b20-7ba812cbc42c",
"ResourceId": "42760c0a-da50-4020-a459-58accd75f770",
"Quantity": 3.0
},
{
"Id": "3de2437e-683b-4d53-8b20-7ba812cbc42c",
"ResourceId": "42760c0a-da50-4020-a459-58accd75f770",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "aa8b1ebe-9d66-43a4-bad2-f3d323494c91",
"Type": 0,
"ResourceId": "28794555-4cbc-4d6e-95d1-cd0885124ff4",
"Units": 3.0
},
{
"Id": "aa8b1ebe-9d66-43a4-bad2-f3d323494c91",
"Type": 0,
"ResourceId": "28794555-4cbc-4d6e-95d1-cd0885124ff4",
"Units": 3.0
}
],
"ParentId": "6283ccec-17a2-466b-a599-42fc0c44f76a",
"WorkTypeParentId": "2197a87f-856b-43d4-9bb1-09b662410246",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "0702363e-4d74-4b10-a29f-fd3e9f6c6db0",
"UPN": "01113e7c-ecba-490e-9b0e-a0f0e5b2432a",
"PostDate": "2026-01-27T04:36:36.9040579+00:00",
"Comment": "sample string 4",
"CC": [
"22223f70-cf26-4f46-94cd-996c2ef41345",
"7c62228c-b892-49a6-87fc-3c63033346c4"
],
"Users": [
"cff2a0b2-20e3-47a2-8f66-cd22e6d90a40",
"e34d234d-0e8b-4c62-8179-d2fb5506a486"
]
},
{
"Id": "0702363e-4d74-4b10-a29f-fd3e9f6c6db0",
"UPN": "01113e7c-ecba-490e-9b0e-a0f0e5b2432a",
"PostDate": "2026-01-27T04:36:36.9040579+00:00",
"Comment": "sample string 4",
"CC": [
"22223f70-cf26-4f46-94cd-996c2ef41345",
"7c62228c-b892-49a6-87fc-3c63033346c4"
],
"Users": [
"cff2a0b2-20e3-47a2-8f66-cd22e6d90a40",
"e34d234d-0e8b-4c62-8179-d2fb5506a486"
]
}
],
"StartDate": "2026-01-27T04:36:36.9040579+00:00",
"DueDate": "2026-01-27T04:36:36.9040579+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"22e53b8f-fdef-4ecc-af47-d52079e6b501": "91ac41f3-a87f-49cf-9c2d-b90af7680d7a",
"ca12c35e-6258-4b29-9562-df65560f2e88": "3d2d6411-64b1-48bd-94ac-7f454097308d"
},
"HasUpdates": true,
"Modified": "2026-01-27T04:36:36.9040579+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-01-27T04:36:36.9040579+00:00"
},
"LastComment": "2026-01-27T04:36:36.9040579+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "683074bc-252d-4b31-89fc-00bd498e893f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "741989e7-3794-44c2-9822-4ea22399f66e",
"id": "ecfd52a2-d4fb-4850-8040-bd4d18df0e4e",
"ConfigId": "f80ea7ff-ed54-4c80-9267-2bb726945b9c"
}