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": "854da486-9cf1-40dc-8557-a653c01e48ae",
"ParentTaskId": "5474cc18-116b-4c40-a147-42e69a995137",
"Integration": {
"IntegrationId": "9232a486-4f55-4b10-be24-8e53fd682c6a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b82c36ce-9b93-46df-be88-6d7c95833d4b": 2.0,
"9122cbc4-3111-433f-9368-7ab871d591ea": 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": "0e0cfd9a-36c6-45c5-b518-c96b8e2010b3",
"Name": "sample string 1",
"Created": "2026-05-25T23:42:53.5468674+00:00",
"Modified": "2026-05-25T23:42:53.5468674+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c67132b1-32a8-4693-94be-46997a6885f4",
"983727a4-d3bb-4909-b41a-d3b1a8f21662"
],
"NonLaborAssignments": [
{
"Id": "657a6bda-f1dc-422f-9396-dccc3683c758",
"ResourceId": "68f6ab2c-bc79-4d1a-8ff1-33c7c4643e89",
"Quantity": 3.0
},
{
"Id": "657a6bda-f1dc-422f-9396-dccc3683c758",
"ResourceId": "68f6ab2c-bc79-4d1a-8ff1-33c7c4643e89",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "04d47f00-5bc2-4aee-8fd1-c3d3108e8600",
"Type": 0,
"ResourceId": "bf79af04-4ece-47ac-a78d-072c1efc4750",
"Units": 3.0
},
{
"Id": "04d47f00-5bc2-4aee-8fd1-c3d3108e8600",
"Type": 0,
"ResourceId": "bf79af04-4ece-47ac-a78d-072c1efc4750",
"Units": 3.0
}
],
"ParentId": "11b27e5c-940b-42a9-b216-179fdb3cdf5d",
"WorkTypeParentId": "3761a87b-33d4-445f-ad1d-9e76491cb40a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b9ef5813-2971-445b-8805-4ae7be2b28fe",
"UPN": "a511e7a6-990a-4fee-a720-9da16ba29a82",
"PostDate": "2026-05-25T23:42:53.5468674+00:00",
"Comment": "sample string 4",
"CC": [
"3128c06e-b2c9-4cf4-abc5-cefcd4d62ae0",
"8a401ca2-ad73-4da9-9d65-2f355fc15349"
],
"Users": [
"8dca3c52-dd9c-4eb6-82d4-d496dc550826",
"c0f2a339-acfc-4bbf-a797-783dd4896011"
]
},
{
"Id": "b9ef5813-2971-445b-8805-4ae7be2b28fe",
"UPN": "a511e7a6-990a-4fee-a720-9da16ba29a82",
"PostDate": "2026-05-25T23:42:53.5468674+00:00",
"Comment": "sample string 4",
"CC": [
"3128c06e-b2c9-4cf4-abc5-cefcd4d62ae0",
"8a401ca2-ad73-4da9-9d65-2f355fc15349"
],
"Users": [
"8dca3c52-dd9c-4eb6-82d4-d496dc550826",
"c0f2a339-acfc-4bbf-a797-783dd4896011"
]
}
],
"StartDate": "2026-05-25T23:42:53.5468674+00:00",
"DueDate": "2026-05-25T23:42:53.5468674+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"09fce6c6-7b12-4066-b8ce-f96301188ac1": "4037691e-9bfb-4253-8619-23b01e9bcc64",
"9932d666-8f9f-4440-b2c5-72b1df896d24": "fc48ee49-2e62-40e3-9c4d-644d7f3ada58"
},
"HasUpdates": true,
"Modified": "2026-05-25T23:42:53.5468674+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-05-25T23:42:53.5468674+00:00"
},
"LastComment": "2026-05-25T23:42:53.5468674+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "deb14a38-8117-450d-ae0d-6d7e62913037",
"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": "2d9ab14f-04d6-402b-9f81-2773b2331395",
"id": "cd52066f-304a-4a82-904d-53a13dffab9e",
"ConfigId": "83574fb5-92fe-4551-b16f-f4d085e4d2d9"
}