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": "687b30df-5a78-4624-97d4-44a1ba62a78c",
"ParentTaskId": "4bd7267d-5d8f-4a45-877a-85a6da141a24",
"Integration": {
"IntegrationId": "e551149c-69fc-4a1d-8b4b-9dd1b90f5a44",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"937acf42-6035-48d0-bad9-98cca837cdea": 2.0,
"b36ff419-7887-4870-9697-5697cac5e3b5": 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": "83ec9e0a-d259-47b6-b8c9-5d7693ff76df",
"Name": "sample string 1",
"Created": "2026-05-31T08:42:17.3771626+00:00",
"Modified": "2026-05-31T08:42:17.3771626+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3d3a9e10-cbb1-4e50-bcdb-3337035fc9d7",
"47f61a04-c86d-43c8-abe2-925a53177ad4"
],
"NonLaborAssignments": [
{
"Id": "5fbae38b-0fdc-4e08-b528-14addd42589c",
"ResourceId": "bdfdc25e-324e-430e-aec5-a3e6ef85e5f6",
"Quantity": 3.0
},
{
"Id": "5fbae38b-0fdc-4e08-b528-14addd42589c",
"ResourceId": "bdfdc25e-324e-430e-aec5-a3e6ef85e5f6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "feb9f237-5134-42c4-9b6d-dccd3ec147bf",
"Type": 0,
"ResourceId": "b99dbd2e-e517-4f69-9d58-c072ffd0e650",
"Units": 3.0
},
{
"Id": "feb9f237-5134-42c4-9b6d-dccd3ec147bf",
"Type": 0,
"ResourceId": "b99dbd2e-e517-4f69-9d58-c072ffd0e650",
"Units": 3.0
}
],
"ParentId": "a3a63092-be5c-486d-9972-dc05d2f83f1e",
"WorkTypeParentId": "2485e402-8424-48e7-ac94-b52c3d26a554",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cf1c2a2d-d4c8-4592-99a9-3b73c2ed1b67",
"UPN": "afe1b9e8-0aff-4a78-9ecf-1257757d1a1a",
"PostDate": "2026-05-31T08:42:17.3771626+00:00",
"Comment": "sample string 4",
"CC": [
"06d6b90c-5b0d-4cb9-b65f-14fcfb3f95e3",
"73b56239-74dd-4d94-858c-23936ba5fc2d"
],
"Users": [
"24dc81d5-d124-4ebe-8061-037d868b6543",
"0bd8bdc8-3f0e-4c52-9bbf-d81b9020c112"
]
},
{
"Id": "cf1c2a2d-d4c8-4592-99a9-3b73c2ed1b67",
"UPN": "afe1b9e8-0aff-4a78-9ecf-1257757d1a1a",
"PostDate": "2026-05-31T08:42:17.3771626+00:00",
"Comment": "sample string 4",
"CC": [
"06d6b90c-5b0d-4cb9-b65f-14fcfb3f95e3",
"73b56239-74dd-4d94-858c-23936ba5fc2d"
],
"Users": [
"24dc81d5-d124-4ebe-8061-037d868b6543",
"0bd8bdc8-3f0e-4c52-9bbf-d81b9020c112"
]
}
],
"StartDate": "2026-05-31T08:42:17.3771626+00:00",
"DueDate": "2026-05-31T08:42:17.3771626+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a35f4fcc-6dab-4653-8b0b-58b83a1683c2": "7dc74bb1-2600-4ff5-aac6-3493c14f81a9",
"8e309591-b5ff-4684-a2ab-15b341e5a833": "e4f10877-b66c-48b3-96ef-5ca12093b358"
},
"HasUpdates": true,
"Modified": "2026-05-31T08:42:17.3771626+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-05-31T08:42:17.3771626+00:00"
},
"LastComment": "2026-05-31T08:42:17.3771626+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0eca55b3-6b93-4c53-bd6e-825a6f4bcbc0",
"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": "a6e4ab78-2c86-40d1-9e5d-3daa3683dee4",
"id": "8b8e389c-d1cd-4281-bcda-e301cff670e2",
"ConfigId": "b60134e7-5413-4fec-8e7a-ba93412f9654"
}