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": "bc7fef7b-bfba-431c-98a5-1731ca3f74f0",
"ParentTaskId": "6ed9c4d2-f995-4b07-a8b2-d8a5c3751130",
"Integration": {
"IntegrationId": "7a9fa96f-94e0-44e7-9673-962a37cf57aa",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"df12936c-81f3-4415-98d1-d617c8f25217": 2.0,
"a34a7fc1-0c11-4924-abf6-9e86bdc78945": 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": "d578ec0d-641a-4e4c-8b45-a52d06e55449",
"Name": "sample string 1",
"Created": "2026-06-12T15:52:27.9956272+00:00",
"Modified": "2026-06-12T15:52:27.9956272+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7c23d6ad-c6ec-42f6-a14a-e10716cca07f",
"527d3923-3a73-473a-8651-c5a7b4be5f88"
],
"NonLaborAssignments": [
{
"Id": "176dcbd8-2f08-4735-be4d-304d205d4183",
"ResourceId": "1c68449a-a6b8-4649-9587-da19b0175fde",
"Quantity": 3.0
},
{
"Id": "176dcbd8-2f08-4735-be4d-304d205d4183",
"ResourceId": "1c68449a-a6b8-4649-9587-da19b0175fde",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "44a46e0b-7c2b-44f6-88be-0e7be3ce47f6",
"Type": 0,
"ResourceId": "0c51e06c-f3b7-41fb-a99a-bdd79389b1f3",
"Units": 3.0
},
{
"Id": "44a46e0b-7c2b-44f6-88be-0e7be3ce47f6",
"Type": 0,
"ResourceId": "0c51e06c-f3b7-41fb-a99a-bdd79389b1f3",
"Units": 3.0
}
],
"ParentId": "f92a1493-055f-490b-a24d-def3767d9078",
"WorkTypeParentId": "bb922e98-6821-4424-8d73-fdb10e6276d7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "73923de7-5598-48c2-8ffa-7f34d3eb9a5d",
"UPN": "d9f905da-3507-496a-bb6b-b7f19cb4e584",
"PostDate": "2026-06-12T15:52:27.9956272+00:00",
"Comment": "sample string 4",
"CC": [
"2ac7d11b-277d-4d31-bfbd-db152ab2762f",
"271ec0cb-3444-42b7-8e13-f99d4e1f97ae"
],
"Users": [
"8fc83af7-598b-4bf4-b5f2-ef9bc4ef06fc",
"03b96958-8e67-4fdf-be60-083c7a7deca6"
]
},
{
"Id": "73923de7-5598-48c2-8ffa-7f34d3eb9a5d",
"UPN": "d9f905da-3507-496a-bb6b-b7f19cb4e584",
"PostDate": "2026-06-12T15:52:27.9956272+00:00",
"Comment": "sample string 4",
"CC": [
"2ac7d11b-277d-4d31-bfbd-db152ab2762f",
"271ec0cb-3444-42b7-8e13-f99d4e1f97ae"
],
"Users": [
"8fc83af7-598b-4bf4-b5f2-ef9bc4ef06fc",
"03b96958-8e67-4fdf-be60-083c7a7deca6"
]
}
],
"StartDate": "2026-06-12T15:52:27.9956272+00:00",
"DueDate": "2026-06-12T15:52:27.9956272+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"19b954fa-2d4f-459b-bc31-449a5dbc091d": "8e2fb764-11ce-4da0-8a7e-cd252e60276a",
"0be3e31c-6890-403c-90bb-ca0c3e4f93f3": "3d30cf2c-b1ec-4375-91c9-8cd953cf51b9"
},
"HasUpdates": true,
"Modified": "2026-06-12T15:52:27.9956272+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-12T15:52:27.9956272+00:00"
},
"LastComment": "2026-06-12T15:52:27.9956272+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "43e5a7ad-da53-4c8f-891a-db751f71dd8e",
"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": "6e5fd76e-ee31-493b-b821-ce51cd41f21f",
"id": "a1f725e8-8600-490f-b51c-d531f972aec7",
"ConfigId": "6575dd6b-4da7-4031-9b44-d98976c45d4b"
}