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": "8a8e98c4-c829-4a1d-bbd6-eda926dafe1f",
"ParentTaskId": "60a599a6-5a1e-41cf-a136-ce80dc8caf76",
"Integration": {
"IntegrationId": "e320b8f3-6058-4a0f-b783-40aecca1c391",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2bb61e69-7696-4c87-9426-62011ff52ee1": 2.0,
"56e15d41-c960-4127-bef9-57747dbe8877": 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": "52f5f6ea-e07c-4688-a005-25eb82436f7d",
"Name": "sample string 1",
"Created": "2026-10-19T09:55:17.3098+00:00",
"Modified": "2026-10-19T09:55:17.3098+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"614ebc70-616f-4833-a962-fee4a224c820",
"ae12273c-0510-451f-88c9-a3caad530e1f"
],
"NonLaborAssignments": [
{
"Id": "b559f09c-9d00-4c48-b0d6-0017d572c62d",
"ResourceId": "0b2556df-4e3d-4972-b194-7e484ceff363",
"Quantity": 3.0
},
{
"Id": "b559f09c-9d00-4c48-b0d6-0017d572c62d",
"ResourceId": "0b2556df-4e3d-4972-b194-7e484ceff363",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7ee6f773-eebb-4f5b-8e4a-4b68c7b155bc",
"Type": 0,
"ResourceId": "210812fc-77ba-46a4-aec1-bd63b220a2d3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9de4ac90-16e7-4605-8358-b9805edf03dd",
"Start": "2026-10-19T09:55:17.3098+00:00",
"Due": "2026-10-19T09:55:17.3098+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9de4ac90-16e7-4605-8358-b9805edf03dd",
"Start": "2026-10-19T09:55:17.3098+00:00",
"Due": "2026-10-19T09:55:17.3098+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7ee6f773-eebb-4f5b-8e4a-4b68c7b155bc",
"Type": 0,
"ResourceId": "210812fc-77ba-46a4-aec1-bd63b220a2d3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9de4ac90-16e7-4605-8358-b9805edf03dd",
"Start": "2026-10-19T09:55:17.3098+00:00",
"Due": "2026-10-19T09:55:17.3098+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9de4ac90-16e7-4605-8358-b9805edf03dd",
"Start": "2026-10-19T09:55:17.3098+00:00",
"Due": "2026-10-19T09:55:17.3098+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "bb5cc639-1878-4f06-ab89-60e5caf03d41",
"WorkTypeParentId": "97a34aa4-4e93-4571-9aad-ce4297b6be3c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9d878c18-4b46-4a58-bdf1-f75e399b905c",
"UPN": "94909941-3289-4a20-a90d-80dc15d1cf4b",
"PostDate": "2026-10-19T09:55:17.3098+00:00",
"Comment": "sample string 4",
"CC": [
"0b010308-0a8d-4b94-a2d0-5264af3c486b",
"b2523d8d-3588-433b-b80c-e318266b9830"
],
"Users": [
"ff9bd207-c55f-422b-b4b2-d7933734e5f1",
"954ac9d5-9d9d-4d97-b52a-e19281c711db"
]
},
{
"Id": "9d878c18-4b46-4a58-bdf1-f75e399b905c",
"UPN": "94909941-3289-4a20-a90d-80dc15d1cf4b",
"PostDate": "2026-10-19T09:55:17.3098+00:00",
"Comment": "sample string 4",
"CC": [
"0b010308-0a8d-4b94-a2d0-5264af3c486b",
"b2523d8d-3588-433b-b80c-e318266b9830"
],
"Users": [
"ff9bd207-c55f-422b-b4b2-d7933734e5f1",
"954ac9d5-9d9d-4d97-b52a-e19281c711db"
]
}
],
"StartDate": "2026-10-19T09:55:17.3098+00:00",
"DueDate": "2026-10-19T09:55:17.3098+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e3f5d64b-86dd-4ae1-89e6-c31989235561": "83a663e9-5fae-411c-8192-1ee41477f702",
"42218221-9b5a-4539-a2e1-5f168efc0db6": "9e563356-1665-4279-ab6d-6bd4e8518e95"
},
"HasUpdates": true,
"Modified": "2026-10-19T09:55:17.3098+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-19T09:55:17.3098+00:00"
},
"LastComment": "2026-10-19T09:55:17.3098+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "76f4028a-f14d-4fd1-a1c0-3b4425b56171",
"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": "891c1b72-8eb9-474e-8ad4-b7f66cda0494",
"id": "bf1ed415-9290-4058-97c6-6acb4ad6fbd4",
"ConfigId": "13338cfd-236b-46b9-bc12-ba8a29eebf50"
}