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": "e3fb4ea6-76d1-4711-bd5a-18008ec9c27e",
"ParentTaskId": "944c5b7e-edd3-4f27-8ecb-58b156f23fcd",
"Integration": {
"IntegrationId": "749e6fbd-87fd-4ee7-8e73-a4205072ca23",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"db71da7a-6651-4770-bb34-2902bfa10da8": 2.0,
"228eb870-1aa1-4890-8fd7-63de6728856c": 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": "8b61e2e4-697b-4358-aefa-afcfb875d8c8",
"Name": "sample string 1",
"Created": "2026-06-17T01:32:25.1896403+00:00",
"Modified": "2026-06-17T01:32:25.1896403+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"a66b61e2-1fc6-4ae1-a05e-41ee943d122a",
"354f3e5e-23d9-4620-b509-57a964eddb05"
],
"NonLaborAssignments": [
{
"Id": "25287b3c-2d81-4323-95d1-8986bed1b7c0",
"ResourceId": "f947f63e-ab45-4075-97be-a8f27038e717",
"Quantity": 3.0
},
{
"Id": "25287b3c-2d81-4323-95d1-8986bed1b7c0",
"ResourceId": "f947f63e-ab45-4075-97be-a8f27038e717",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6a6c5bc6-6aba-4a01-aaa6-42e08060726a",
"Type": 0,
"ResourceId": "bc799569-3616-44bc-a652-f99a4615f6c2",
"Units": 3.0
},
{
"Id": "6a6c5bc6-6aba-4a01-aaa6-42e08060726a",
"Type": 0,
"ResourceId": "bc799569-3616-44bc-a652-f99a4615f6c2",
"Units": 3.0
}
],
"ParentId": "e846d6aa-f30d-4d2c-a5f5-a65d688cc52d",
"WorkTypeParentId": "3f9f840a-e9f3-49e2-a8f6-b08ec90e9ce0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3afe1ec3-93d2-482d-99a7-0abb59d7d724",
"UPN": "719d4d35-dbdc-415d-8883-4f6fcd11c204",
"PostDate": "2026-06-17T01:32:25.1896403+00:00",
"Comment": "sample string 4",
"CC": [
"10e1f981-4837-47d5-901a-dfbb45f30728",
"253de3a6-1c0c-4398-af91-9dcf4a5cc5bb"
],
"Users": [
"d987fac2-cb8c-4450-acc4-c07c2c634d08",
"5f4dafde-787f-4a4b-905d-bc42533fc7b9"
]
},
{
"Id": "3afe1ec3-93d2-482d-99a7-0abb59d7d724",
"UPN": "719d4d35-dbdc-415d-8883-4f6fcd11c204",
"PostDate": "2026-06-17T01:32:25.1896403+00:00",
"Comment": "sample string 4",
"CC": [
"10e1f981-4837-47d5-901a-dfbb45f30728",
"253de3a6-1c0c-4398-af91-9dcf4a5cc5bb"
],
"Users": [
"d987fac2-cb8c-4450-acc4-c07c2c634d08",
"5f4dafde-787f-4a4b-905d-bc42533fc7b9"
]
}
],
"StartDate": "2026-06-17T01:32:25.1896403+00:00",
"DueDate": "2026-06-17T01:32:25.1896403+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9f52aa80-c17a-496e-a6ed-1f37fc2fb3ef": "260f2c78-abb1-4e07-8748-d427c03faef2",
"b23b732d-d3d4-4f45-bbae-2a63317c63b5": "30a282ee-bac7-42a2-9d06-23b10f231507"
},
"HasUpdates": true,
"Modified": "2026-06-17T01:32:25.1896403+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-17T01:32:25.1896403+00:00"
},
"LastComment": "2026-06-17T01:32:25.1896403+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "86f6b6dc-892f-4b65-91cc-2adb641d784a",
"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": "d128ea83-d3eb-47c2-8335-3c84fd461744",
"id": "59cb6604-1759-4e0f-8fbc-8e41f51ea2f6",
"ConfigId": "170e6aba-0454-4386-b968-105262d1986e"
}