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": "4a6d7e9e-a8d3-40dd-bbb2-2f3f92d1eeb9",
"ParentTaskId": "0a5b79d7-4797-4cc7-b606-e64b5df24cae",
"Integration": {
"IntegrationId": "be31575f-67a7-47af-889c-40ad39966807",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e807fe15-d726-4983-ab81-ca72a703c401": 2.0,
"ddcc81a6-45e8-47a0-bd09-c832adb9ab9b": 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": "3221a237-15cb-4ff9-97e2-113888b0e6b3",
"Name": "sample string 1",
"Created": "2026-09-08T20:02:19.5729434+00:00",
"Modified": "2026-09-08T20:02:19.5729434+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"6b169403-a13e-4ad9-adb7-8f73ba810616",
"3ef880c2-3bb6-4202-a3a4-e080024d772e"
],
"NonLaborAssignments": [
{
"Id": "3b44bbe8-467a-4e8e-9d08-a6fd1374ebf6",
"ResourceId": "71e5f146-d4ff-4ae6-9016-d59dc15d408d",
"Quantity": 3.0
},
{
"Id": "3b44bbe8-467a-4e8e-9d08-a6fd1374ebf6",
"ResourceId": "71e5f146-d4ff-4ae6-9016-d59dc15d408d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "fe799e30-3b06-4fc3-91e6-3b3c3ecf6c57",
"Type": 0,
"ResourceId": "b7bab5fe-9c9b-4e6d-b6f4-738f96ca35a6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "77c0c444-c7d0-44ba-a00a-f5e007518657",
"Start": "2026-09-08T20:02:19.5729434+00:00",
"Due": "2026-09-08T20:02:19.5729434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "77c0c444-c7d0-44ba-a00a-f5e007518657",
"Start": "2026-09-08T20:02:19.5729434+00:00",
"Due": "2026-09-08T20:02:19.5729434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "fe799e30-3b06-4fc3-91e6-3b3c3ecf6c57",
"Type": 0,
"ResourceId": "b7bab5fe-9c9b-4e6d-b6f4-738f96ca35a6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "77c0c444-c7d0-44ba-a00a-f5e007518657",
"Start": "2026-09-08T20:02:19.5729434+00:00",
"Due": "2026-09-08T20:02:19.5729434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "77c0c444-c7d0-44ba-a00a-f5e007518657",
"Start": "2026-09-08T20:02:19.5729434+00:00",
"Due": "2026-09-08T20:02:19.5729434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "718e65ce-a8b8-4863-ba64-1a33ca4d04b2",
"WorkTypeParentId": "765caf14-3f32-4ce8-a3f3-7328ee4a3f7d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b8260311-f509-41f6-b4c2-9951dd0a17a6",
"UPN": "5d527d63-ba5a-48c4-b607-f88a60a7d5c6",
"PostDate": "2026-09-08T20:02:19.5729434+00:00",
"Comment": "sample string 4",
"CC": [
"161c6836-0dd6-46d9-a776-91b762a35368",
"8c7593c4-79ca-4800-ac41-212657294ef5"
],
"Users": [
"a05abbda-e337-4ca3-889d-eb1fd0a8b208",
"5c86831f-60d5-4aa0-8cac-a6e6c120c6ba"
]
},
{
"Id": "b8260311-f509-41f6-b4c2-9951dd0a17a6",
"UPN": "5d527d63-ba5a-48c4-b607-f88a60a7d5c6",
"PostDate": "2026-09-08T20:02:19.5729434+00:00",
"Comment": "sample string 4",
"CC": [
"161c6836-0dd6-46d9-a776-91b762a35368",
"8c7593c4-79ca-4800-ac41-212657294ef5"
],
"Users": [
"a05abbda-e337-4ca3-889d-eb1fd0a8b208",
"5c86831f-60d5-4aa0-8cac-a6e6c120c6ba"
]
}
],
"StartDate": "2026-09-08T20:02:19.5729434+00:00",
"DueDate": "2026-09-08T20:02:19.5729434+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"24a80698-9012-414f-b1c3-dd3478626a65": "677dbad6-6fef-40d3-b3ed-b420ebd604b5",
"59aa5911-70a8-46ec-a838-0c1dbde73249": "40750504-c692-4bd9-9a3e-94ffdc043f3a"
},
"HasUpdates": true,
"Modified": "2026-09-08T20:02:19.5729434+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-09-08T20:02:19.5729434+00:00"
},
"LastComment": "2026-09-08T20:02:19.5729434+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5f115811-b6e7-402b-9421-bc2940bd4e49",
"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": "6e591168-2aa5-48a8-a63c-6682950a0bf8",
"id": "822895cb-1ea0-4ccf-948a-b6a9347ea308",
"ConfigId": "b25e21ff-b9cd-4464-995b-a46145c29bfb"
}