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": "b623f7da-caa9-40e2-8739-2fcef13f3353",
"ParentTaskId": "3369627a-e67c-47b7-95c2-5182d71d954a",
"Integration": {
"IntegrationId": "a5cdd801-7550-4270-a7f0-b1033cb388e9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"18848364-53e8-4f1a-af33-25767f65237f": 2.0,
"e1eef270-0fcd-4884-b4a6-7919d061e36e": 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": "50dfbc7d-819e-4085-b249-333f96df8363",
"Name": "sample string 1",
"Created": "2026-08-24T18:02:47.0615062+00:00",
"Modified": "2026-08-24T18:02:47.0615062+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"28334181-be43-49d2-92ee-557c75580544",
"7a604957-9413-49ef-bbd3-2cec68374ddb"
],
"NonLaborAssignments": [
{
"Id": "b99458fa-0959-4474-a463-d9ea6f5bf7b6",
"ResourceId": "a197409b-c137-4236-bdf4-a0e6fafcd8ca",
"Quantity": 3.0
},
{
"Id": "b99458fa-0959-4474-a463-d9ea6f5bf7b6",
"ResourceId": "a197409b-c137-4236-bdf4-a0e6fafcd8ca",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7b3b642d-3702-4a18-80a0-ba75228bf1f3",
"Type": 0,
"ResourceId": "637adea7-c5ca-4bff-878f-6a5da01fe76b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "7b3b642d-3702-4a18-80a0-ba75228bf1f3",
"Type": 0,
"ResourceId": "637adea7-c5ca-4bff-878f-6a5da01fe76b",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "c3339de9-020b-4a2a-bf40-f57d8c6bbf2a",
"WorkTypeParentId": "bf67d49b-b890-49f0-b4ee-2b3ae71d1b6b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "17b32780-9efe-4781-ac59-7dffa26a411f",
"UPN": "1fb388f6-b535-426c-be52-b9ce76fbf8ee",
"PostDate": "2026-08-24T18:02:47.0615062+00:00",
"Comment": "sample string 4",
"CC": [
"5cd63ff7-2893-4aa3-b117-8a5de15d4e18",
"080d53b6-f76d-4713-b5e5-659b84d9df91"
],
"Users": [
"64fe2f8e-31cc-4a9f-a04f-6905cc953f0d",
"5aa0c209-220e-4314-8872-5d138a421a3d"
]
},
{
"Id": "17b32780-9efe-4781-ac59-7dffa26a411f",
"UPN": "1fb388f6-b535-426c-be52-b9ce76fbf8ee",
"PostDate": "2026-08-24T18:02:47.0615062+00:00",
"Comment": "sample string 4",
"CC": [
"5cd63ff7-2893-4aa3-b117-8a5de15d4e18",
"080d53b6-f76d-4713-b5e5-659b84d9df91"
],
"Users": [
"64fe2f8e-31cc-4a9f-a04f-6905cc953f0d",
"5aa0c209-220e-4314-8872-5d138a421a3d"
]
}
],
"StartDate": "2026-08-24T18:02:47.0615062+00:00",
"DueDate": "2026-08-24T18:02:47.0615062+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"84e0a7a3-e817-4a1a-8750-b490f71c57cf": "b80e07bf-fce2-42a6-bcdf-ab756636fd91",
"69f5b3af-7b74-4a77-8f03-611703369b5a": "fe327a1e-1d91-4678-b954-d4623f8a7147"
},
"HasUpdates": true,
"Modified": "2026-08-24T18:02:47.0615062+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-08-24T18:02:47.0615062+00:00"
},
"LastComment": "2026-08-24T18:02:47.0615062+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d98cdc11-12fa-4b4d-aeb7-75a07b29f3ed",
"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": "9af9f47b-ddb4-4635-99ab-30144168bc1e",
"id": "921a098b-e01a-47ed-8ef6-7aca6ce6baa3",
"ConfigId": "491356d2-0db7-4209-a7c3-8d7b60c05ef8"
}