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": "bc16e767-25cf-499d-9fbf-fea7278cc4be",
"ParentTaskId": "d7b6f75a-2032-4cc4-9b84-f69a0a9abbbd",
"Integration": {
"IntegrationId": "5de49b3c-211c-49aa-bcc3-897479799928",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1b42201f-d98f-4a26-8569-c2ba319cb5b5": 2.0,
"b8000edc-12ac-4b9e-ad0b-9898c841b969": 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": "c5b682e3-df02-454d-8abe-b37ed9e62685",
"Name": "sample string 1",
"Created": "2026-10-28T18:33:04.7536438+00:00",
"Modified": "2026-10-28T18:33:04.7536438+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"42c4c65a-5558-4a22-93e5-8e5fde03ee50",
"6a913f8c-06cb-4ae4-a6d0-ec6e2c3bd0a9"
],
"NonLaborAssignments": [
{
"Id": "c7c229bd-63cc-488d-908a-096a6072fbfa",
"ResourceId": "830e87f7-cf02-4105-9aa9-36cb930247a4",
"Quantity": 3.0
},
{
"Id": "c7c229bd-63cc-488d-908a-096a6072fbfa",
"ResourceId": "830e87f7-cf02-4105-9aa9-36cb930247a4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "09b958ca-7769-4516-aeab-3d3aabca5b14",
"Type": 0,
"ResourceId": "4d665f47-b4c6-49ed-bb60-1f37f8ff9b87",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2449afd9-bd67-4a69-b535-a09224b4062c",
"Start": "2026-10-28T18:33:04.7536438+00:00",
"Due": "2026-10-28T18:33:04.7536438+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2449afd9-bd67-4a69-b535-a09224b4062c",
"Start": "2026-10-28T18:33:04.7536438+00:00",
"Due": "2026-10-28T18:33:04.7536438+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "09b958ca-7769-4516-aeab-3d3aabca5b14",
"Type": 0,
"ResourceId": "4d665f47-b4c6-49ed-bb60-1f37f8ff9b87",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2449afd9-bd67-4a69-b535-a09224b4062c",
"Start": "2026-10-28T18:33:04.7536438+00:00",
"Due": "2026-10-28T18:33:04.7536438+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2449afd9-bd67-4a69-b535-a09224b4062c",
"Start": "2026-10-28T18:33:04.7536438+00:00",
"Due": "2026-10-28T18:33:04.7536438+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "724a148d-5944-4371-ab43-dcec9aaa3ddc",
"WorkTypeParentId": "550b8985-e830-454d-bc55-7edba0fda36c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cb338bf4-44e8-4be9-9ae1-c130f7667279",
"UPN": "81b2cd44-bd82-4d2b-9ee4-fd2b36e41052",
"PostDate": "2026-10-28T18:33:04.7536438+00:00",
"Comment": "sample string 4",
"CC": [
"3e3fee79-2a43-4788-ab53-f6e58e065726",
"3e4cb053-141e-4d2c-a3a6-0c42ac2dc3a7"
],
"Users": [
"1079bf87-216f-4ed2-966d-aeb7d82f462c",
"18ec7992-1412-4b78-8e2f-4e2f4ed874c2"
]
},
{
"Id": "cb338bf4-44e8-4be9-9ae1-c130f7667279",
"UPN": "81b2cd44-bd82-4d2b-9ee4-fd2b36e41052",
"PostDate": "2026-10-28T18:33:04.7536438+00:00",
"Comment": "sample string 4",
"CC": [
"3e3fee79-2a43-4788-ab53-f6e58e065726",
"3e4cb053-141e-4d2c-a3a6-0c42ac2dc3a7"
],
"Users": [
"1079bf87-216f-4ed2-966d-aeb7d82f462c",
"18ec7992-1412-4b78-8e2f-4e2f4ed874c2"
]
}
],
"StartDate": "2026-10-28T18:33:04.7536438+00:00",
"DueDate": "2026-10-28T18:33:04.7536438+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4a02c5b4-4617-4afc-91b9-0087fb7b92f0": "0dc19c8b-1dfc-4e98-bf2b-beef8423e08d",
"1557d414-c6db-472c-b909-2f20dd5e7c5e": "21128b57-f3b5-4756-9b8f-dac30f45b41c"
},
"HasUpdates": true,
"Modified": "2026-10-28T18:33:04.7536438+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-28T18:33:04.7536438+00:00"
},
"LastComment": "2026-10-28T18:33:04.7536438+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a1e82250-5f9d-477a-a76a-b12165060c61",
"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": "148c8a0f-8e75-4b0e-9c09-1ddbb29ee2ef",
"id": "d3026e72-b0cb-4ed3-9256-af48734d2205",
"ConfigId": "9b8a58a4-54c7-4ae1-bf22-38a2c0bcedb8"
}