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": "07e2b036-77f4-424c-af1c-434aca6d46ee",
"ParentTaskId": "ee336e88-9b10-4524-a7fd-f09cdf50a405",
"Integration": {
"IntegrationId": "2cc090b4-b7d2-4136-af51-b5cf1f995372",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3484cc36-6ea2-4b81-95e8-988437f73b98": 2.0,
"d856048b-680d-472f-a000-81c759dd5cc9": 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": "69040288-520a-4ad5-a9f4-d20f8ad243cb",
"Name": "sample string 1",
"Created": "2026-07-21T20:50:16.5895424+00:00",
"Modified": "2026-07-21T20:50:16.5895424+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d88d9845-1e9b-45ec-bc64-08a26ab8d7d9",
"5392fbba-27ec-4092-860a-91836316053b"
],
"NonLaborAssignments": [
{
"Id": "2d040f5a-daac-493e-a8ce-9958c1411154",
"ResourceId": "f0431a96-8af5-45ca-92fd-2bd165da279c",
"Quantity": 3.0
},
{
"Id": "2d040f5a-daac-493e-a8ce-9958c1411154",
"ResourceId": "f0431a96-8af5-45ca-92fd-2bd165da279c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ff93dfa9-1a05-4063-9fe4-8f24bebc31ad",
"Type": 0,
"ResourceId": "6532c0ad-747b-4de8-ba23-15f8a98c11e5",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "ff93dfa9-1a05-4063-9fe4-8f24bebc31ad",
"Type": 0,
"ResourceId": "6532c0ad-747b-4de8-ba23-15f8a98c11e5",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "c8e6d2d9-0a42-4fa9-987f-3cc40ffa11d2",
"WorkTypeParentId": "a5b3036b-a787-4630-a66b-2f60bb15d823",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "5181c9af-cbb1-4108-a247-49314d849f6a",
"UPN": "07cf769d-347f-474b-be7a-9ce6376a8607",
"PostDate": "2026-07-21T20:50:16.5895424+00:00",
"Comment": "sample string 4",
"CC": [
"85a1c526-9ee4-48c6-9bb9-40164ab4fdd0",
"c9b7a7b6-1102-411c-8c60-ca7fb3609c77"
],
"Users": [
"b0797081-d297-4ded-8f10-59ed5168fa9c",
"22f9f25f-7381-4932-b8c1-02a94ea201e9"
]
},
{
"Id": "5181c9af-cbb1-4108-a247-49314d849f6a",
"UPN": "07cf769d-347f-474b-be7a-9ce6376a8607",
"PostDate": "2026-07-21T20:50:16.5895424+00:00",
"Comment": "sample string 4",
"CC": [
"85a1c526-9ee4-48c6-9bb9-40164ab4fdd0",
"c9b7a7b6-1102-411c-8c60-ca7fb3609c77"
],
"Users": [
"b0797081-d297-4ded-8f10-59ed5168fa9c",
"22f9f25f-7381-4932-b8c1-02a94ea201e9"
]
}
],
"StartDate": "2026-07-21T20:50:16.5895424+00:00",
"DueDate": "2026-07-21T20:50:16.5895424+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1d7c1eca-98c1-4fd6-9699-4396c792e08b": "d1690a48-4764-413a-bf1b-e4e5380a9db6",
"49b71778-0273-4dc2-8a03-7b0e707d2a10": "86edcba6-2de5-455b-8f44-2015cafcd95d"
},
"HasUpdates": true,
"Modified": "2026-07-21T20:50:16.5895424+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-21T20:50:16.5895424+00:00"
},
"LastComment": "2026-07-21T20:50:16.5895424+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3ec33876-1521-4c17-9647-09ce02ff9731",
"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": "329448fd-d0cd-4096-a319-cde5a4fa9d84",
"id": "2d0c3092-c572-4891-9e88-486106c0862d",
"ConfigId": "97b813a2-167c-418a-956f-68abc00dfa78"
}