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": "8634a04e-5f9b-47de-9510-3045d9d5c320",
"ParentTaskId": "e9a25ca8-b2fe-4219-b425-a1148693c757",
"Integration": {
"IntegrationId": "462d9e6a-1925-481d-950f-50c7792661bd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a9801145-a143-4757-831b-f04710efccdf": 2.0,
"61200a48-9a40-4d36-9162-bf065150bd29": 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": "4dc7e328-0347-464d-96a5-63234405b670",
"Name": "sample string 1",
"Created": "2026-06-14T17:52:35.6470173+00:00",
"Modified": "2026-06-14T17:52:35.6470173+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e398d413-ec8b-4f88-a520-9dbdcd9df46d",
"4fae3942-7868-4505-909f-52c561ddf8fd"
],
"NonLaborAssignments": [
{
"Id": "1e59e7c1-c509-4bd5-b77c-5a5519527c6d",
"ResourceId": "93313966-2f5c-478b-9777-e306f5250d92",
"Quantity": 3.0
},
{
"Id": "1e59e7c1-c509-4bd5-b77c-5a5519527c6d",
"ResourceId": "93313966-2f5c-478b-9777-e306f5250d92",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1ac8abde-49cc-4d5c-815d-fe609c9a6e9f",
"Type": 0,
"ResourceId": "dc97a544-0c81-4afe-b1cd-0a9756a3e574",
"Units": 3.0
},
{
"Id": "1ac8abde-49cc-4d5c-815d-fe609c9a6e9f",
"Type": 0,
"ResourceId": "dc97a544-0c81-4afe-b1cd-0a9756a3e574",
"Units": 3.0
}
],
"ParentId": "27397a39-f09e-4e58-ae9f-66028cbc89e3",
"WorkTypeParentId": "fa76bfe3-5445-43bb-88b0-7a155791ba78",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c50b474d-5d3e-41d2-bfc6-3c65db6226ba",
"UPN": "90e6f3d1-e81d-4bdc-8cbf-cb142e97ca9f",
"PostDate": "2026-06-14T17:52:35.6470173+00:00",
"Comment": "sample string 4",
"CC": [
"07cc17cf-8337-4c2f-a025-b4a115a561ba",
"a319efb9-8d2e-4442-bcb1-92a5ab20efa6"
],
"Users": [
"5a82d215-cd44-4b86-9c60-45ebbf7803ec",
"3bd3b0c1-ffbe-44a5-a51b-e5f5a094f294"
]
},
{
"Id": "c50b474d-5d3e-41d2-bfc6-3c65db6226ba",
"UPN": "90e6f3d1-e81d-4bdc-8cbf-cb142e97ca9f",
"PostDate": "2026-06-14T17:52:35.6470173+00:00",
"Comment": "sample string 4",
"CC": [
"07cc17cf-8337-4c2f-a025-b4a115a561ba",
"a319efb9-8d2e-4442-bcb1-92a5ab20efa6"
],
"Users": [
"5a82d215-cd44-4b86-9c60-45ebbf7803ec",
"3bd3b0c1-ffbe-44a5-a51b-e5f5a094f294"
]
}
],
"StartDate": "2026-06-14T17:52:35.6470173+00:00",
"DueDate": "2026-06-14T17:52:35.6470173+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2c133ff0-18bd-46d0-8627-283eb30cb38f": "10401e25-a8da-4527-a5d1-5e4e039e7f99",
"fc435c06-7392-414e-8ff3-248385ec12ac": "9b0ab8fa-7599-4be3-949b-749f35581584"
},
"HasUpdates": true,
"Modified": "2026-06-14T17:52:35.6470173+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-14T17:52:35.6470173+00:00"
},
"LastComment": "2026-06-14T17:52:35.6470173+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "31e8f6aa-8d3c-4a36-acd6-1093ed91459f",
"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": "e00a645d-2c90-4dba-929c-0eba8de61753",
"id": "4d74d10c-23b6-4f86-97ac-8c81b4f99fe9",
"ConfigId": "4a0cf053-159e-409b-8eec-b4b6addfed3b"
}