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": "298f7690-eb49-4d55-8dc0-2eae8cf04f54",
"ParentTaskId": "0c9024dc-0e5e-4b98-b9e4-c027d2c2c86f",
"Integration": {
"IntegrationId": "69052087-e84a-4628-ba8b-5ccb14c5767f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7b012451-2a7f-4aac-b19d-6da4c34f14e3": 2.0,
"9ecc0c69-5185-4d31-8fc4-c50e9c97985f": 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": "e5e975e6-93f3-4546-a3bd-9b16eb675c46",
"Name": "sample string 1",
"Created": "2026-06-09T14:20:03.2023912+00:00",
"Modified": "2026-06-09T14:20:03.2023912+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"94ea9c97-617d-4f1b-a878-2891543cf6c0",
"474bb613-0cef-46ad-99f6-246d147c393e"
],
"NonLaborAssignments": [
{
"Id": "aa14eefb-aafd-4f53-a23b-edfb57516949",
"ResourceId": "e50c8771-abda-4534-a2bb-7b0628571a0d",
"Quantity": 3.0
},
{
"Id": "aa14eefb-aafd-4f53-a23b-edfb57516949",
"ResourceId": "e50c8771-abda-4534-a2bb-7b0628571a0d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "992d1415-07f8-45c5-881c-6e04d561dc72",
"Type": 0,
"ResourceId": "1aa543d1-5019-4361-ae50-4812ce8baf82",
"Units": 3.0
},
{
"Id": "992d1415-07f8-45c5-881c-6e04d561dc72",
"Type": 0,
"ResourceId": "1aa543d1-5019-4361-ae50-4812ce8baf82",
"Units": 3.0
}
],
"ParentId": "abc2cfe3-1883-4cc0-a17b-3167ae309bd0",
"WorkTypeParentId": "94f5c396-8fcd-4bbc-a7ac-e64b7abf1e3c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b775eb85-9d34-43b3-8db5-833076b15d02",
"UPN": "d83345ac-df4d-440b-b880-dd4630dea5c9",
"PostDate": "2026-06-09T14:20:03.2023912+00:00",
"Comment": "sample string 4",
"CC": [
"e8ac65df-d5d3-4d4b-8071-7000c4045548",
"fa256605-db62-4141-a0c7-dfd27521dab7"
],
"Users": [
"7e633109-b9c9-423e-af73-b72e083c254d",
"1e723c55-a20a-43fc-8740-de835197cb45"
]
},
{
"Id": "b775eb85-9d34-43b3-8db5-833076b15d02",
"UPN": "d83345ac-df4d-440b-b880-dd4630dea5c9",
"PostDate": "2026-06-09T14:20:03.2023912+00:00",
"Comment": "sample string 4",
"CC": [
"e8ac65df-d5d3-4d4b-8071-7000c4045548",
"fa256605-db62-4141-a0c7-dfd27521dab7"
],
"Users": [
"7e633109-b9c9-423e-af73-b72e083c254d",
"1e723c55-a20a-43fc-8740-de835197cb45"
]
}
],
"StartDate": "2026-06-09T14:20:03.2023912+00:00",
"DueDate": "2026-06-09T14:20:03.2023912+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"56b29179-4856-4241-a76f-95e61e9c76ca": "cbf55fce-bcd4-4ef7-ada0-3e39dec089ac",
"6fbef8d8-54d7-4b0d-97d0-10c45aa8bbc5": "5c264cf5-6cd9-435c-b09b-59e78b62b54a"
},
"HasUpdates": true,
"Modified": "2026-06-09T14:20:03.2023912+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-06-09T14:20:03.2023912+00:00"
},
"LastComment": "2026-06-09T14:20:03.2023912+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d4a582ba-f383-4bc1-be2e-c1939948ef47",
"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": "d0b99168-5d79-49f2-b36e-18ca586789a9",
"id": "4224ac7a-9e95-4f01-83ad-63b620e4ea1c",
"ConfigId": "0fc51ec7-a8cf-4f69-b499-bf0cf9aa2030"
}