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": "dfc05209-8774-40d1-860c-a7114e1399bd",
"ParentTaskId": "7b4df399-479c-4c8c-8913-cbb8d516543c",
"Integration": {
"IntegrationId": "81cb1d78-c60d-4b57-8fa4-dec3b4265637",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"93f7959d-7684-464b-9f96-26719ec945b8": 2.0,
"e5505523-a5f5-48ae-83a0-58503f528dc9": 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": "5d877eb4-267c-48db-afab-b470f7043dc6",
"Name": "sample string 1",
"Created": "2026-08-23T16:11:04.6204759+00:00",
"Modified": "2026-08-23T16:11:04.6204759+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1ff7dca1-d49e-4c45-9a5a-1b272decc503",
"0f22c4e7-6b4d-4a0d-b840-7d13f9c2a9d4"
],
"NonLaborAssignments": [
{
"Id": "e19ed1c0-bdd0-4dc0-9ebf-46a22a99ae0a",
"ResourceId": "618bfc2e-fe82-4bab-a13e-5c1832f6227d",
"Quantity": 3.0
},
{
"Id": "e19ed1c0-bdd0-4dc0-9ebf-46a22a99ae0a",
"ResourceId": "618bfc2e-fe82-4bab-a13e-5c1832f6227d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8629d661-0d94-414e-925f-96c48f95afd8",
"Type": 0,
"ResourceId": "c9457af3-9982-428c-91d3-50db471772ba",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "8629d661-0d94-414e-925f-96c48f95afd8",
"Type": 0,
"ResourceId": "c9457af3-9982-428c-91d3-50db471772ba",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "7653234e-9b30-42c2-8f53-59b350ef6894",
"WorkTypeParentId": "5f482ec5-68b3-4bc3-bd5c-db80d3ebb140",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1fae6bb2-9f1f-47a1-bb0e-78962dff5c5d",
"UPN": "ef12299e-6571-438f-aff0-ed441e333feb",
"PostDate": "2026-08-23T16:11:04.6204759+00:00",
"Comment": "sample string 4",
"CC": [
"ec6caa61-75d0-480c-b6ad-13e8dae2c276",
"2e11d90c-2798-44c1-b28d-d43c8ad45e1c"
],
"Users": [
"d9ac0abd-d774-4eef-b2cd-2461f3b147b5",
"f4cb3b47-ddb1-41ed-a1c8-592680414442"
]
},
{
"Id": "1fae6bb2-9f1f-47a1-bb0e-78962dff5c5d",
"UPN": "ef12299e-6571-438f-aff0-ed441e333feb",
"PostDate": "2026-08-23T16:11:04.6204759+00:00",
"Comment": "sample string 4",
"CC": [
"ec6caa61-75d0-480c-b6ad-13e8dae2c276",
"2e11d90c-2798-44c1-b28d-d43c8ad45e1c"
],
"Users": [
"d9ac0abd-d774-4eef-b2cd-2461f3b147b5",
"f4cb3b47-ddb1-41ed-a1c8-592680414442"
]
}
],
"StartDate": "2026-08-23T16:11:04.6204759+00:00",
"DueDate": "2026-08-23T16:11:04.6204759+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4aac1949-a58b-4cb0-bb88-760eabb709a5": "6f5c3a70-99e9-4c05-9eb2-1face3f33960",
"f3b29d52-bd38-42f3-8461-42fe41518415": "c1498ff8-18c7-4d5a-ae1d-31690d478b69"
},
"HasUpdates": true,
"Modified": "2026-08-23T16:11:04.6204759+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-23T16:11:04.6204759+00:00"
},
"LastComment": "2026-08-23T16:11:04.6204759+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "87f7e8da-26ef-44ed-9201-5ee900d02cae",
"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": "13bc5fa1-b1ed-478d-8c26-4eeb2d18caf7",
"id": "d89f1138-f641-48e6-b4c2-d73237d41d97",
"ConfigId": "c558e908-b9d7-4acb-a860-1420dc79914d"
}