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": "ea9578ef-dc30-4a6e-8783-d726a5e79037",
"ParentTaskId": "7ae6e12b-c1f4-4f46-ac0c-456e4c44db1f",
"Integration": {
"IntegrationId": "628fbb2d-b979-416f-94f3-0b7149bdd218",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"36f18fc7-a192-4ac4-bf2b-1360fc8dc37b": 2.0,
"85456bd8-3b95-46c1-ada2-0681569d4fcc": 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": "5ed4d658-9740-467e-93cb-608f0e12bfde",
"Name": "sample string 1",
"Created": "2026-05-08T18:50:09.2348767+00:00",
"Modified": "2026-05-08T18:50:09.2348767+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b0b7aeb8-9fe0-4473-8826-296aa480b179",
"2b04cc03-0094-4b61-933c-5ef8255fc90e"
],
"NonLaborAssignments": [
{
"Id": "586fc1bc-715e-484a-8181-567b7eefe3e0",
"ResourceId": "62a245bc-4bde-4046-a60a-0f337e50c937",
"Quantity": 3.0
},
{
"Id": "586fc1bc-715e-484a-8181-567b7eefe3e0",
"ResourceId": "62a245bc-4bde-4046-a60a-0f337e50c937",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9d13265f-7c9e-455a-b026-eb74d16af7fd",
"Type": 0,
"ResourceId": "bfa7a1f8-06c4-4263-8e8f-cd863154ae4b",
"Units": 3.0
},
{
"Id": "9d13265f-7c9e-455a-b026-eb74d16af7fd",
"Type": 0,
"ResourceId": "bfa7a1f8-06c4-4263-8e8f-cd863154ae4b",
"Units": 3.0
}
],
"ParentId": "0d7caa68-a9c1-4569-95d5-9458d768eb24",
"WorkTypeParentId": "59834bd5-8053-4af8-9ce4-c87a55d8b536",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1e97af79-24ba-4346-b476-7b2060523e9f",
"UPN": "2427c302-cca0-4f1e-b9c9-51308a11ac29",
"PostDate": "2026-05-08T18:50:09.2348767+00:00",
"Comment": "sample string 4",
"CC": [
"eddb8b41-3637-4d9d-89cd-342ae2c90b69",
"eb70d927-da34-4ba3-bc00-fd75fed93919"
],
"Users": [
"11a946c7-aef3-436b-af85-7c6e601e2210",
"c718894c-b140-4020-b71b-0b4202026bca"
]
},
{
"Id": "1e97af79-24ba-4346-b476-7b2060523e9f",
"UPN": "2427c302-cca0-4f1e-b9c9-51308a11ac29",
"PostDate": "2026-05-08T18:50:09.2348767+00:00",
"Comment": "sample string 4",
"CC": [
"eddb8b41-3637-4d9d-89cd-342ae2c90b69",
"eb70d927-da34-4ba3-bc00-fd75fed93919"
],
"Users": [
"11a946c7-aef3-436b-af85-7c6e601e2210",
"c718894c-b140-4020-b71b-0b4202026bca"
]
}
],
"StartDate": "2026-05-08T18:50:09.2348767+00:00",
"DueDate": "2026-05-08T18:50:09.2348767+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"03947b2f-0161-436f-849b-4dee684f01bf": "8c702994-3c3b-4e88-9b36-df1cccfc74c8",
"99dc0fc9-24b4-41a7-aa2c-48db86125eee": "158f1656-dbea-46c7-82f0-673d31669d44"
},
"HasUpdates": true,
"Modified": "2026-05-08T18:50:09.2348767+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-08T18:50:09.2348767+00:00"
},
"LastComment": "2026-05-08T18:50:09.2348767+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "27ef876b-2604-4ccb-b850-3ccea6193c6e",
"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": "e9e675a8-22aa-46e7-ad1e-925b9ed8c816",
"id": "6a8f410b-26b0-4d6e-8f43-5f0889c10f2a",
"ConfigId": "62bb6090-0c29-435b-8073-e70b391b3295"
}