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": "38104b34-32a9-4f38-ad93-f6c1d24fcfb4",
"ParentTaskId": "d11cceb5-ffe4-439e-938a-95b3384dccc9",
"Integration": {
"IntegrationId": "340181ae-ef55-45a7-addf-2b0fd50dd4cc",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f0cb71a2-362d-43c4-adcc-764fae63e347": 2.0,
"2bb1cc33-60f8-4084-84e4-89df401d44be": 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": "05183538-ebef-4ff7-936c-c14c308ef0bf",
"Name": "sample string 1",
"Created": "2026-07-25T17:53:22.5269384+00:00",
"Modified": "2026-07-25T17:53:22.5269384+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1b8c5c00-f750-4bd3-96cd-ea858fbedabb",
"0d36d01c-ba09-4671-8edb-eca0da52196c"
],
"NonLaborAssignments": [
{
"Id": "63e972e1-a451-4bc0-bca6-9f70283782ad",
"ResourceId": "1ca12bea-4e1e-4c98-9e3d-fac2e9c34534",
"Quantity": 3.0
},
{
"Id": "63e972e1-a451-4bc0-bca6-9f70283782ad",
"ResourceId": "1ca12bea-4e1e-4c98-9e3d-fac2e9c34534",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bc9b5c28-4d58-477a-a7df-409ea397ee6c",
"Type": 0,
"ResourceId": "794d195c-1b14-4b6f-99a3-cac0f4ffcdb7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "bc9b5c28-4d58-477a-a7df-409ea397ee6c",
"Type": 0,
"ResourceId": "794d195c-1b14-4b6f-99a3-cac0f4ffcdb7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "7ffcd3cc-506c-4b01-af96-71b3980ac89a",
"WorkTypeParentId": "82087504-ddd4-4e4a-8961-fce94e588b83",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bb2911a7-8c6a-41e7-a83c-61ccd6d5629d",
"UPN": "fc9c6c6d-4063-40c9-86ef-1663fd55b924",
"PostDate": "2026-07-25T17:53:22.5269384+00:00",
"Comment": "sample string 4",
"CC": [
"1fa6b8a6-191e-4c29-a0be-77f2a133d306",
"29f3f181-5147-4eed-85f6-b4570649d8ab"
],
"Users": [
"5116e17e-71ea-4232-9ba7-1fc0f17d7409",
"3261222d-6eaf-4ac7-8724-35dd4030f809"
]
},
{
"Id": "bb2911a7-8c6a-41e7-a83c-61ccd6d5629d",
"UPN": "fc9c6c6d-4063-40c9-86ef-1663fd55b924",
"PostDate": "2026-07-25T17:53:22.5269384+00:00",
"Comment": "sample string 4",
"CC": [
"1fa6b8a6-191e-4c29-a0be-77f2a133d306",
"29f3f181-5147-4eed-85f6-b4570649d8ab"
],
"Users": [
"5116e17e-71ea-4232-9ba7-1fc0f17d7409",
"3261222d-6eaf-4ac7-8724-35dd4030f809"
]
}
],
"StartDate": "2026-07-25T17:53:22.5269384+00:00",
"DueDate": "2026-07-25T17:53:22.5269384+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d0d0ca24-672a-48c8-b829-e954360f7919": "29bed783-6d18-4bfb-8138-3f3425c0884c",
"c8010867-5776-4e7d-992e-ae71dac7ae93": "005a3563-1640-4e92-a46c-f152c1f229d7"
},
"HasUpdates": true,
"Modified": "2026-07-25T17:53:22.5269384+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-07-25T17:53:22.5269384+00:00"
},
"LastComment": "2026-07-25T17:53:22.5269384+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "31f4a950-5e33-455b-bb03-d3430d282cbf",
"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": "01393b74-8ef4-4976-88ae-410b560bc501",
"id": "3948bb7a-cd67-4b93-8f91-50642b53e959",
"ConfigId": "5ed8580e-efc2-412a-b7d6-505cbea57a5f"
}