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": "672d339d-b3db-4230-bdd1-29d1ec6913e6",
"ParentTaskId": "131a2d59-3160-4cfb-86a2-798fb934c648",
"Integration": {
"IntegrationId": "b2d6ef34-8f25-494d-8b9a-900f6e66422a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f2f5900f-8351-4b05-bae5-88d5c91f6c16": 2.0,
"cdac5183-254f-4e35-9da1-f0935604083c": 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": "40e0ebaa-a8bd-424a-99f5-975159ae7d93",
"Name": "sample string 1",
"Created": "2026-10-02T22:52:26.4161992+00:00",
"Modified": "2026-10-02T22:52:26.4161992+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b6670698-7bfc-4d61-bd86-0eb0d79cde36",
"20bdd14a-dce9-4c68-9268-18cd6736ec85"
],
"NonLaborAssignments": [
{
"Id": "a71e5b12-8495-42e3-8740-4965a529bc19",
"ResourceId": "d012bbc0-d2ad-4f82-815d-45afa390dd7d",
"Quantity": 3.0
},
{
"Id": "a71e5b12-8495-42e3-8740-4965a529bc19",
"ResourceId": "d012bbc0-d2ad-4f82-815d-45afa390dd7d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b7392222-c053-4bf9-b379-aa5bec3b6746",
"Type": 0,
"ResourceId": "bb015a67-0a43-4f2a-a8a3-789400a769e6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "735e8c24-a594-485f-89ab-fd9b6ccfd468",
"Start": "2026-10-02T22:52:26.4161992+00:00",
"Due": "2026-10-02T22:52:26.4161992+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "735e8c24-a594-485f-89ab-fd9b6ccfd468",
"Start": "2026-10-02T22:52:26.4161992+00:00",
"Due": "2026-10-02T22:52:26.4161992+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "b7392222-c053-4bf9-b379-aa5bec3b6746",
"Type": 0,
"ResourceId": "bb015a67-0a43-4f2a-a8a3-789400a769e6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "735e8c24-a594-485f-89ab-fd9b6ccfd468",
"Start": "2026-10-02T22:52:26.4161992+00:00",
"Due": "2026-10-02T22:52:26.4161992+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "735e8c24-a594-485f-89ab-fd9b6ccfd468",
"Start": "2026-10-02T22:52:26.4161992+00:00",
"Due": "2026-10-02T22:52:26.4161992+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c0811323-6ea4-478b-a75a-5f96a7b03976",
"WorkTypeParentId": "bb8359aa-11ec-49be-9758-d3b7ca6b84e8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "dfefa369-408c-447e-aa78-67855fba0aa0",
"UPN": "22f99c99-b74f-4eba-89b1-ddf369c1ff4f",
"PostDate": "2026-10-02T22:52:26.4161992+00:00",
"Comment": "sample string 4",
"CC": [
"19c28c11-896e-4799-8a80-3f940c653cc8",
"327bf0d7-3b47-42a6-a515-33c80df5c463"
],
"Users": [
"795db865-4add-4c1f-b456-20240e237c5e",
"93d8ad68-50cf-4471-95df-c182b9c72f74"
]
},
{
"Id": "dfefa369-408c-447e-aa78-67855fba0aa0",
"UPN": "22f99c99-b74f-4eba-89b1-ddf369c1ff4f",
"PostDate": "2026-10-02T22:52:26.4161992+00:00",
"Comment": "sample string 4",
"CC": [
"19c28c11-896e-4799-8a80-3f940c653cc8",
"327bf0d7-3b47-42a6-a515-33c80df5c463"
],
"Users": [
"795db865-4add-4c1f-b456-20240e237c5e",
"93d8ad68-50cf-4471-95df-c182b9c72f74"
]
}
],
"StartDate": "2026-10-02T22:52:26.4161992+00:00",
"DueDate": "2026-10-02T22:52:26.4161992+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"75e5947b-c0ed-435d-ad66-6ec147c9db18": "e8f12254-85e8-4338-8d57-be41dd7f7a83",
"8f2240d7-66d0-48c7-808d-f3847e6e97fa": "34dd5fd1-2eb5-49f4-87e4-1afdffe1ee28"
},
"HasUpdates": true,
"Modified": "2026-10-02T22:52:26.4161992+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-10-02T22:52:26.4161992+00:00"
},
"LastComment": "2026-10-02T22:52:26.4161992+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e14b22ee-d069-4db2-a47e-497ee543b7ac",
"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": "08ccf0bf-a620-4b1c-b0dc-66ae28414efe",
"id": "489ae9de-5a23-42a5-b118-790e42e9b969",
"ConfigId": "3b2f2a92-3912-49cb-8279-4ba7e214cde6"
}