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": "18e91366-9e46-45e1-931f-5f68a0e286dd",
"ParentTaskId": "b1086365-86e9-4246-894e-d810534fcb50",
"Integration": {
"IntegrationId": "f0f8e974-c712-4d1d-a97c-c27c7304fe2a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4c30eb47-60e7-44d4-87af-8756dc94725a": 2.0,
"37f3e2d8-8469-4cc1-a86c-2359c7227793": 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": "5b5771d5-fc9a-46c5-8aba-514a1a91d507",
"Name": "sample string 1",
"Created": "2026-07-30T00:32:43.6849173+00:00",
"Modified": "2026-07-30T00:32:43.6849173+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"39fb7a6b-ecf5-4ec1-8270-ee766f5c579d",
"2d8ec9fe-79e8-4ccc-b5c0-8f85304105d2"
],
"NonLaborAssignments": [
{
"Id": "9d166b51-86e3-4eb9-b26c-17900e76a1d8",
"ResourceId": "89e46bb9-2fa5-48d4-9a51-ffe2ba3b73d4",
"Quantity": 3.0
},
{
"Id": "9d166b51-86e3-4eb9-b26c-17900e76a1d8",
"ResourceId": "89e46bb9-2fa5-48d4-9a51-ffe2ba3b73d4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "75641bf2-3883-4dee-b070-a6a69c23902f",
"Type": 0,
"ResourceId": "19142df2-4827-44c4-9cdf-fa3d72a1ba8c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "75641bf2-3883-4dee-b070-a6a69c23902f",
"Type": 0,
"ResourceId": "19142df2-4827-44c4-9cdf-fa3d72a1ba8c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "84d468e1-1100-4e03-b0e1-c2adeeabd511",
"WorkTypeParentId": "c9364c34-ae48-4bf9-95e1-289df3cb2fd5",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cf6d6020-791a-4a5f-9af9-6c189c0f3454",
"UPN": "12dd15ac-1c52-40e7-b59d-9228bfd7a400",
"PostDate": "2026-07-30T00:32:43.7005463+00:00",
"Comment": "sample string 4",
"CC": [
"47eed8c0-3f9c-4f63-b608-f17c9ac67bc8",
"50e4b5fe-b86f-4d37-b8ef-b416cf52ca3a"
],
"Users": [
"2866c89a-649a-4cb8-9dd3-cc3e7d319c3f",
"6509251e-42af-4807-af2b-919eb6f25878"
]
},
{
"Id": "cf6d6020-791a-4a5f-9af9-6c189c0f3454",
"UPN": "12dd15ac-1c52-40e7-b59d-9228bfd7a400",
"PostDate": "2026-07-30T00:32:43.7005463+00:00",
"Comment": "sample string 4",
"CC": [
"47eed8c0-3f9c-4f63-b608-f17c9ac67bc8",
"50e4b5fe-b86f-4d37-b8ef-b416cf52ca3a"
],
"Users": [
"2866c89a-649a-4cb8-9dd3-cc3e7d319c3f",
"6509251e-42af-4807-af2b-919eb6f25878"
]
}
],
"StartDate": "2026-07-30T00:32:43.7005463+00:00",
"DueDate": "2026-07-30T00:32:43.7005463+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9c3006b5-5b23-4ca2-bf28-c97d8676a720": "30b367d3-949a-44c5-aa9a-a612af82e272",
"3b4bdc61-c0f2-4849-8f5f-43c2be51691a": "ae10c156-6b55-40e5-96c2-e4f4b17904ec"
},
"HasUpdates": true,
"Modified": "2026-07-30T00:32:43.7005463+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-30T00:32:43.7005463+00:00"
},
"LastComment": "2026-07-30T00:32:43.7005463+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2d83ec76-2038-47e8-98cb-7589be79bc55",
"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": "8f767855-eda5-48d7-9cc4-c61280d6ca1e",
"id": "27df140a-ef81-407e-b52d-eb84cd8ca7ec",
"ConfigId": "65fc44c5-5750-4541-8710-0adbfce1b6f8"
}