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": "dc967362-3c93-47b5-8757-66a1440f4d84",
"ParentTaskId": "210754ff-3759-48f6-84e1-f44b594f6646",
"Integration": {
"IntegrationId": "7eb31aa0-8117-4f2b-b01f-4f8919113806",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"565fd42a-0c4f-41a3-ad4b-1b4490def113": 2.0,
"093f62e0-b92a-42b7-95b4-0563c8380d10": 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": "e1a679ef-164b-470b-a346-87d5f312ed3c",
"Name": "sample string 1",
"Created": "2026-07-24T15:45:34.1132495+00:00",
"Modified": "2026-07-24T15:45:34.1132495+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ff8b57d9-84c0-44c8-865b-6b558dd523f4",
"1dee21aa-783e-43c3-926e-fa38798ead39"
],
"NonLaborAssignments": [
{
"Id": "d8f7399d-d5d2-4dd9-8bf7-32e2b6778f7f",
"ResourceId": "1736045e-318a-4860-8fa1-6892182bea27",
"Quantity": 3.0
},
{
"Id": "d8f7399d-d5d2-4dd9-8bf7-32e2b6778f7f",
"ResourceId": "1736045e-318a-4860-8fa1-6892182bea27",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a504d7b2-51da-4283-99a8-47e4ba32190e",
"Type": 0,
"ResourceId": "b8ef5524-9b28-40bb-8be7-0edae62b9734",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "a504d7b2-51da-4283-99a8-47e4ba32190e",
"Type": 0,
"ResourceId": "b8ef5524-9b28-40bb-8be7-0edae62b9734",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "738b9d25-9bf4-4611-8b2e-c01d6ffcfc2a",
"WorkTypeParentId": "b31d2a30-da44-4fd1-82e5-87f7c35d4aa0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "05faa47a-856f-4fda-987f-32faa88a4d0e",
"UPN": "3203fc4d-1e8e-4205-8af1-3b62bf8b8828",
"PostDate": "2026-07-24T15:45:34.1132495+00:00",
"Comment": "sample string 4",
"CC": [
"7c5bd201-c97c-49fc-8833-325b6b622c92",
"244c0501-90c2-4f92-ae70-edd9dea0e389"
],
"Users": [
"23202c0d-c3f4-4443-bede-ef88ab090f3e",
"8ceed3bc-5343-4fdb-b1d3-e4f53ad326b8"
]
},
{
"Id": "05faa47a-856f-4fda-987f-32faa88a4d0e",
"UPN": "3203fc4d-1e8e-4205-8af1-3b62bf8b8828",
"PostDate": "2026-07-24T15:45:34.1132495+00:00",
"Comment": "sample string 4",
"CC": [
"7c5bd201-c97c-49fc-8833-325b6b622c92",
"244c0501-90c2-4f92-ae70-edd9dea0e389"
],
"Users": [
"23202c0d-c3f4-4443-bede-ef88ab090f3e",
"8ceed3bc-5343-4fdb-b1d3-e4f53ad326b8"
]
}
],
"StartDate": "2026-07-24T15:45:34.1132495+00:00",
"DueDate": "2026-07-24T15:45:34.1132495+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1857132c-a854-43ef-beaf-0ed53cf533b8": "9cdec1a2-e7cb-4662-a44c-943beea5ba7c",
"02e26224-1606-4bef-ae2c-848229fd5558": "bde066c5-c76d-4ffc-8af4-2288dbdbb71a"
},
"HasUpdates": true,
"Modified": "2026-07-24T15:45:34.1132495+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-24T15:45:34.1132495+00:00"
},
"LastComment": "2026-07-24T15:45:34.1132495+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8a2ce5c7-fa8a-4776-b089-563ed0b239a2",
"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": "03f411f0-1bdc-4671-87bd-87cf7b074328",
"id": "6f2cc2de-370b-4599-8a89-1f8ebc0add89",
"ConfigId": "f1b6d1d6-e2fc-4f0c-b1ff-0366424ccece"
}