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": "498ed437-95a2-4718-a32c-01ab5afdd047",
"ParentTaskId": "a469d565-efe6-4075-a0c0-417f4d73b477",
"Integration": {
"IntegrationId": "32f42bab-a98a-43d9-90e0-0ed4097fe516",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"01445998-054e-43ed-a765-6ca48de6f376": 2.0,
"c020eafa-b8b0-4209-92dc-d260281fa7f4": 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": "9730cc90-05ee-47e1-b7bc-27041bc5f7be",
"Name": "sample string 1",
"Created": "2026-08-30T03:37:58.8929246+00:00",
"Modified": "2026-08-30T03:37:58.8929246+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"971e5e12-54cf-4461-bc4c-459a3d9bc590",
"ae0dc62b-4bb0-41f6-9a4d-ce837be775ee"
],
"NonLaborAssignments": [
{
"Id": "39eca01f-c6f9-4721-8837-9dd26adef35f",
"ResourceId": "d0d9910b-f914-47df-a5ae-f3d22b316f5e",
"Quantity": 3.0
},
{
"Id": "39eca01f-c6f9-4721-8837-9dd26adef35f",
"ResourceId": "d0d9910b-f914-47df-a5ae-f3d22b316f5e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "379cd45a-040e-4725-b24d-2028261fe6e2",
"Type": 0,
"ResourceId": "ed781d05-bbd0-4262-a1b4-7cfe1d1a140f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6d3f0819-3797-4cf9-9231-87661f5cc510",
"Start": "2026-08-30T03:37:58.8929246+00:00",
"Due": "2026-08-30T03:37:58.8929246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6d3f0819-3797-4cf9-9231-87661f5cc510",
"Start": "2026-08-30T03:37:58.8929246+00:00",
"Due": "2026-08-30T03:37:58.8929246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "379cd45a-040e-4725-b24d-2028261fe6e2",
"Type": 0,
"ResourceId": "ed781d05-bbd0-4262-a1b4-7cfe1d1a140f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6d3f0819-3797-4cf9-9231-87661f5cc510",
"Start": "2026-08-30T03:37:58.8929246+00:00",
"Due": "2026-08-30T03:37:58.8929246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6d3f0819-3797-4cf9-9231-87661f5cc510",
"Start": "2026-08-30T03:37:58.8929246+00:00",
"Due": "2026-08-30T03:37:58.8929246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "9d04b487-a4bb-46cc-84a0-7032b303aa43",
"WorkTypeParentId": "fad2c73a-c407-4a6f-a27f-0bdf36285244",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7d90d2db-db66-4802-830b-404c5620cb02",
"UPN": "8c908ad1-5903-4bcc-81ae-7efbab02f7c7",
"PostDate": "2026-08-30T03:37:58.8929246+00:00",
"Comment": "sample string 4",
"CC": [
"a50d32a2-5110-4143-ac19-30e6c9129ef6",
"375529ac-c66e-4174-afd3-fad308f4469a"
],
"Users": [
"2385f743-ab61-4635-8960-1c030bb8033a",
"e5ecdc35-cb1b-424b-931d-b08be40439cc"
]
},
{
"Id": "7d90d2db-db66-4802-830b-404c5620cb02",
"UPN": "8c908ad1-5903-4bcc-81ae-7efbab02f7c7",
"PostDate": "2026-08-30T03:37:58.8929246+00:00",
"Comment": "sample string 4",
"CC": [
"a50d32a2-5110-4143-ac19-30e6c9129ef6",
"375529ac-c66e-4174-afd3-fad308f4469a"
],
"Users": [
"2385f743-ab61-4635-8960-1c030bb8033a",
"e5ecdc35-cb1b-424b-931d-b08be40439cc"
]
}
],
"StartDate": "2026-08-30T03:37:58.8929246+00:00",
"DueDate": "2026-08-30T03:37:58.8929246+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6bdff00a-a686-40f6-9719-e425c39cc37a": "5616d0c6-eee7-49e3-a0a4-4445e8daccf4",
"c312dc5d-07d3-4894-b0bb-8c1ca7371d99": "b8d033dd-da63-42c1-8b67-a892333f1e03"
},
"HasUpdates": true,
"Modified": "2026-08-30T03:37:58.8929246+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-30T03:37:58.8929246+00:00"
},
"LastComment": "2026-08-30T03:37:58.8929246+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ba101791-e862-4935-800f-197b262b8799",
"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": "df7c03e8-abe3-4b1a-84c0-b82359c21975",
"id": "a1894034-18fe-4ab2-a83e-9dba736d470d",
"ConfigId": "95d93874-8960-4088-b853-8ac0a04c6048"
}