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": "3f8ba9a8-28f6-4deb-b17c-04aed6785966",
"ParentTaskId": "f962ec59-17be-44bf-9198-6bdf95a2dfba",
"Integration": {
"IntegrationId": "09cc7759-a11e-41bb-9150-3e453b446321",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"39c90e77-9602-4f5c-a0e5-765e63f5022d": 2.0,
"d7732b4a-df99-4d0b-9b02-95c95a90b85c": 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": "735447c6-b00d-4a32-b5df-0851515b16c9",
"Name": "sample string 1",
"Created": "2026-09-24T15:29:56.372691+00:00",
"Modified": "2026-09-24T15:29:56.372691+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"68dc3aba-b658-4f9c-9369-fa397e8870b3",
"db34cecb-cc6a-4fe2-826d-c211ff93af56"
],
"NonLaborAssignments": [
{
"Id": "4aae0d00-6e1a-47f6-9e9c-1564e34f914b",
"ResourceId": "2618f110-e754-4db7-a60b-b4247334dc39",
"Quantity": 3.0
},
{
"Id": "4aae0d00-6e1a-47f6-9e9c-1564e34f914b",
"ResourceId": "2618f110-e754-4db7-a60b-b4247334dc39",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f87ccaba-1cc9-48a7-a8f6-4d980d9010e7",
"Type": 0,
"ResourceId": "8aa87e14-7e0c-4053-b439-17ceb34d9d9c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "057acdd7-8a48-4dd9-b057-0be5fd5d4ada",
"Start": "2026-09-24T15:29:56.372691+00:00",
"Due": "2026-09-24T15:29:56.372691+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "057acdd7-8a48-4dd9-b057-0be5fd5d4ada",
"Start": "2026-09-24T15:29:56.372691+00:00",
"Due": "2026-09-24T15:29:56.372691+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "f87ccaba-1cc9-48a7-a8f6-4d980d9010e7",
"Type": 0,
"ResourceId": "8aa87e14-7e0c-4053-b439-17ceb34d9d9c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "057acdd7-8a48-4dd9-b057-0be5fd5d4ada",
"Start": "2026-09-24T15:29:56.372691+00:00",
"Due": "2026-09-24T15:29:56.372691+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "057acdd7-8a48-4dd9-b057-0be5fd5d4ada",
"Start": "2026-09-24T15:29:56.372691+00:00",
"Due": "2026-09-24T15:29:56.372691+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "71f0eabd-2f9c-46b4-94e7-9622d9eda2c1",
"WorkTypeParentId": "19def50b-5752-4fc5-bc24-bf8f3b1bef77",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "494740b9-2194-404c-8808-8060c7c0ce1e",
"UPN": "cb995dbf-4858-431d-88e8-3a94e5ad1759",
"PostDate": "2026-09-24T15:29:56.372691+00:00",
"Comment": "sample string 4",
"CC": [
"af2db609-4cd5-4d23-a0b8-38b0106eac2f",
"8c6e2c5a-402f-428f-b42d-1c93d0d21965"
],
"Users": [
"2e5c2bc7-50db-4abc-a1a6-624bfc71be9d",
"90944b12-0e28-4b34-8a24-79daf32a4daa"
]
},
{
"Id": "494740b9-2194-404c-8808-8060c7c0ce1e",
"UPN": "cb995dbf-4858-431d-88e8-3a94e5ad1759",
"PostDate": "2026-09-24T15:29:56.372691+00:00",
"Comment": "sample string 4",
"CC": [
"af2db609-4cd5-4d23-a0b8-38b0106eac2f",
"8c6e2c5a-402f-428f-b42d-1c93d0d21965"
],
"Users": [
"2e5c2bc7-50db-4abc-a1a6-624bfc71be9d",
"90944b12-0e28-4b34-8a24-79daf32a4daa"
]
}
],
"StartDate": "2026-09-24T15:29:56.372691+00:00",
"DueDate": "2026-09-24T15:29:56.372691+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0412b70a-663c-490e-a6a4-bf2dbee457e3": "1805bbf9-1cd8-448f-92d1-4db98ca64f63",
"4025b06f-be4c-4a99-a82f-284823018831": "7b5748a0-d217-45ac-9c78-d0aafa2a9f75"
},
"HasUpdates": true,
"Modified": "2026-09-24T15:29:56.372691+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-24T15:29:56.372691+00:00"
},
"LastComment": "2026-09-24T15:29:56.372691+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "30d2d7aa-117c-4eb0-ac05-67f0724143b4",
"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": "7c6d26c5-d12d-4607-8e5c-c2380fcf5dc1",
"id": "caaf1a82-b246-4408-b6af-86f6cad76713",
"ConfigId": "e00f19d9-dfe0-4010-8854-4106822ee455"
}