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": "d75be0c5-ccaa-46cd-aa28-8afd43a383e8",
"ParentTaskId": "1c8aa93e-a222-4ae4-b5eb-c29804d4e7c4",
"Integration": {
"IntegrationId": "318114cc-5205-46bd-962b-ad6feea29448",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"91060a04-019f-4929-b575-89ccb7e17ade": 2.0,
"506c456a-c322-4e7b-8730-ef677f62d07c": 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": "9c373e69-6433-4a00-b462-f62af1c484f6",
"Name": "sample string 1",
"Created": "2026-06-12T01:39:50.0022364+00:00",
"Modified": "2026-06-12T01:39:50.0022364+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"324a2cf6-ce9f-42b7-9af9-305f2afaefd7",
"524c2a80-b9c4-4ab7-8adb-bbd8cc7a7d68"
],
"NonLaborAssignments": [
{
"Id": "b96fc7eb-b8d8-41f2-9b48-f6f9f3430a10",
"ResourceId": "e3744fd7-23ee-48b1-b5b9-d48804c1d745",
"Quantity": 3.0
},
{
"Id": "b96fc7eb-b8d8-41f2-9b48-f6f9f3430a10",
"ResourceId": "e3744fd7-23ee-48b1-b5b9-d48804c1d745",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4c86f07d-c1ea-4ad0-927d-e7f373a7b9c4",
"Type": 0,
"ResourceId": "599c9186-f658-49a5-abab-280ea362f535",
"Units": 3.0
},
{
"Id": "4c86f07d-c1ea-4ad0-927d-e7f373a7b9c4",
"Type": 0,
"ResourceId": "599c9186-f658-49a5-abab-280ea362f535",
"Units": 3.0
}
],
"ParentId": "4dc6157b-c88d-4ae9-a625-6c45be52134b",
"WorkTypeParentId": "d21b6f66-98b9-4534-b91b-5f3b7921ca56",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "392b83e0-62fa-4980-a323-892652268a94",
"UPN": "1343d969-d2a7-4549-9e39-841ea9ba77c5",
"PostDate": "2026-06-12T01:39:50.0022364+00:00",
"Comment": "sample string 4",
"CC": [
"7b7079f3-bef1-4105-8758-d9146fb6a69b",
"67a0447d-41ca-400b-b5ef-7a8a314b8a48"
],
"Users": [
"b792700f-d1f0-45e1-b4b8-56991b2a3b03",
"692adaa5-a468-4ebf-9ffd-d467a6169911"
]
},
{
"Id": "392b83e0-62fa-4980-a323-892652268a94",
"UPN": "1343d969-d2a7-4549-9e39-841ea9ba77c5",
"PostDate": "2026-06-12T01:39:50.0022364+00:00",
"Comment": "sample string 4",
"CC": [
"7b7079f3-bef1-4105-8758-d9146fb6a69b",
"67a0447d-41ca-400b-b5ef-7a8a314b8a48"
],
"Users": [
"b792700f-d1f0-45e1-b4b8-56991b2a3b03",
"692adaa5-a468-4ebf-9ffd-d467a6169911"
]
}
],
"StartDate": "2026-06-12T01:39:50.0022364+00:00",
"DueDate": "2026-06-12T01:39:50.0022364+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"eb54e4af-b37e-4b3f-8a2e-282736173661": "aa72b5e6-c93f-450e-b852-c17245b167b5",
"05198b48-d8b4-4a15-9997-3a1f8941d4cf": "b5480af3-d72e-471e-b749-afa4ceaa374e"
},
"HasUpdates": true,
"Modified": "2026-06-12T01:39:50.0022364+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-12T01:39:50.0022364+00:00"
},
"LastComment": "2026-06-12T01:39:50.0022364+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "46912076-a8ab-422c-825a-17b3b7090824",
"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": "8f00d6ed-48d2-45fa-8b83-aa788e5776cc",
"id": "42f52401-e055-4281-8a2f-0f7d2ccc9936",
"ConfigId": "9217b1f7-3779-4a8c-babc-b8ed02c8b4a4"
}