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": "83986dc6-47a3-444a-b072-9af22a1f53f5",
"ParentTaskId": "42f00c92-59a0-40b5-8c22-798041ab746c",
"Integration": {
"IntegrationId": "a607284a-1669-40af-a7df-d81a9a2c17f0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0469011c-4958-4333-a988-9fe3ad01e8d5": 2.0,
"2bb455f0-051f-45e5-a7d7-e5b444f44783": 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": "22170155-e0a9-4719-b5a2-6e04c9899d28",
"Name": "sample string 1",
"Created": "2026-09-25T03:46:37.2816046+00:00",
"Modified": "2026-09-25T03:46:37.2816046+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"690e1ccd-c1c1-4619-a8ca-6ae6d5e1fd27",
"77de4493-ae73-43d4-98b5-cb469e2ddf02"
],
"NonLaborAssignments": [
{
"Id": "6e07634b-ebaf-494e-b06a-08bf83c3ed21",
"ResourceId": "f3453336-1703-405b-903a-650d432d76c4",
"Quantity": 3.0
},
{
"Id": "6e07634b-ebaf-494e-b06a-08bf83c3ed21",
"ResourceId": "f3453336-1703-405b-903a-650d432d76c4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "91a59b96-1796-47f8-8880-8af0b140d485",
"Type": 0,
"ResourceId": "bd666e6f-cce3-4b03-8e43-e01e7485877f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "72883188-50a4-466c-b837-c8577a9eb5bb",
"Start": "2026-09-25T03:46:37.2816046+00:00",
"Due": "2026-09-25T03:46:37.2816046+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "72883188-50a4-466c-b837-c8577a9eb5bb",
"Start": "2026-09-25T03:46:37.2816046+00:00",
"Due": "2026-09-25T03:46:37.2816046+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "91a59b96-1796-47f8-8880-8af0b140d485",
"Type": 0,
"ResourceId": "bd666e6f-cce3-4b03-8e43-e01e7485877f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "72883188-50a4-466c-b837-c8577a9eb5bb",
"Start": "2026-09-25T03:46:37.2816046+00:00",
"Due": "2026-09-25T03:46:37.2816046+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "72883188-50a4-466c-b837-c8577a9eb5bb",
"Start": "2026-09-25T03:46:37.2816046+00:00",
"Due": "2026-09-25T03:46:37.2816046+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "055adf2a-7942-4613-81a1-d9dec2e8e933",
"WorkTypeParentId": "9ba4fcaf-01f6-4d87-85da-88d44b264922",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3c6617d6-3ba8-4556-a2c9-2df8eeba8031",
"UPN": "c3ae08f9-e3ea-4e14-b2aa-6a3e36f7a813",
"PostDate": "2026-09-25T03:46:37.2816046+00:00",
"Comment": "sample string 4",
"CC": [
"b174bb6b-94cc-4ec5-9614-d55405446819",
"3fa73c85-100a-4d34-9a3a-4b0f4b2fab01"
],
"Users": [
"e200ad5f-5035-428d-b3ec-12f7c698638d",
"2c22813d-658d-4d8e-ac8d-d0f61b684fd3"
]
},
{
"Id": "3c6617d6-3ba8-4556-a2c9-2df8eeba8031",
"UPN": "c3ae08f9-e3ea-4e14-b2aa-6a3e36f7a813",
"PostDate": "2026-09-25T03:46:37.2816046+00:00",
"Comment": "sample string 4",
"CC": [
"b174bb6b-94cc-4ec5-9614-d55405446819",
"3fa73c85-100a-4d34-9a3a-4b0f4b2fab01"
],
"Users": [
"e200ad5f-5035-428d-b3ec-12f7c698638d",
"2c22813d-658d-4d8e-ac8d-d0f61b684fd3"
]
}
],
"StartDate": "2026-09-25T03:46:37.2816046+00:00",
"DueDate": "2026-09-25T03:46:37.2816046+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6d0f7c87-dab4-411b-8baf-999d6c92c055": "5cf1eb6a-99af-41b3-bc2f-4c734426180d",
"450a3811-d73b-48e3-a343-497c89d03ebd": "5773be21-4c8b-46d5-9dda-b7f6dc0266fa"
},
"HasUpdates": true,
"Modified": "2026-09-25T03:46:37.2816046+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-09-25T03:46:37.2816046+00:00"
},
"LastComment": "2026-09-25T03:46:37.2816046+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "06f87c62-619f-4701-bbe9-7011fa1fae3c",
"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": "ed1883fe-8070-4636-947d-34a60eb84efd",
"id": "2ad31010-51d3-4b44-a495-8cbcc80b3cc3",
"ConfigId": "9c3bed53-85cc-45a2-954e-731f3944b210"
}