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": "54eeda7c-afe7-4d5e-85fe-8e687121e847",
"ParentTaskId": "68b82379-f772-4416-a536-df261428815d",
"Integration": {
"IntegrationId": "c260fe69-557c-4512-9a19-37ed1e93a811",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"84c8b3f7-69f7-4d3b-b2a5-b0a4cc39273c": 2.0,
"8e0a1a1b-3251-4bd3-a370-790352b59168": 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": "00cf3787-5547-4217-a9c8-ea5128ed2832",
"Name": "sample string 1",
"Created": "2026-09-15T19:38:20.2857952+00:00",
"Modified": "2026-09-15T19:38:20.2857952+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e4051914-a8cb-43dd-9d3a-e8d99c0499d9",
"46f345b2-c00d-46f4-8693-5431a5b8af6e"
],
"NonLaborAssignments": [
{
"Id": "1b4b137f-0728-4bf7-b995-f09356575f60",
"ResourceId": "50a2af3c-bae4-450b-9b71-616b8b4e3d8d",
"Quantity": 3.0
},
{
"Id": "1b4b137f-0728-4bf7-b995-f09356575f60",
"ResourceId": "50a2af3c-bae4-450b-9b71-616b8b4e3d8d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "87b1e02e-9b29-427a-aa0b-80aa0de18568",
"Type": 0,
"ResourceId": "fce029d1-13d0-47f3-bb47-dd58e36237b6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "61b70edc-7f3b-4c49-bbbc-ff0511c82549",
"Start": "2026-09-15T19:38:20.2857952+00:00",
"Due": "2026-09-15T19:38:20.2857952+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "61b70edc-7f3b-4c49-bbbc-ff0511c82549",
"Start": "2026-09-15T19:38:20.2857952+00:00",
"Due": "2026-09-15T19:38:20.2857952+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "87b1e02e-9b29-427a-aa0b-80aa0de18568",
"Type": 0,
"ResourceId": "fce029d1-13d0-47f3-bb47-dd58e36237b6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "61b70edc-7f3b-4c49-bbbc-ff0511c82549",
"Start": "2026-09-15T19:38:20.2857952+00:00",
"Due": "2026-09-15T19:38:20.2857952+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "61b70edc-7f3b-4c49-bbbc-ff0511c82549",
"Start": "2026-09-15T19:38:20.2857952+00:00",
"Due": "2026-09-15T19:38:20.2857952+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "266b3a11-2db4-4fa2-bf27-8cfeb6c29f78",
"WorkTypeParentId": "315409a1-24cc-426d-bb71-d2bbf2a1fb45",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6603b1f8-3ec8-433c-9523-484215f5031b",
"UPN": "9186c873-9cb4-4129-842e-a133bdfdca84",
"PostDate": "2026-09-15T19:38:20.3014123+00:00",
"Comment": "sample string 4",
"CC": [
"9ee16539-163d-44c9-afae-7384071c102f",
"d46b1a2c-6a67-41c6-9358-14d3d1b32a8e"
],
"Users": [
"71eb1db2-3ee4-4e3a-929e-ec64663eb903",
"7282444c-4649-47ab-8133-8f9602b8222f"
]
},
{
"Id": "6603b1f8-3ec8-433c-9523-484215f5031b",
"UPN": "9186c873-9cb4-4129-842e-a133bdfdca84",
"PostDate": "2026-09-15T19:38:20.3014123+00:00",
"Comment": "sample string 4",
"CC": [
"9ee16539-163d-44c9-afae-7384071c102f",
"d46b1a2c-6a67-41c6-9358-14d3d1b32a8e"
],
"Users": [
"71eb1db2-3ee4-4e3a-929e-ec64663eb903",
"7282444c-4649-47ab-8133-8f9602b8222f"
]
}
],
"StartDate": "2026-09-15T19:38:20.3014123+00:00",
"DueDate": "2026-09-15T19:38:20.3014123+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"62e5ff53-43c5-4245-97c5-ea7c52a087ff": "96bc1489-e3af-4d43-a8a6-c294c4c5185b",
"28d220cc-2904-49df-98d0-55940c6fbdff": "c683abcb-3495-4265-8d48-b87d74712960"
},
"HasUpdates": true,
"Modified": "2026-09-15T19:38:20.3014123+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-15T19:38:20.3014123+00:00"
},
"LastComment": "2026-09-15T19:38:20.3014123+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "950e2aa6-9c3d-4c9e-88dc-edaba8d9f7cd",
"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": "ec7e20b8-39ab-4ca2-9cd2-8944551f7567",
"id": "31a1c65b-cad9-481d-aac1-98243b4cbcdf",
"ConfigId": "02c4083d-abee-416d-9fd5-8f7d2fd45190"
}