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": "e25be96c-956d-4760-91c6-176281fb5fdd",
"ParentTaskId": "6e538a33-e609-4df7-9319-ae0e3235410a",
"Integration": {
"IntegrationId": "c7ae013a-2f77-4477-bad1-efdb34df8a65",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"823fe031-ea66-40e8-bb5d-9ef0e5761a26": 2.0,
"b3d8e038-572d-4a60-82c7-062d0008374f": 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": "7f9a4687-46b5-4fa4-89cc-6135932252df",
"Name": "sample string 1",
"Created": "2026-06-21T23:10:56.1557817+00:00",
"Modified": "2026-06-21T23:10:56.1557817+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"988ba288-dcbd-496e-be92-a9b67c8a7bdf",
"d9e8325c-0901-4b3f-8387-69f3fbf5774b"
],
"NonLaborAssignments": [
{
"Id": "c7d5b153-5067-432a-a581-4776d5656375",
"ResourceId": "7da6dc7f-a42b-4dce-a6cd-448d28ae34fd",
"Quantity": 3.0
},
{
"Id": "c7d5b153-5067-432a-a581-4776d5656375",
"ResourceId": "7da6dc7f-a42b-4dce-a6cd-448d28ae34fd",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "45ec6055-e6cc-4445-be1f-e58891bd48fc",
"Type": 0,
"ResourceId": "74e039a9-86b2-41c7-9207-508e11e2a15f",
"Units": 3.0
},
{
"Id": "45ec6055-e6cc-4445-be1f-e58891bd48fc",
"Type": 0,
"ResourceId": "74e039a9-86b2-41c7-9207-508e11e2a15f",
"Units": 3.0
}
],
"ParentId": "c764dad0-3941-4920-9894-503f6fa582b7",
"WorkTypeParentId": "385604dc-e572-4c26-8a93-102321a729e3",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2b5cd564-e2fa-43b9-9ec7-c7515fa0f6b3",
"UPN": "91394cbf-1133-4334-9140-f43329ba4e59",
"PostDate": "2026-06-21T23:10:56.1557817+00:00",
"Comment": "sample string 4",
"CC": [
"f6397b00-f27f-4e65-b746-e59ee1e48ff1",
"457c7fc5-2c51-4ec9-88c4-b8d5b6b32b53"
],
"Users": [
"31e6b347-90e7-490b-8dcd-d668f299856d",
"4c401cf8-c362-4b98-b950-857a08418c3e"
]
},
{
"Id": "2b5cd564-e2fa-43b9-9ec7-c7515fa0f6b3",
"UPN": "91394cbf-1133-4334-9140-f43329ba4e59",
"PostDate": "2026-06-21T23:10:56.1557817+00:00",
"Comment": "sample string 4",
"CC": [
"f6397b00-f27f-4e65-b746-e59ee1e48ff1",
"457c7fc5-2c51-4ec9-88c4-b8d5b6b32b53"
],
"Users": [
"31e6b347-90e7-490b-8dcd-d668f299856d",
"4c401cf8-c362-4b98-b950-857a08418c3e"
]
}
],
"StartDate": "2026-06-21T23:10:56.1557817+00:00",
"DueDate": "2026-06-21T23:10:56.1557817+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"c154a64b-3b1b-40d4-bcb4-5f3f85283f7b": "99249b37-6801-4520-813d-f25c428564cb",
"41d0bd08-c57c-481b-8701-f880b030a2de": "b5d66703-4b86-4472-a1f8-179b72d321bb"
},
"HasUpdates": true,
"Modified": "2026-06-21T23:10:56.1557817+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-21T23:10:56.1557817+00:00"
},
"LastComment": "2026-06-21T23:10:56.1557817+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1a0f151e-a916-4826-8256-c0f488d0fc18",
"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": "5b6a4cb7-0f53-439c-9e41-7c7db7f9df85",
"id": "3f768df1-d825-4473-b7ea-41f3df410a29",
"ConfigId": "bbcdb5ff-d149-4f86-ad5b-f3eb4b4b4aeb"
}