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": "862e9495-cb14-441e-a3d4-ec5fb96b5b01",
"ParentTaskId": "d8abc76c-2129-43ab-a12d-2ea9a9f4d48f",
"Integration": {
"IntegrationId": "ae36830f-c1df-4ae5-b674-bae450726598",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"77456378-8d8e-4a5a-acbe-9a2507c3a8ae": 2.0,
"b803a8f2-9d1e-4393-bc9b-b0fe0139ab5f": 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": "37e6e6dc-8544-449b-9262-e2bc1774b052",
"Name": "sample string 1",
"Created": "2026-08-11T14:35:30.9877543+00:00",
"Modified": "2026-08-11T14:35:30.9877543+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"6bf2a646-8eea-4324-a987-2f6f2bbcaac6",
"ff769cd4-a5c5-4829-8790-becbbf545b00"
],
"NonLaborAssignments": [
{
"Id": "3a574a7c-5bf3-4e26-9a4d-c2b4696a7a9f",
"ResourceId": "b5a85988-8850-41d0-bee9-97977ed86519",
"Quantity": 3.0
},
{
"Id": "3a574a7c-5bf3-4e26-9a4d-c2b4696a7a9f",
"ResourceId": "b5a85988-8850-41d0-bee9-97977ed86519",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "34ffef79-a934-4830-b157-6ebfb34d4500",
"Type": 0,
"ResourceId": "1eb34848-e384-4ae8-8566-c566fc24ed0f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "34ffef79-a934-4830-b157-6ebfb34d4500",
"Type": 0,
"ResourceId": "1eb34848-e384-4ae8-8566-c566fc24ed0f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "68173bba-e99e-4786-8f09-a9a8a4d58b94",
"WorkTypeParentId": "bb9898ca-c91f-436b-8468-3d23a18ebfe8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "476bbcca-47a1-42d2-b6c2-142ca3441362",
"UPN": "f34850fa-1544-4fd2-a747-d28403cdf8ed",
"PostDate": "2026-08-11T14:35:30.9877543+00:00",
"Comment": "sample string 4",
"CC": [
"c04c1b9d-684a-4cf4-8760-0ff7b62c3ec1",
"2821b3b4-3716-4c83-988c-75bf9f9634a7"
],
"Users": [
"fd6d1696-280e-4659-8a68-292f4b384b11",
"183710eb-9f6b-4bcd-9151-bb3e4cc68b3b"
]
},
{
"Id": "476bbcca-47a1-42d2-b6c2-142ca3441362",
"UPN": "f34850fa-1544-4fd2-a747-d28403cdf8ed",
"PostDate": "2026-08-11T14:35:30.9877543+00:00",
"Comment": "sample string 4",
"CC": [
"c04c1b9d-684a-4cf4-8760-0ff7b62c3ec1",
"2821b3b4-3716-4c83-988c-75bf9f9634a7"
],
"Users": [
"fd6d1696-280e-4659-8a68-292f4b384b11",
"183710eb-9f6b-4bcd-9151-bb3e4cc68b3b"
]
}
],
"StartDate": "2026-08-11T14:35:30.9877543+00:00",
"DueDate": "2026-08-11T14:35:30.9877543+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"53a625d4-554e-4ea4-9776-66764568a1bb": "ed0ccd80-a1be-40d0-8f7b-53312c356fce",
"b22d126b-daf8-448a-a895-2ef2cf456bcf": "d9eb078e-98e6-4f85-8e02-389a796029a1"
},
"HasUpdates": true,
"Modified": "2026-08-11T14:35:30.9877543+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-08-11T14:35:30.9877543+00:00"
},
"LastComment": "2026-08-11T14:35:30.9877543+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "875b47be-e2ee-4c30-8373-7b07ab07722b",
"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": "47a9a431-c0e4-4a00-b7d9-f17bb1cbb661",
"id": "7c314bc3-772e-46f8-991d-e63607a80d96",
"ConfigId": "8daebc87-f16a-42a7-b8fb-ef0183063ab9"
}