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": "3e699a9c-97fc-4493-ac91-272b5f04c29f",
"ParentTaskId": "c467ae2c-fb37-45b1-b1c9-ff50650026b2",
"Integration": {
"IntegrationId": "5e754d71-bebc-46bf-b5cb-b0fb68377b4a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"6c0d58f4-f940-4755-a8a3-5820c1723a70": 2.0,
"e0260b13-0243-4c7a-a863-068b3b7bb075": 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": "cb912903-9401-42c8-9f76-f3e80f86df2e",
"Name": "sample string 1",
"Created": "2026-08-30T17:05:07.3333658+00:00",
"Modified": "2026-08-30T17:05:07.3333658+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bcceaf0c-47cd-45ec-bcae-19d5ec006b88",
"63f00c64-1d28-45bc-8539-63ff520fa5f2"
],
"NonLaborAssignments": [
{
"Id": "c61fbf54-1261-4ceb-b604-ee4619c7ae6e",
"ResourceId": "0f6553d0-3565-4cf4-9e10-111c3e4e9a8a",
"Quantity": 3.0
},
{
"Id": "c61fbf54-1261-4ceb-b604-ee4619c7ae6e",
"ResourceId": "0f6553d0-3565-4cf4-9e10-111c3e4e9a8a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "064287ac-7f53-402e-af46-91bd13ae217d",
"Type": 0,
"ResourceId": "ba0aa4ed-ed90-4239-b8c6-9d45663f26ce",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7262e910-8fe5-45c5-a287-1f4e2beb2ac6",
"Start": "2026-08-30T17:05:07.3333658+00:00",
"Due": "2026-08-30T17:05:07.3333658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7262e910-8fe5-45c5-a287-1f4e2beb2ac6",
"Start": "2026-08-30T17:05:07.3333658+00:00",
"Due": "2026-08-30T17:05:07.3333658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "064287ac-7f53-402e-af46-91bd13ae217d",
"Type": 0,
"ResourceId": "ba0aa4ed-ed90-4239-b8c6-9d45663f26ce",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7262e910-8fe5-45c5-a287-1f4e2beb2ac6",
"Start": "2026-08-30T17:05:07.3333658+00:00",
"Due": "2026-08-30T17:05:07.3333658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7262e910-8fe5-45c5-a287-1f4e2beb2ac6",
"Start": "2026-08-30T17:05:07.3333658+00:00",
"Due": "2026-08-30T17:05:07.3333658+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "45107e4b-9950-4c72-93ee-b323e5e5ca93",
"WorkTypeParentId": "5798ed0c-610e-436a-840c-ff5faddfd68a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "23a3cab0-5cf2-4cf9-8506-8957959e2900",
"UPN": "079c7670-f1d0-4386-820a-06fed9198196",
"PostDate": "2026-08-30T17:05:07.3333658+00:00",
"Comment": "sample string 4",
"CC": [
"c44f2e42-1e5d-4efc-99f9-6654739c8cdd",
"4e373586-8eb2-4c8d-b5b3-dec5796b4d17"
],
"Users": [
"46970d39-ccd7-4027-af1d-50d9abc828b6",
"972cfa99-ee82-4531-8d1e-93ad4259f0d0"
]
},
{
"Id": "23a3cab0-5cf2-4cf9-8506-8957959e2900",
"UPN": "079c7670-f1d0-4386-820a-06fed9198196",
"PostDate": "2026-08-30T17:05:07.3333658+00:00",
"Comment": "sample string 4",
"CC": [
"c44f2e42-1e5d-4efc-99f9-6654739c8cdd",
"4e373586-8eb2-4c8d-b5b3-dec5796b4d17"
],
"Users": [
"46970d39-ccd7-4027-af1d-50d9abc828b6",
"972cfa99-ee82-4531-8d1e-93ad4259f0d0"
]
}
],
"StartDate": "2026-08-30T17:05:07.3333658+00:00",
"DueDate": "2026-08-30T17:05:07.3333658+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"885e33d2-95cd-443e-9d6d-2355c7829fb4": "05666a79-be0a-4372-b329-a93c8781efbd",
"fd1f06a1-e336-4649-8309-5e4262ebc131": "1cc5ae97-4783-4927-9901-36ba6dd0aff3"
},
"HasUpdates": true,
"Modified": "2026-08-30T17:05:07.3333658+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-08-30T17:05:07.3333658+00:00"
},
"LastComment": "2026-08-30T17:05:07.3333658+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d34ccc00-c0a3-43b0-bcd9-118abe1cc61a",
"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": "2bfe13d4-b11e-4b2b-9801-5382e37c038e",
"id": "74f5e737-0547-4bfb-a446-e108a17de7f9",
"ConfigId": "61a34894-6766-4cec-b9a7-be8385084cad"
}