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": "1347ffb4-0b4a-4cf3-b823-79d4293925a2",
"ParentTaskId": "68c14913-c727-47ce-b376-5f4afd06864b",
"Integration": {
"IntegrationId": "325b1e7d-b4b9-487c-909a-8877d903c0c2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"5629917c-8b72-4e63-a43f-425c555a4ef3": 2.0,
"5645dabf-ea51-40e6-93b9-be1b26ff732f": 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": "3859dffc-adf6-44e3-bce5-3d93f5ccabc1",
"Name": "sample string 1",
"Created": "2026-08-24T05:16:34.1113508+00:00",
"Modified": "2026-08-24T05:16:34.1113508+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0f8b1b14-69a0-44c4-8f16-53af79a89ec5",
"5e293545-e925-41f9-a9ba-bf7248ed04bb"
],
"NonLaborAssignments": [
{
"Id": "9f52780d-de76-4837-9c8b-ab6ca00463e5",
"ResourceId": "05cd76a1-de37-4030-a582-93d259054d1e",
"Quantity": 3.0
},
{
"Id": "9f52780d-de76-4837-9c8b-ab6ca00463e5",
"ResourceId": "05cd76a1-de37-4030-a582-93d259054d1e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "304faa9e-a04a-4911-954f-8df331ba988e",
"Type": 0,
"ResourceId": "7c3b2843-e2ce-477f-a3bd-42311e2411bd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "304faa9e-a04a-4911-954f-8df331ba988e",
"Type": 0,
"ResourceId": "7c3b2843-e2ce-477f-a3bd-42311e2411bd",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "fac28090-894d-413b-9eee-9ce0510ab7d5",
"WorkTypeParentId": "acce6dab-7f0a-4d13-a442-ae0c004dc9f1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "303f77ae-fcea-4229-b456-7849773229f0",
"UPN": "d5e15f91-99f4-4dce-81a8-cdfd3ddc8351",
"PostDate": "2026-08-24T05:16:34.1269608+00:00",
"Comment": "sample string 4",
"CC": [
"2881f295-87bc-403a-8ef4-2eb6415241ec",
"30f7bc3b-be2f-4e72-9f78-16643bf5ab25"
],
"Users": [
"55c1279b-d865-4532-b952-6b575678d3ce",
"10b50046-bbfe-4971-b5ee-6ee9e29a5c3a"
]
},
{
"Id": "303f77ae-fcea-4229-b456-7849773229f0",
"UPN": "d5e15f91-99f4-4dce-81a8-cdfd3ddc8351",
"PostDate": "2026-08-24T05:16:34.1269608+00:00",
"Comment": "sample string 4",
"CC": [
"2881f295-87bc-403a-8ef4-2eb6415241ec",
"30f7bc3b-be2f-4e72-9f78-16643bf5ab25"
],
"Users": [
"55c1279b-d865-4532-b952-6b575678d3ce",
"10b50046-bbfe-4971-b5ee-6ee9e29a5c3a"
]
}
],
"StartDate": "2026-08-24T05:16:34.1269608+00:00",
"DueDate": "2026-08-24T05:16:34.1269608+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2bbfc2d4-c7b1-40cf-a26d-ce2bdc71bee9": "97d07052-feaf-44d6-8e64-8f78e76ed3c2",
"86116e9c-b568-4bf3-a982-7862dbc73dd6": "e2e555dc-b798-4348-80b8-b6d1aa5c5c31"
},
"HasUpdates": true,
"Modified": "2026-08-24T05:16:34.1269608+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-08-24T05:16:34.1269608+00:00"
},
"LastComment": "2026-08-24T05:16:34.1269608+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a951e168-6cb9-4d43-bd5d-0ee550098b38",
"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": "511bd1a7-8ca4-42e3-b108-e7032cd7bd26",
"id": "67153aef-cf93-4a70-ad79-d44f56390ccc",
"ConfigId": "0840a185-96e0-45b7-b721-9aaa4ae634ae"
}