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": "8bbaaa5d-051c-4e4b-b444-cd74e6465bae",
"ParentTaskId": "ec6e3f8b-a9c5-4a8a-8199-ec93dfb8e514",
"Integration": {
"IntegrationId": "2a55edcd-db86-48c5-8bd1-be8a6f2f2ecd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"68cbcacc-3b2a-4144-a77f-68e89ea786e5": 2.0,
"7238e762-4386-4631-8e57-a60714347baf": 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": "0e24c9b8-3cd6-4bc4-b788-463e5afde54b",
"Name": "sample string 1",
"Created": "2026-06-07T21:58:25.9653133+00:00",
"Modified": "2026-06-07T21:58:25.9653133+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c1a8d849-68f6-4f20-af36-969f58332194",
"16ca5668-6c5a-4e13-a1a7-97943f55ea61"
],
"NonLaborAssignments": [
{
"Id": "4e7f2eb5-138b-4371-846f-915c3a73b671",
"ResourceId": "6b1cf65e-893c-4804-8400-0044bca1fd9e",
"Quantity": 3.0
},
{
"Id": "4e7f2eb5-138b-4371-846f-915c3a73b671",
"ResourceId": "6b1cf65e-893c-4804-8400-0044bca1fd9e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "29f2eaa2-adb0-4c73-8c17-6916c437f179",
"Type": 0,
"ResourceId": "31c5129c-95bc-4ac4-8e2e-9fc893cd88de",
"Units": 3.0
},
{
"Id": "29f2eaa2-adb0-4c73-8c17-6916c437f179",
"Type": 0,
"ResourceId": "31c5129c-95bc-4ac4-8e2e-9fc893cd88de",
"Units": 3.0
}
],
"ParentId": "be1637ab-2517-4cdf-b993-d8af4b0aefc2",
"WorkTypeParentId": "5cb27845-12e7-4372-8248-0f7b784ba6aa",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3d16eb10-dddb-4b39-88cb-a768e4cce22f",
"UPN": "ab1e326a-5691-411b-a372-464e7b29de65",
"PostDate": "2026-06-07T21:58:25.9653133+00:00",
"Comment": "sample string 4",
"CC": [
"59a30159-2a0a-4c17-8797-d0ff756d6d89",
"553cf11c-7c93-4e0a-8755-b954e8048cf1"
],
"Users": [
"76396567-34f3-41db-8470-8fc4ab5dd16b",
"8ac5975e-26d0-49d2-b532-41bbe255c596"
]
},
{
"Id": "3d16eb10-dddb-4b39-88cb-a768e4cce22f",
"UPN": "ab1e326a-5691-411b-a372-464e7b29de65",
"PostDate": "2026-06-07T21:58:25.9653133+00:00",
"Comment": "sample string 4",
"CC": [
"59a30159-2a0a-4c17-8797-d0ff756d6d89",
"553cf11c-7c93-4e0a-8755-b954e8048cf1"
],
"Users": [
"76396567-34f3-41db-8470-8fc4ab5dd16b",
"8ac5975e-26d0-49d2-b532-41bbe255c596"
]
}
],
"StartDate": "2026-06-07T21:58:25.9653133+00:00",
"DueDate": "2026-06-07T21:58:25.9653133+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"77166197-e80e-43f3-a5b0-e73bd3508466": "08c504ec-95ed-4997-b5ce-aa1832ea2c8a",
"85e25672-7064-43b4-83f0-8233ef9057bd": "c0b767d8-64b6-4ec5-908f-486b7ad28110"
},
"HasUpdates": true,
"Modified": "2026-06-07T21:58:25.9653133+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-07T21:58:25.9653133+00:00"
},
"LastComment": "2026-06-07T21:58:25.9653133+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "74ad0eee-64dd-4359-b0bd-b910ff537a6a",
"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": "6e290154-422a-4694-bbe8-5896a19cd400",
"id": "0d59341a-f324-4673-b613-e8191595f15c",
"ConfigId": "841af7d5-519b-4caa-98a3-48d1b84ceb90"
}