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": "98b6b944-5cc4-404f-a0ba-c056ef77e774",
"ParentTaskId": "a18e1ea3-0845-403b-9a83-7317f4b7a985",
"Integration": {
"IntegrationId": "d9faa8a6-3d17-4cc8-9809-dcd452467d06",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1b9cc475-8056-4dda-ad1d-5ea971012f47": 2.0,
"7d9f4c2f-a30c-4b55-82d5-4aa59cf06eb9": 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": "3932d7f7-3b06-4c52-aa71-fe329e61a031",
"Name": "sample string 1",
"Created": "2026-10-09T23:41:29.7341092+00:00",
"Modified": "2026-10-09T23:41:29.7341092+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"43ace021-78e3-4059-8f5d-52e9cbbeb67c",
"afcdf6b2-60d6-49de-94ff-c0079e16ad21"
],
"NonLaborAssignments": [
{
"Id": "2cae2069-5546-4878-a952-d8009bd53c13",
"ResourceId": "28f574c0-0076-438f-829c-b0f9f478c04f",
"Quantity": 3.0
},
{
"Id": "2cae2069-5546-4878-a952-d8009bd53c13",
"ResourceId": "28f574c0-0076-438f-829c-b0f9f478c04f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f237df7a-86ac-4f6d-8181-bd680f9a5fd4",
"Type": 0,
"ResourceId": "d9959f5a-70b9-4901-b65a-c12f5668ca0a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "ee658ca1-1210-4130-a96f-8749ca188dba",
"Start": "2026-10-09T23:41:29.7341092+00:00",
"Due": "2026-10-09T23:41:29.7341092+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "ee658ca1-1210-4130-a96f-8749ca188dba",
"Start": "2026-10-09T23:41:29.7341092+00:00",
"Due": "2026-10-09T23:41:29.7341092+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "f237df7a-86ac-4f6d-8181-bd680f9a5fd4",
"Type": 0,
"ResourceId": "d9959f5a-70b9-4901-b65a-c12f5668ca0a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "ee658ca1-1210-4130-a96f-8749ca188dba",
"Start": "2026-10-09T23:41:29.7341092+00:00",
"Due": "2026-10-09T23:41:29.7341092+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "ee658ca1-1210-4130-a96f-8749ca188dba",
"Start": "2026-10-09T23:41:29.7341092+00:00",
"Due": "2026-10-09T23:41:29.7341092+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "f9f255f7-28d7-44c0-97af-e75ef115ca5b",
"WorkTypeParentId": "7bce2527-d4b6-4220-a591-669e8db3e9ea",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8b69231e-e8be-4ba9-acc7-2670657b0057",
"UPN": "efffa116-7bee-4857-ae1e-c51dca140c1a",
"PostDate": "2026-10-09T23:41:29.7341092+00:00",
"Comment": "sample string 4",
"CC": [
"eecd0bbe-0f5e-451d-a9ba-6b363f86be60",
"f132585c-6b1c-44fa-9b68-fb63f7f8c49b"
],
"Users": [
"11146ee4-14a4-4b64-b28e-182043d070ce",
"72772a61-0ff4-4119-b0cf-a74fea1873c6"
]
},
{
"Id": "8b69231e-e8be-4ba9-acc7-2670657b0057",
"UPN": "efffa116-7bee-4857-ae1e-c51dca140c1a",
"PostDate": "2026-10-09T23:41:29.7341092+00:00",
"Comment": "sample string 4",
"CC": [
"eecd0bbe-0f5e-451d-a9ba-6b363f86be60",
"f132585c-6b1c-44fa-9b68-fb63f7f8c49b"
],
"Users": [
"11146ee4-14a4-4b64-b28e-182043d070ce",
"72772a61-0ff4-4119-b0cf-a74fea1873c6"
]
}
],
"StartDate": "2026-10-09T23:41:29.7341092+00:00",
"DueDate": "2026-10-09T23:41:29.7341092+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ca621f01-8862-4826-889a-dc007b3e7bd3": "09d401d5-dc15-4056-84bb-3fccf42ef0b8",
"56fb883b-2bb0-42f9-a443-cc588795daac": "20c48385-3ea3-47da-bc43-3761fa42285b"
},
"HasUpdates": true,
"Modified": "2026-10-09T23:41:29.7341092+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-09T23:41:29.7341092+00:00"
},
"LastComment": "2026-10-09T23:41:29.7341092+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5c0bbf79-4ab6-4e45-88ba-c6ca3d67c957",
"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": "b94b5de2-2cb1-4131-b75d-4ab08fb971b4",
"id": "b561a016-4b73-4c74-b05c-11c37aef85bc",
"ConfigId": "3a47b06c-7780-4e08-a860-4ecf72617c01"
}