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": "a50c75fb-bc69-4f84-bb65-14c9e70eeb78",
"ParentTaskId": "60a201ec-ded9-417f-b383-753da7fa6fdd",
"Integration": {
"IntegrationId": "ec02cd12-6471-4506-8069-f71322554620",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"eef9e96f-6aec-45a6-b249-7cfcfe4c39bd": 2.0,
"014bdba1-fed3-49cc-959c-31fb6199116b": 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": "0bb2d397-e293-456c-86d4-8cd2558ab618",
"Name": "sample string 1",
"Created": "2026-07-09T23:30:48.2973775+00:00",
"Modified": "2026-07-09T23:30:48.2973775+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f982651e-427a-4250-bc0e-6c90951eff55",
"1c438a4e-b4ca-4856-845c-17b339ea35a9"
],
"NonLaborAssignments": [
{
"Id": "3bb22bad-6ed7-4e76-9781-c79d47aafa10",
"ResourceId": "0ed18658-a99a-45f8-a982-646c30c91f3a",
"Quantity": 3.0
},
{
"Id": "3bb22bad-6ed7-4e76-9781-c79d47aafa10",
"ResourceId": "0ed18658-a99a-45f8-a982-646c30c91f3a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d350db74-b6da-4a5f-9912-a56293af9e00",
"Type": 0,
"ResourceId": "45a22311-b4a9-4452-8dca-96696e45683d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "d350db74-b6da-4a5f-9912-a56293af9e00",
"Type": 0,
"ResourceId": "45a22311-b4a9-4452-8dca-96696e45683d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3c9e9891-d478-4883-a761-ab36c8f397c4",
"WorkTypeParentId": "aec65743-b2bb-4ef3-9126-2d62c61f3810",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7d32f55c-35e8-4762-961d-3b0c8ff10332",
"UPN": "01206a8c-c782-4269-a62d-6fd08e2aead2",
"PostDate": "2026-07-09T23:30:48.2973775+00:00",
"Comment": "sample string 4",
"CC": [
"ee184eb4-796e-4b99-95c1-34c38cde4f6f",
"0256c99e-d883-41d5-9aac-511747569b12"
],
"Users": [
"fc2502e6-7593-499f-a10d-7d8de2a0c32d",
"38a402bc-cad4-44c1-b5ac-d9e7c1aaaf1f"
]
},
{
"Id": "7d32f55c-35e8-4762-961d-3b0c8ff10332",
"UPN": "01206a8c-c782-4269-a62d-6fd08e2aead2",
"PostDate": "2026-07-09T23:30:48.2973775+00:00",
"Comment": "sample string 4",
"CC": [
"ee184eb4-796e-4b99-95c1-34c38cde4f6f",
"0256c99e-d883-41d5-9aac-511747569b12"
],
"Users": [
"fc2502e6-7593-499f-a10d-7d8de2a0c32d",
"38a402bc-cad4-44c1-b5ac-d9e7c1aaaf1f"
]
}
],
"StartDate": "2026-07-09T23:30:48.2973775+00:00",
"DueDate": "2026-07-09T23:30:48.2973775+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"61e48cb4-ee4b-4099-9df5-041b395271e5": "2cf5c0f8-794b-45f4-92f2-99ac1eddab03",
"f70a8ca6-c1ce-4c6a-b18e-2421d1c23428": "5181c23d-14ec-44bd-a009-9a9a4f7b97fe"
},
"HasUpdates": true,
"Modified": "2026-07-09T23:30:48.2973775+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-07-09T23:30:48.2973775+00:00"
},
"LastComment": "2026-07-09T23:30:48.2973775+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e9991813-e9a0-4f18-9a20-a949afa142b0",
"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": "3369e477-0aa7-429c-a0f4-d0e7a03c972f",
"id": "caae2b0b-0b9f-41ce-bdb8-3285cad317a0",
"ConfigId": "d9e50831-3ff5-4e6d-8f4d-57f5f8fae8f5"
}