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": "5a029d5a-0fe0-4523-ba55-8f94fd66a4f9",
"ParentTaskId": "1252900f-a262-4300-9ce7-1eda4fe4b5eb",
"Integration": {
"IntegrationId": "e7dc3470-cfab-4717-afc2-37dee4d5afd0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ef3d3cf6-219a-44fe-8086-00344f21a265": 2.0,
"1746929b-b333-4d82-982e-4628b54510b7": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "8a71e6b6-7bba-45f5-8184-e76d7c45e080",
"Name": "sample string 1",
"Created": "2026-02-03T13:19:17.2646952+00:00",
"Modified": "2026-02-03T13:19:17.2646952+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"dfbdc082-23b5-4d2b-a91f-057084b97c4e",
"7451259e-a335-45bc-9a0c-f7a43eeb5b8a"
],
"NonLaborAssignments": [
{
"Id": "37bae36b-dbc6-4557-a09c-e8292f007d1f",
"ResourceId": "a8e2be75-795e-46be-a70a-79696db4be32",
"Quantity": 3.0
},
{
"Id": "37bae36b-dbc6-4557-a09c-e8292f007d1f",
"ResourceId": "a8e2be75-795e-46be-a70a-79696db4be32",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b9a24345-22d4-44e8-b4cd-1d7d45428fa3",
"Type": 0,
"ResourceId": "30196fb2-7708-4559-8763-73f6138d2cc9",
"Units": 3.0
},
{
"Id": "b9a24345-22d4-44e8-b4cd-1d7d45428fa3",
"Type": 0,
"ResourceId": "30196fb2-7708-4559-8763-73f6138d2cc9",
"Units": 3.0
}
],
"ParentId": "5afbb8bf-eb0c-4c32-ac7a-a8e6fb949f1b",
"WorkTypeParentId": "6acc1b7f-cea3-4464-9499-144548703fc7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "be802bc5-aa59-456e-8c02-340c1fafa653",
"UPN": "4d5246fc-6475-428b-a940-22d481b310da",
"PostDate": "2026-02-03T13:19:17.2646952+00:00",
"Comment": "sample string 4",
"CC": [
"68e44786-8dce-4a88-a2c4-c6dc1cda9a90",
"bd503b8a-1ed1-43e6-9062-07c609d4c92a"
],
"Users": [
"18588dba-fbb0-45c9-9348-f8559cc5ae61",
"076728fd-58ea-4901-805a-b048ad5f41b8"
]
},
{
"Id": "be802bc5-aa59-456e-8c02-340c1fafa653",
"UPN": "4d5246fc-6475-428b-a940-22d481b310da",
"PostDate": "2026-02-03T13:19:17.2646952+00:00",
"Comment": "sample string 4",
"CC": [
"68e44786-8dce-4a88-a2c4-c6dc1cda9a90",
"bd503b8a-1ed1-43e6-9062-07c609d4c92a"
],
"Users": [
"18588dba-fbb0-45c9-9348-f8559cc5ae61",
"076728fd-58ea-4901-805a-b048ad5f41b8"
]
}
],
"StartDate": "2026-02-03T13:19:17.2646952+00:00",
"DueDate": "2026-02-03T13:19:17.2646952+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a66d848c-d887-4fb8-9669-7e5906701a6e": "ad8e224e-693f-4086-bcdb-ff12130dfebb",
"6cbe37f3-d1bd-4c5e-a031-ed155290c112": "cc23fa77-7160-4d1a-a56e-64761a14ed0b"
},
"HasUpdates": true,
"Modified": "2026-02-03T13:19:17.2646952+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-02-03T13:19:17.2646952+00:00"
},
"LastComment": "2026-02-03T13:19:17.2646952+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "754b4037-b3b1-4605-b034-af6458e4eb1c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "d3cb6817-a7a2-4402-8c55-95fa20ecbc42",
"id": "ee2aa40d-5c0e-4687-a277-a22f36ee9ab5",
"ConfigId": "b4b5e22d-5cb3-4aab-9cce-2ff388d782a0"
}