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": "ed399659-7590-43bc-9462-a94d6eef79f1",
"ParentTaskId": "a1fc8b7f-c719-49d6-8660-aa66841f9ea7",
"Integration": {
"IntegrationId": "5889afc8-0ce4-4a03-ad74-fdf453960eb8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"be591c7a-bb19-4313-a5d5-86e97a0eeb1b": 2.0,
"f34db513-ceb3-401c-af93-6973044e89b7": 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": "cdddb696-bb8a-4cc0-a53b-c218c34866ee",
"Name": "sample string 1",
"Created": "2026-10-25T22:51:27.4523094+00:00",
"Modified": "2026-10-25T22:51:27.4523094+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1d3a0fcb-1da5-4db7-ac3e-7350c5eebbcc",
"dbcf8f22-55be-4f50-a509-1e0ba9640435"
],
"NonLaborAssignments": [
{
"Id": "554efc69-fa3a-4542-8f83-268ecf3602af",
"ResourceId": "44414888-f4c6-4dc9-a49e-f6ecf8a6412b",
"Quantity": 3.0
},
{
"Id": "554efc69-fa3a-4542-8f83-268ecf3602af",
"ResourceId": "44414888-f4c6-4dc9-a49e-f6ecf8a6412b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e402bee9-6dc7-48e6-b218-858c20f18795",
"Type": 0,
"ResourceId": "b7dcf406-1ab8-4ade-b773-23a6c831c9f7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "5bb76f1c-3461-4abd-b313-57ce1cdafa2b",
"Start": "2026-10-25T22:51:27.4523094+00:00",
"Due": "2026-10-25T22:51:27.4523094+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "5bb76f1c-3461-4abd-b313-57ce1cdafa2b",
"Start": "2026-10-25T22:51:27.4523094+00:00",
"Due": "2026-10-25T22:51:27.4523094+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "e402bee9-6dc7-48e6-b218-858c20f18795",
"Type": 0,
"ResourceId": "b7dcf406-1ab8-4ade-b773-23a6c831c9f7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "5bb76f1c-3461-4abd-b313-57ce1cdafa2b",
"Start": "2026-10-25T22:51:27.4523094+00:00",
"Due": "2026-10-25T22:51:27.4523094+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "5bb76f1c-3461-4abd-b313-57ce1cdafa2b",
"Start": "2026-10-25T22:51:27.4523094+00:00",
"Due": "2026-10-25T22:51:27.4523094+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "4f3933c9-0b9d-4724-a5ca-d004f6dea980",
"WorkTypeParentId": "701df13f-a88d-4865-9b27-3d6cfa528f9c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "eea00c37-e1ce-406b-b2bd-b68e5aad1285",
"UPN": "7b9e20a8-92a9-400a-9f36-0f7dd5007f73",
"PostDate": "2026-10-25T22:51:27.4523094+00:00",
"Comment": "sample string 4",
"CC": [
"2a11fe77-5cf9-48df-a9aa-2950c9bb48f4",
"d1b999cf-f6f5-45f3-b717-7d2937ae838e"
],
"Users": [
"25851c37-c3b4-4a89-861f-c38835985fb9",
"f54ae4cc-94be-4128-a9dc-d2cb8d4dd30b"
]
},
{
"Id": "eea00c37-e1ce-406b-b2bd-b68e5aad1285",
"UPN": "7b9e20a8-92a9-400a-9f36-0f7dd5007f73",
"PostDate": "2026-10-25T22:51:27.4523094+00:00",
"Comment": "sample string 4",
"CC": [
"2a11fe77-5cf9-48df-a9aa-2950c9bb48f4",
"d1b999cf-f6f5-45f3-b717-7d2937ae838e"
],
"Users": [
"25851c37-c3b4-4a89-861f-c38835985fb9",
"f54ae4cc-94be-4128-a9dc-d2cb8d4dd30b"
]
}
],
"StartDate": "2026-10-25T22:51:27.4523094+00:00",
"DueDate": "2026-10-25T22:51:27.4523094+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4f0d4289-1426-41a4-b83b-e446299cf373": "e07d0b9e-51f1-4a4c-b245-4e8cd22c168f",
"7dabbd64-9ada-458d-9352-fc6287dbc9da": "11200c76-6109-488e-aca5-dcc7cad91327"
},
"HasUpdates": true,
"Modified": "2026-10-25T22:51:27.4523094+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-10-25T22:51:27.4679464+00:00"
},
"LastComment": "2026-10-25T22:51:27.4679464+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5bf3d7dd-713c-4e52-926a-1720e229a71f",
"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": "a07ceebb-4b64-4bf9-b8bf-6204fa93b2ba",
"id": "cb709034-75fc-430f-b9c3-539dd0eb82f5",
"ConfigId": "131652fb-b094-4184-ad4b-0f1f2ac5c08f"
}