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": "cc57061d-87cb-4085-9f8f-9a6761ca9256",
"ParentTaskId": "e733bcab-2fa9-47bb-bc4b-4d5f63990f66",
"Integration": {
"IntegrationId": "3a8a028e-c285-4e4a-b682-62fa368db821",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"29eb6b2e-99d7-4cc9-ad9d-0b7d91adcfd7": 2.0,
"2e55b64e-a341-4d06-9361-3c2d22a19152": 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": "1cb2940e-31ec-478d-b2d3-b145971b72d4",
"Name": "sample string 1",
"Created": "2026-07-26T13:43:45.2743385+00:00",
"Modified": "2026-07-26T13:43:45.2743385+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0703788f-63d7-4ec9-9057-306010c15fec",
"7f74c2a0-57c6-4ad9-b95c-9b05af6cef47"
],
"NonLaborAssignments": [
{
"Id": "071947ee-c2dd-4add-a62e-afc00c2f8654",
"ResourceId": "c224924f-231d-4ece-aa8e-026cebba64d7",
"Quantity": 3.0
},
{
"Id": "071947ee-c2dd-4add-a62e-afc00c2f8654",
"ResourceId": "c224924f-231d-4ece-aa8e-026cebba64d7",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a618b9c7-59e2-4333-ad6e-5323d290a13f",
"Type": 0,
"ResourceId": "2b141437-d612-4ea1-8a68-0727533fdfb8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "a618b9c7-59e2-4333-ad6e-5323d290a13f",
"Type": 0,
"ResourceId": "2b141437-d612-4ea1-8a68-0727533fdfb8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "28e94850-f7d6-4cf5-a480-6a3c6570ea31",
"WorkTypeParentId": "14569d5d-91cc-4c7c-8708-639ecc859ed9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "26bb9d64-2937-4444-b443-d8dee52c8ec8",
"UPN": "621076d4-c7d8-4c4b-99ad-f1347073d773",
"PostDate": "2026-07-26T13:43:45.2743385+00:00",
"Comment": "sample string 4",
"CC": [
"5157d332-ff9e-4a6b-8293-2aa945d6f193",
"e73782d4-b0cb-402b-a70e-db21cc84677e"
],
"Users": [
"11822ff9-3509-49fc-a93e-2ca74eb84ec1",
"c0651796-989a-40b7-9c89-46470d14c804"
]
},
{
"Id": "26bb9d64-2937-4444-b443-d8dee52c8ec8",
"UPN": "621076d4-c7d8-4c4b-99ad-f1347073d773",
"PostDate": "2026-07-26T13:43:45.2743385+00:00",
"Comment": "sample string 4",
"CC": [
"5157d332-ff9e-4a6b-8293-2aa945d6f193",
"e73782d4-b0cb-402b-a70e-db21cc84677e"
],
"Users": [
"11822ff9-3509-49fc-a93e-2ca74eb84ec1",
"c0651796-989a-40b7-9c89-46470d14c804"
]
}
],
"StartDate": "2026-07-26T13:43:45.2743385+00:00",
"DueDate": "2026-07-26T13:43:45.2743385+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a7c2bdbd-5343-452e-8122-a62dbef4eafe": "0f097d84-1314-482a-a205-a640c0139a8d",
"21cd0e6c-02cb-4977-8a5f-57e6200e928e": "b1c0b5b9-b2df-42c3-b215-9833c114182c"
},
"HasUpdates": true,
"Modified": "2026-07-26T13:43:45.2743385+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-07-26T13:43:45.2743385+00:00"
},
"LastComment": "2026-07-26T13:43:45.2743385+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d37680c0-e499-453d-a0cc-69beb3e7d080",
"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": "6fa61494-d13b-4125-85a6-3edf53a773e5",
"id": "55c19490-1fd1-4a60-b102-c0f8a6dd349a",
"ConfigId": "3be2ca1c-3a97-41f9-bd9a-efff02d6cf35"
}