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": "ac53d4f6-356f-4c6b-b867-cb855fc88ec0",
"ParentTaskId": "87b26389-324c-4455-b76c-ce4859f12079",
"Integration": {
"IntegrationId": "69349e82-7ce3-4758-9826-db6cbf921f07",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"aaf75215-dd9e-4870-9190-6807f7b360e3": 2.0,
"f015d887-1b8b-4eac-a2f1-0c74c22731d5": 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": "d9ca62cf-26df-4bd1-8ff4-f16c285210ed",
"Name": "sample string 1",
"Created": "2026-06-15T06:23:49.1112758+00:00",
"Modified": "2026-06-15T06:23:49.1112758+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"de2e1e2f-366f-4ac7-b70d-f93805b0ac47",
"01172bf9-b5c7-4b83-9114-76991563baab"
],
"NonLaborAssignments": [
{
"Id": "8d9af4db-9cd4-42c5-be4c-7e26e23106be",
"ResourceId": "64482742-b97e-4bad-b02a-b08834834884",
"Quantity": 3.0
},
{
"Id": "8d9af4db-9cd4-42c5-be4c-7e26e23106be",
"ResourceId": "64482742-b97e-4bad-b02a-b08834834884",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8203b508-535f-437e-ab3e-8c5cf09044f7",
"Type": 0,
"ResourceId": "fb2119f2-f2c3-4c1e-9afe-b80edae4eff1",
"Units": 3.0
},
{
"Id": "8203b508-535f-437e-ab3e-8c5cf09044f7",
"Type": 0,
"ResourceId": "fb2119f2-f2c3-4c1e-9afe-b80edae4eff1",
"Units": 3.0
}
],
"ParentId": "0afe41d7-845a-460f-bd66-81cb0d7f8e34",
"WorkTypeParentId": "f9b7d19a-8c4c-4906-9806-3594655855b6",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "139b2998-be48-4283-90e2-65ade951bdf2",
"UPN": "e51730e5-3a4e-47ca-a8b8-a9712f6abdc8",
"PostDate": "2026-06-15T06:23:49.1112758+00:00",
"Comment": "sample string 4",
"CC": [
"d757645e-8db7-46c3-90be-09592ef67d2d",
"09aefd59-3a0d-4965-a8d4-e462baf3de6c"
],
"Users": [
"14bb40d5-69d8-4703-956e-708c59725685",
"a33a602f-2872-47dd-948b-50d77444b906"
]
},
{
"Id": "139b2998-be48-4283-90e2-65ade951bdf2",
"UPN": "e51730e5-3a4e-47ca-a8b8-a9712f6abdc8",
"PostDate": "2026-06-15T06:23:49.1112758+00:00",
"Comment": "sample string 4",
"CC": [
"d757645e-8db7-46c3-90be-09592ef67d2d",
"09aefd59-3a0d-4965-a8d4-e462baf3de6c"
],
"Users": [
"14bb40d5-69d8-4703-956e-708c59725685",
"a33a602f-2872-47dd-948b-50d77444b906"
]
}
],
"StartDate": "2026-06-15T06:23:49.1112758+00:00",
"DueDate": "2026-06-15T06:23:49.1112758+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9604577a-576c-4ac1-af27-1a752a129dd7": "a4733a8a-50e9-4406-b387-77e38a1f3a89",
"29e25be3-a369-46c3-9534-534917d34b17": "8e25cc23-fccf-44f8-816f-6535dd9acf27"
},
"HasUpdates": true,
"Modified": "2026-06-15T06:23:49.1112758+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-15T06:23:49.1112758+00:00"
},
"LastComment": "2026-06-15T06:23:49.1112758+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "79ff7c4a-0674-40cc-817a-c34642246532",
"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": "3aef536d-8612-432d-b994-d942f0128a8d",
"id": "83068d1e-aab3-458b-9665-fcb15001ac7c",
"ConfigId": "02b6a932-b281-45d9-ac80-34fc5a326473"
}