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": "3fada086-241f-4905-bd05-9a45a412ad55",
"ParentTaskId": "dc413455-8a94-490d-9357-f36e8494ab1f",
"Integration": {
"IntegrationId": "d0126bee-2112-4139-aeaa-f9013248446a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"8028dfa8-570c-4d74-b538-b473c2e28a66": 2.0,
"8f470afb-2f6a-4929-8b3d-03616afcd3b8": 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": "fef431d4-6d0b-4ba1-ad5b-f0292d77df01",
"Name": "sample string 1",
"Created": "2026-04-30T02:37:41.9990346+00:00",
"Modified": "2026-04-30T02:37:41.9990346+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"17d06800-ba62-48f1-bfc8-ff2eaa51cbc9",
"046d9b91-22cd-48e0-a5ca-e9f185b6bdaa"
],
"NonLaborAssignments": [
{
"Id": "e3480a81-4edf-4860-b243-941c99124ade",
"ResourceId": "4238fcce-5879-454b-b835-1d876fe955b0",
"Quantity": 3.0
},
{
"Id": "e3480a81-4edf-4860-b243-941c99124ade",
"ResourceId": "4238fcce-5879-454b-b835-1d876fe955b0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b5984fa1-7814-40d7-ad7d-c16ba38b8d48",
"Type": 0,
"ResourceId": "1df27c94-49fb-47af-91d0-3b252df2553d",
"Units": 3.0
},
{
"Id": "b5984fa1-7814-40d7-ad7d-c16ba38b8d48",
"Type": 0,
"ResourceId": "1df27c94-49fb-47af-91d0-3b252df2553d",
"Units": 3.0
}
],
"ParentId": "2908f7fc-2e07-4989-b9b6-2660546bae80",
"WorkTypeParentId": "c251cb33-5ee4-4e30-adbe-20d5319ff491",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ea14a015-42be-4dd6-90bd-e14c8a69e089",
"UPN": "1bd7544f-5888-434a-862e-a71d32f2d979",
"PostDate": "2026-04-30T02:37:41.9990346+00:00",
"Comment": "sample string 4",
"CC": [
"59cdcd87-7646-4d17-ac80-cb4cc2e6ee40",
"6e82f17c-5922-42dd-b9cd-56f494111921"
],
"Users": [
"c5a32ce1-35b7-4856-80a8-dead46fe1a28",
"5959376d-a964-4166-a010-65180ee08ebf"
]
},
{
"Id": "ea14a015-42be-4dd6-90bd-e14c8a69e089",
"UPN": "1bd7544f-5888-434a-862e-a71d32f2d979",
"PostDate": "2026-04-30T02:37:41.9990346+00:00",
"Comment": "sample string 4",
"CC": [
"59cdcd87-7646-4d17-ac80-cb4cc2e6ee40",
"6e82f17c-5922-42dd-b9cd-56f494111921"
],
"Users": [
"c5a32ce1-35b7-4856-80a8-dead46fe1a28",
"5959376d-a964-4166-a010-65180ee08ebf"
]
}
],
"StartDate": "2026-04-30T02:37:41.9990346+00:00",
"DueDate": "2026-04-30T02:37:41.9990346+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e4e2274f-dfcc-4597-9b26-33e1b76667fc": "2e16374f-37be-4760-808e-5f24d0056208",
"78318ccb-c409-4057-bfff-8b0405d2e2a0": "140c48a1-4b03-4d0d-8e21-789b4bffbd1a"
},
"HasUpdates": true,
"Modified": "2026-04-30T02:37:41.9990346+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-04-30T02:37:41.9990346+00:00"
},
"LastComment": "2026-04-30T02:37:41.9990346+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0373abb0-e107-4ac9-b092-ac2a7a557a60",
"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": "81e85b94-1839-47fe-8ea5-24f45c41c7d8",
"id": "b339b62c-5215-4f50-bd46-e8cf98752b71",
"ConfigId": "1d989f9f-e71c-4da6-8eb0-ccb0faf00ac1"
}