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": "456dd4a4-cf4c-4dd6-8335-50eced8994ce",
"ParentTaskId": "d5aca035-426f-4eb9-83e8-82383973ba2c",
"Integration": {
"IntegrationId": "9fe8c570-649b-45f1-bdec-e703361c8a31",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1308c63e-8086-4060-aff7-976c5fd6d026": 2.0,
"fb67f96c-d8c5-4304-aff2-5491c2ffa728": 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": "5b2fde65-01e3-432c-8493-fbd50aa06ec8",
"Name": "sample string 1",
"Created": "2026-09-23T01:28:08.0133257+00:00",
"Modified": "2026-09-23T01:28:08.0133257+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"df94e548-26b8-4f4b-98df-822e0d632992",
"f7e9762a-8ac3-498e-aa73-00fa05bb408a"
],
"NonLaborAssignments": [
{
"Id": "a05d3b39-267b-4616-b8a1-8e9bf0e89c47",
"ResourceId": "5a0670b9-f25e-4d38-8ac3-acd7a17f7c4b",
"Quantity": 3.0
},
{
"Id": "a05d3b39-267b-4616-b8a1-8e9bf0e89c47",
"ResourceId": "5a0670b9-f25e-4d38-8ac3-acd7a17f7c4b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "cf47ac9a-5b7f-4228-8992-03007c7e3335",
"Type": 0,
"ResourceId": "29f4e5bd-2b82-49b2-abd0-2b9305a084da",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "16dc4699-3d29-44e1-ae75-65a1652b8015",
"Start": "2026-09-23T01:28:08.0133257+00:00",
"Due": "2026-09-23T01:28:08.0133257+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "16dc4699-3d29-44e1-ae75-65a1652b8015",
"Start": "2026-09-23T01:28:08.0133257+00:00",
"Due": "2026-09-23T01:28:08.0133257+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "cf47ac9a-5b7f-4228-8992-03007c7e3335",
"Type": 0,
"ResourceId": "29f4e5bd-2b82-49b2-abd0-2b9305a084da",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "16dc4699-3d29-44e1-ae75-65a1652b8015",
"Start": "2026-09-23T01:28:08.0133257+00:00",
"Due": "2026-09-23T01:28:08.0133257+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "16dc4699-3d29-44e1-ae75-65a1652b8015",
"Start": "2026-09-23T01:28:08.0133257+00:00",
"Due": "2026-09-23T01:28:08.0133257+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "5df6c9d6-5eed-4752-833a-b87bb392c7f5",
"WorkTypeParentId": "71510444-7b16-4bd7-89dc-7d13261ad22c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "acd990cf-5ae3-4728-9f30-0a8d1e1aac8b",
"UPN": "1d7504aa-6f6c-4dc2-a3e4-c59ac3ede780",
"PostDate": "2026-09-23T01:28:08.0133257+00:00",
"Comment": "sample string 4",
"CC": [
"9c823c59-0fbb-4687-8264-4e522c2ec782",
"2189c147-365e-425d-a583-c3c541362bb7"
],
"Users": [
"9cfb3320-33a2-4ded-aa1f-347fa29fa2e1",
"883a3740-6001-40da-87f3-5874857df6d3"
]
},
{
"Id": "acd990cf-5ae3-4728-9f30-0a8d1e1aac8b",
"UPN": "1d7504aa-6f6c-4dc2-a3e4-c59ac3ede780",
"PostDate": "2026-09-23T01:28:08.0133257+00:00",
"Comment": "sample string 4",
"CC": [
"9c823c59-0fbb-4687-8264-4e522c2ec782",
"2189c147-365e-425d-a583-c3c541362bb7"
],
"Users": [
"9cfb3320-33a2-4ded-aa1f-347fa29fa2e1",
"883a3740-6001-40da-87f3-5874857df6d3"
]
}
],
"StartDate": "2026-09-23T01:28:08.0133257+00:00",
"DueDate": "2026-09-23T01:28:08.0133257+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0965e8cf-3fe6-4d6b-8284-8f807d49633a": "431fcdc0-05de-4475-a373-9fa4c1cd55ff",
"892965aa-6686-463f-91d5-0055677cf0e2": "dba5ded8-9194-429d-b655-e830890e8562"
},
"HasUpdates": true,
"Modified": "2026-09-23T01:28:08.0133257+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-23T01:28:08.0133257+00:00"
},
"LastComment": "2026-09-23T01:28:08.0133257+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "71259ce1-b815-4967-bce0-836e94f02c03",
"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": "b1667d5d-beac-4c1a-b0bb-a3543a3d5c76",
"id": "8e81c7b2-0110-4c86-8842-c1353e309faa",
"ConfigId": "296c75ad-3a86-43d9-a612-11737b7d397e"
}