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": "b88771a1-ade5-44a5-8232-a80d5e2a45bf",
"ParentTaskId": "9a3fc7ee-dc89-43d9-990b-a7e51b673c76",
"Integration": {
"IntegrationId": "aa70de7a-7ef8-43ae-bb62-1234e97fff8b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7b56ec3e-2a13-4112-86b6-cdf8aef6604b": 2.0,
"cdeabc37-3aea-4947-9131-f6b2663081a5": 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": "edff357d-7c63-4338-90df-ba2577c38066",
"Name": "sample string 1",
"Created": "2026-06-13T16:20:12.3159462+00:00",
"Modified": "2026-06-13T16:20:12.3159462+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0a51b5a4-029e-4594-8b9c-ee8fbf2c6568",
"96e6da60-c38a-4930-9350-1600a41766b1"
],
"NonLaborAssignments": [
{
"Id": "497bbf66-5ec2-4593-ae53-842e94be2a27",
"ResourceId": "176b1af1-e1fc-4d78-b456-ad850d39bbe0",
"Quantity": 3.0
},
{
"Id": "497bbf66-5ec2-4593-ae53-842e94be2a27",
"ResourceId": "176b1af1-e1fc-4d78-b456-ad850d39bbe0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1958e05b-d1ce-42b0-8d29-7c414e67aa57",
"Type": 0,
"ResourceId": "f2306dc3-e478-47ee-bb0d-76552344da47",
"Units": 3.0
},
{
"Id": "1958e05b-d1ce-42b0-8d29-7c414e67aa57",
"Type": 0,
"ResourceId": "f2306dc3-e478-47ee-bb0d-76552344da47",
"Units": 3.0
}
],
"ParentId": "459e3a96-6204-435f-a5ac-ecf56d8b1f65",
"WorkTypeParentId": "354dab5b-5150-4552-a04d-ca28dc9a4b63",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6fbadde0-0766-4d5d-aa34-3ef46ee6ff19",
"UPN": "b69051a9-0be9-4ce7-b7c7-76147e03adc3",
"PostDate": "2026-06-13T16:20:12.3159462+00:00",
"Comment": "sample string 4",
"CC": [
"a0b9cea6-f43c-4885-bdcb-6a62c3794c0e",
"435e3cbb-3d96-4d7f-aeb2-d6040db38ff2"
],
"Users": [
"f2aa8e76-0477-4c46-b53d-59358f59aeb7",
"6d4a232d-8dcc-4b58-a5a5-026bc5e7c485"
]
},
{
"Id": "6fbadde0-0766-4d5d-aa34-3ef46ee6ff19",
"UPN": "b69051a9-0be9-4ce7-b7c7-76147e03adc3",
"PostDate": "2026-06-13T16:20:12.3159462+00:00",
"Comment": "sample string 4",
"CC": [
"a0b9cea6-f43c-4885-bdcb-6a62c3794c0e",
"435e3cbb-3d96-4d7f-aeb2-d6040db38ff2"
],
"Users": [
"f2aa8e76-0477-4c46-b53d-59358f59aeb7",
"6d4a232d-8dcc-4b58-a5a5-026bc5e7c485"
]
}
],
"StartDate": "2026-06-13T16:20:12.3159462+00:00",
"DueDate": "2026-06-13T16:20:12.3159462+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"638a5dca-729d-47ac-8ec3-4e4368f69c15": "c1903652-8acf-435a-86bf-fdedc23ac810",
"f83dda6c-550a-4d25-98fe-bf4f3b06e96b": "dfca4f53-2183-410c-9846-a70632c2c848"
},
"HasUpdates": true,
"Modified": "2026-06-13T16:20:12.3159462+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-06-13T16:20:12.3159462+00:00"
},
"LastComment": "2026-06-13T16:20:12.3159462+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3b5b7731-3960-479f-913d-80c4a6f4ec7c",
"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": "3bee7426-d102-4a0f-8fbf-25a372726723",
"id": "ce618703-b6cb-46b0-9d73-635b0d9766da",
"ConfigId": "e5381d70-d4d1-4092-b71c-098f52f83dd8"
}