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": "15ad11b2-568f-4230-a988-5501f18b5e0a",
"ParentTaskId": "f315a94c-d33c-4b4b-87de-95c65ee6efad",
"Integration": {
"IntegrationId": "60c914b2-38f1-486f-90dd-55339e2262d5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"aebc20ec-b27f-4eda-a016-906eee0a990f": 2.0,
"a51fcd36-f993-49cb-94bf-fdb03156483d": 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": "5443cc9b-279e-4583-ab88-52835efd2fa2",
"Name": "sample string 1",
"Created": "2026-09-05T11:54:22.6405519+00:00",
"Modified": "2026-09-05T11:54:22.6405519+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"43b0c85c-a53d-431a-b915-80a6eaa85f95",
"36186ac3-4525-40e1-ab3c-3ae78a5fe89d"
],
"NonLaborAssignments": [
{
"Id": "3f5e3f32-93d5-4d3c-84e6-562813643ff5",
"ResourceId": "a9affed5-1304-4647-aa21-718ea70bd643",
"Quantity": 3.0
},
{
"Id": "3f5e3f32-93d5-4d3c-84e6-562813643ff5",
"ResourceId": "a9affed5-1304-4647-aa21-718ea70bd643",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9008e742-5231-44a6-a89e-be9999083819",
"Type": 0,
"ResourceId": "850b6bff-18a6-47b1-87e3-1220bbd7eed7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "901534cb-30f0-4ae9-aaf9-632a4ce691b2",
"Start": "2026-09-05T11:54:22.6405519+00:00",
"Due": "2026-09-05T11:54:22.6405519+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "901534cb-30f0-4ae9-aaf9-632a4ce691b2",
"Start": "2026-09-05T11:54:22.6405519+00:00",
"Due": "2026-09-05T11:54:22.6405519+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "9008e742-5231-44a6-a89e-be9999083819",
"Type": 0,
"ResourceId": "850b6bff-18a6-47b1-87e3-1220bbd7eed7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "901534cb-30f0-4ae9-aaf9-632a4ce691b2",
"Start": "2026-09-05T11:54:22.6405519+00:00",
"Due": "2026-09-05T11:54:22.6405519+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "901534cb-30f0-4ae9-aaf9-632a4ce691b2",
"Start": "2026-09-05T11:54:22.6405519+00:00",
"Due": "2026-09-05T11:54:22.6405519+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "a8fcf379-d164-44d1-8408-2491da17c3f6",
"WorkTypeParentId": "eb941b5a-29db-4534-b055-32cd5a67465e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "70146faa-f74e-4cc2-8c93-396a5f8784d2",
"UPN": "2a9f4c3f-666c-497b-8c44-3ad62775a956",
"PostDate": "2026-09-05T11:54:22.6405519+00:00",
"Comment": "sample string 4",
"CC": [
"a02f5bac-1588-410a-87a6-63abf3fcc6f9",
"f6235aef-d849-4218-8b49-ff0cc0e15d41"
],
"Users": [
"e7669592-094e-46a0-9588-4d6dc1a6a186",
"ed62babf-d80e-4f03-a0e4-df10a4f2613d"
]
},
{
"Id": "70146faa-f74e-4cc2-8c93-396a5f8784d2",
"UPN": "2a9f4c3f-666c-497b-8c44-3ad62775a956",
"PostDate": "2026-09-05T11:54:22.6405519+00:00",
"Comment": "sample string 4",
"CC": [
"a02f5bac-1588-410a-87a6-63abf3fcc6f9",
"f6235aef-d849-4218-8b49-ff0cc0e15d41"
],
"Users": [
"e7669592-094e-46a0-9588-4d6dc1a6a186",
"ed62babf-d80e-4f03-a0e4-df10a4f2613d"
]
}
],
"StartDate": "2026-09-05T11:54:22.6405519+00:00",
"DueDate": "2026-09-05T11:54:22.6405519+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b1da1d4b-a3a4-4d1c-85ee-9c710bfa65d5": "dfe3bf33-5a80-4e48-a051-c4cf3daff9b4",
"2b1b11b4-1dd6-4902-bdd1-b99172c0ee2d": "b6161cee-87f3-41d7-bb78-e87e546ebe87"
},
"HasUpdates": true,
"Modified": "2026-09-05T11:54:22.6405519+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-05T11:54:22.6405519+00:00"
},
"LastComment": "2026-09-05T11:54:22.6405519+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f150baf7-a78d-4e39-95bb-67064ee2d7e4",
"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": "dd9b4bdf-0ab7-451b-b36d-49c42505d947",
"id": "148a1886-7627-4f53-b42a-33a145bd84ee",
"ConfigId": "d3a9437d-aff5-4488-be3d-390be92ab91c"
}