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": "d678b916-fd01-46e9-b615-be3cc84a0bca",
"ParentTaskId": "6662d2c1-3a36-49a1-927c-f046e73b39b7",
"Integration": {
"IntegrationId": "c5ad963c-ace2-4e83-a45d-857835e78a13",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ba9015e9-b891-4d89-9164-b99a6f142a96": 2.0,
"8a2ef6db-ee37-4635-b2e8-ed889ec1d269": 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": "59d9feb0-0339-471b-be56-e15930207f49",
"Name": "sample string 1",
"Created": "2026-09-29T17:54:08.5669738+00:00",
"Modified": "2026-09-29T17:54:08.5669738+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"55f76bf7-4c22-436c-8907-386960ff3974",
"b4873890-7ef7-4af6-a371-deb452b19168"
],
"NonLaborAssignments": [
{
"Id": "8f56466d-e26a-4057-bb67-870d4398038d",
"ResourceId": "aad9626e-0347-40b7-8743-f312f0e8ea59",
"Quantity": 3.0
},
{
"Id": "8f56466d-e26a-4057-bb67-870d4398038d",
"ResourceId": "aad9626e-0347-40b7-8743-f312f0e8ea59",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b92a3411-5cec-4c71-8ac1-0642df599bf6",
"Type": 0,
"ResourceId": "ba46904d-58b5-44d4-a5ab-c6cd57b5ef4d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "53e2bdcd-0120-4430-bc4d-197cadc562f6",
"Start": "2026-09-29T17:54:08.5669738+00:00",
"Due": "2026-09-29T17:54:08.5669738+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "53e2bdcd-0120-4430-bc4d-197cadc562f6",
"Start": "2026-09-29T17:54:08.5669738+00:00",
"Due": "2026-09-29T17:54:08.5669738+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "b92a3411-5cec-4c71-8ac1-0642df599bf6",
"Type": 0,
"ResourceId": "ba46904d-58b5-44d4-a5ab-c6cd57b5ef4d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "53e2bdcd-0120-4430-bc4d-197cadc562f6",
"Start": "2026-09-29T17:54:08.5669738+00:00",
"Due": "2026-09-29T17:54:08.5669738+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "53e2bdcd-0120-4430-bc4d-197cadc562f6",
"Start": "2026-09-29T17:54:08.5669738+00:00",
"Due": "2026-09-29T17:54:08.5669738+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "897ba78b-41cd-4126-9bf3-cfeb8eeb9ab7",
"WorkTypeParentId": "8b107484-fe71-4dcc-96da-d7fa0b63beeb",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8c708bc1-0a3b-476b-bbc7-8fe9d514bb3e",
"UPN": "4f9cdf13-3439-4de2-8cd2-24d080cf6648",
"PostDate": "2026-09-29T17:54:08.5669738+00:00",
"Comment": "sample string 4",
"CC": [
"55fbeab6-8c5a-4584-a4a8-ca995604f5f0",
"17ecbf80-ecef-41d5-a411-b8c3d4085b0b"
],
"Users": [
"4ff1d682-7b05-44eb-bfca-7f6397b8a540",
"5371ba4a-eb2c-44e7-858f-17adf5207453"
]
},
{
"Id": "8c708bc1-0a3b-476b-bbc7-8fe9d514bb3e",
"UPN": "4f9cdf13-3439-4de2-8cd2-24d080cf6648",
"PostDate": "2026-09-29T17:54:08.5669738+00:00",
"Comment": "sample string 4",
"CC": [
"55fbeab6-8c5a-4584-a4a8-ca995604f5f0",
"17ecbf80-ecef-41d5-a411-b8c3d4085b0b"
],
"Users": [
"4ff1d682-7b05-44eb-bfca-7f6397b8a540",
"5371ba4a-eb2c-44e7-858f-17adf5207453"
]
}
],
"StartDate": "2026-09-29T17:54:08.5669738+00:00",
"DueDate": "2026-09-29T17:54:08.5669738+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4003c2d7-4688-481a-a87e-c52ccaa4fa69": "71c5889c-f893-43eb-abad-37473350bd6d",
"4b6595a4-b346-47f3-abf6-c7a532f2b40b": "189830f6-0140-4d19-8fa3-7394b8e2dcfd"
},
"HasUpdates": true,
"Modified": "2026-09-29T17:54:08.5669738+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-29T17:54:08.5669738+00:00"
},
"LastComment": "2026-09-29T17:54:08.5669738+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "170dca61-56e0-4321-a1e5-3ae0d004f198",
"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": "b630c3dd-f988-4104-b41b-455c9ab6968c",
"id": "d78d3e68-72d2-42b3-a34a-d23f77e2af74",
"ConfigId": "64f3a6cb-1cc6-4d76-a656-d7d2b5e3e85d"
}