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": "3cde682b-f4f3-4858-83c7-2b3caeb4cd4a",
"ParentTaskId": "bc9b8acf-4db9-4196-90ab-78c2f6285bad",
"Integration": {
"IntegrationId": "99b320a3-f7a0-4514-80c3-c34671bf5b27",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"546aba1e-8c2e-4697-8ce3-402eff1c00db": 2.0,
"d850710c-1f99-4927-b8a2-e7a00fa58593": 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": "7e31a69b-e859-48a0-83f7-5a8e3131b9bb",
"Name": "sample string 1",
"Created": "2026-07-08T15:08:42.8240615+00:00",
"Modified": "2026-07-08T15:08:42.8240615+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2fd262a2-99d2-4940-9d03-cebdf763b900",
"b00ff330-4f62-4138-8e29-7f87cd7440b5"
],
"NonLaborAssignments": [
{
"Id": "2acb04d7-21ce-4ad4-b677-e9ee27ae03ea",
"ResourceId": "1f8c606f-1455-4c61-bb41-a32cf935dd08",
"Quantity": 3.0
},
{
"Id": "2acb04d7-21ce-4ad4-b677-e9ee27ae03ea",
"ResourceId": "1f8c606f-1455-4c61-bb41-a32cf935dd08",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "edc63eda-202a-4bb5-af1c-b29f47183485",
"Type": 0,
"ResourceId": "70c2efad-f71e-4131-9758-e7bec3eec7b3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "edc63eda-202a-4bb5-af1c-b29f47183485",
"Type": 0,
"ResourceId": "70c2efad-f71e-4131-9758-e7bec3eec7b3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "6d9c1174-232a-42ea-be57-34b0be1f4bfa",
"WorkTypeParentId": "caf503d1-b03d-45cb-8362-173c54e30922",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3ab4a6ad-8800-49fc-9625-450987560dff",
"UPN": "330866a2-a32e-4ffa-9f9c-ccba1a1b50f2",
"PostDate": "2026-07-08T15:08:42.8240615+00:00",
"Comment": "sample string 4",
"CC": [
"bf719a89-c9c2-4fa4-af98-f92cdf590a79",
"b37761ee-086a-42b5-8083-99a99eb1cbf5"
],
"Users": [
"e385bc51-25e6-4866-ad59-9637a7bd7693",
"7442fa85-84c3-418f-856d-ebb227c1a097"
]
},
{
"Id": "3ab4a6ad-8800-49fc-9625-450987560dff",
"UPN": "330866a2-a32e-4ffa-9f9c-ccba1a1b50f2",
"PostDate": "2026-07-08T15:08:42.8240615+00:00",
"Comment": "sample string 4",
"CC": [
"bf719a89-c9c2-4fa4-af98-f92cdf590a79",
"b37761ee-086a-42b5-8083-99a99eb1cbf5"
],
"Users": [
"e385bc51-25e6-4866-ad59-9637a7bd7693",
"7442fa85-84c3-418f-856d-ebb227c1a097"
]
}
],
"StartDate": "2026-07-08T15:08:42.8240615+00:00",
"DueDate": "2026-07-08T15:08:42.8240615+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e36ecb00-097c-45c5-b6dd-76b1b0e5abab": "113ddad1-cb27-4d36-b36d-2d4c22c4fa6e",
"3ed52b04-e0a5-4163-a130-999337333e49": "6a81b2ad-f703-4f7e-8d1a-a955df0529cf"
},
"HasUpdates": true,
"Modified": "2026-07-08T15:08:42.8240615+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-08T15:08:42.8240615+00:00"
},
"LastComment": "2026-07-08T15:08:42.8240615+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4f39566c-8a4a-41c7-8b31-e280a1691bd3",
"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": "d005dafb-b972-4b6a-a2b3-7d3e7847b063",
"id": "8ea498a9-2aca-4994-9eaa-b01795a0c82e",
"ConfigId": "1b98cab1-d457-49d7-ba59-dbd3b732b7b1"
}