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": "42e92bcc-e237-4f20-8ab3-1f630a246540",
"ParentTaskId": "7fd69100-29b4-4f3c-b06a-2f3fbb0e3149",
"Integration": {
"IntegrationId": "5bcc7954-18ff-4b4b-87e7-1be8df9fa560",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"bc168387-500a-447a-9148-e868211fda5b": 2.0,
"2a1c77a0-e6c2-4371-9354-9c0b8526e612": 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": "792172f3-9161-48f9-869a-c75925c2ed3d",
"Name": "sample string 1",
"Created": "2026-09-21T21:08:20.427326+00:00",
"Modified": "2026-09-21T21:08:20.427326+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3cb919d3-ac83-448e-8515-204b66a57dd1",
"f870ed0c-e745-48e9-9788-6fb1d4457d26"
],
"NonLaborAssignments": [
{
"Id": "760ce367-1cc5-4189-9877-48ae09839e71",
"ResourceId": "85354024-1687-4cd3-8378-06ae6b5f544c",
"Quantity": 3.0
},
{
"Id": "760ce367-1cc5-4189-9877-48ae09839e71",
"ResourceId": "85354024-1687-4cd3-8378-06ae6b5f544c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "57496636-3a01-4156-94eb-5cab70dc2702",
"Type": 0,
"ResourceId": "9f1688cc-837f-4077-9279-b5c5e3bcdea7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "23c2962e-344b-414c-b5ef-e7ba79e91baf",
"Start": "2026-09-21T21:08:20.427326+00:00",
"Due": "2026-09-21T21:08:20.427326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "23c2962e-344b-414c-b5ef-e7ba79e91baf",
"Start": "2026-09-21T21:08:20.427326+00:00",
"Due": "2026-09-21T21:08:20.427326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "57496636-3a01-4156-94eb-5cab70dc2702",
"Type": 0,
"ResourceId": "9f1688cc-837f-4077-9279-b5c5e3bcdea7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "23c2962e-344b-414c-b5ef-e7ba79e91baf",
"Start": "2026-09-21T21:08:20.427326+00:00",
"Due": "2026-09-21T21:08:20.427326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "23c2962e-344b-414c-b5ef-e7ba79e91baf",
"Start": "2026-09-21T21:08:20.427326+00:00",
"Due": "2026-09-21T21:08:20.427326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "97e64be8-1b61-4e0c-aee0-3ea2af5ef503",
"WorkTypeParentId": "a0d1ece7-1328-4b22-91f5-49ff84137315",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "fcfd2cb3-f743-4df8-83cf-c501321109ca",
"UPN": "3ca2ef41-34ed-4e67-8c58-0f1004b86ccc",
"PostDate": "2026-09-21T21:08:20.427326+00:00",
"Comment": "sample string 4",
"CC": [
"9b6956d2-e699-429c-ad77-c530eb82bc66",
"16850dea-b961-4be1-b33f-e148c5434ad9"
],
"Users": [
"3a7f6e0e-1181-40e7-b662-789518f2035c",
"8e421768-7544-4dfd-9ea8-855bb7932523"
]
},
{
"Id": "fcfd2cb3-f743-4df8-83cf-c501321109ca",
"UPN": "3ca2ef41-34ed-4e67-8c58-0f1004b86ccc",
"PostDate": "2026-09-21T21:08:20.427326+00:00",
"Comment": "sample string 4",
"CC": [
"9b6956d2-e699-429c-ad77-c530eb82bc66",
"16850dea-b961-4be1-b33f-e148c5434ad9"
],
"Users": [
"3a7f6e0e-1181-40e7-b662-789518f2035c",
"8e421768-7544-4dfd-9ea8-855bb7932523"
]
}
],
"StartDate": "2026-09-21T21:08:20.427326+00:00",
"DueDate": "2026-09-21T21:08:20.427326+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"db62b265-63df-4169-919c-54b315093e96": "01578323-92c3-4d09-97d8-c3f30e6cb8e8",
"75bcc74d-3fda-4b0d-9d20-eddff37b45b5": "9d15eced-20b8-4602-a3a2-74bd34eee177"
},
"HasUpdates": true,
"Modified": "2026-09-21T21:08:20.427326+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-21T21:08:20.427326+00:00"
},
"LastComment": "2026-09-21T21:08:20.427326+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3fd33e1b-ef2e-4967-839e-f8faacad0d9a",
"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": "a2323857-aad8-4f52-b4e8-6aa98b308447",
"id": "bd24ba5d-3191-495b-bce1-412b51f839a5",
"ConfigId": "6b4a3cc4-fbb9-4017-9ed9-1a249779866e"
}