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": "42e2c14d-aceb-46df-a41a-bac071a57854",
"ParentTaskId": "6506c41c-87dc-4a92-a521-8847f2223c7f",
"Integration": {
"IntegrationId": "680326d8-c71e-4486-ba51-881d28f7f0c8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"556be282-a5f8-4cea-8d6d-c100f6098799": 2.0,
"caa5c982-55f5-4f63-a3b7-cba9cfc835c1": 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": "cb87adef-6dfe-4a74-beb1-9661d8b3de1c",
"Name": "sample string 1",
"Created": "2026-05-22T21:34:54.4161808+00:00",
"Modified": "2026-05-22T21:34:54.4161808+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ef4af536-bd25-4096-ba8f-cb586317e116",
"f084ca6e-ca36-45b4-be8e-7c888736899c"
],
"NonLaborAssignments": [
{
"Id": "128bbbc4-91d9-4e71-8233-1be48c34c923",
"ResourceId": "5add1498-9680-49aa-9453-7203cee512ce",
"Quantity": 3.0
},
{
"Id": "128bbbc4-91d9-4e71-8233-1be48c34c923",
"ResourceId": "5add1498-9680-49aa-9453-7203cee512ce",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8d602331-46ed-49bc-9183-116f09eaca59",
"Type": 0,
"ResourceId": "f0cb3d8c-2cc4-494d-9ae3-463cdb627ad5",
"Units": 3.0
},
{
"Id": "8d602331-46ed-49bc-9183-116f09eaca59",
"Type": 0,
"ResourceId": "f0cb3d8c-2cc4-494d-9ae3-463cdb627ad5",
"Units": 3.0
}
],
"ParentId": "dde40715-19ee-4b81-ba43-e312a0786083",
"WorkTypeParentId": "1bc05bd0-2050-4cc6-82bd-92a796f0a904",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1255307a-166a-4cc6-8e17-6c397b6f0ae0",
"UPN": "5d35b518-8f61-4ac1-88fc-3d3957444947",
"PostDate": "2026-05-22T21:34:54.4161808+00:00",
"Comment": "sample string 4",
"CC": [
"40c6ec3e-053b-49b6-80fd-89f4c307cef9",
"2d6123ba-d2b5-42be-9a2d-f1cfc169d60b"
],
"Users": [
"d87b5f7a-0b8d-44ec-babc-88f031b502b1",
"cfa25331-e987-4ee3-9ddd-86e9ee5bdbc2"
]
},
{
"Id": "1255307a-166a-4cc6-8e17-6c397b6f0ae0",
"UPN": "5d35b518-8f61-4ac1-88fc-3d3957444947",
"PostDate": "2026-05-22T21:34:54.4161808+00:00",
"Comment": "sample string 4",
"CC": [
"40c6ec3e-053b-49b6-80fd-89f4c307cef9",
"2d6123ba-d2b5-42be-9a2d-f1cfc169d60b"
],
"Users": [
"d87b5f7a-0b8d-44ec-babc-88f031b502b1",
"cfa25331-e987-4ee3-9ddd-86e9ee5bdbc2"
]
}
],
"StartDate": "2026-05-22T21:34:54.4161808+00:00",
"DueDate": "2026-05-22T21:34:54.4161808+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2edca963-b7fe-4c3c-bf8d-ea28ab0d2909": "52e0966a-3a31-4d33-af6f-688aecb7ccef",
"6366bc7b-d5cb-443c-9dca-433aa5eabd7f": "21efada4-4a6c-4fb7-af57-e446f8595ea3"
},
"HasUpdates": true,
"Modified": "2026-05-22T21:34:54.4161808+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-22T21:34:54.4161808+00:00"
},
"LastComment": "2026-05-22T21:34:54.4161808+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c4c51814-4a86-4175-89cc-575663cb2874",
"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": "99a6192f-eb75-4ba2-b9b9-70a7b5193747",
"id": "4f9eda96-9fde-4d25-ba5f-76c0d9eefe3f",
"ConfigId": "96818065-2665-4371-a1ea-10958ad1c8c1"
}