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": "32c36a7b-2cbb-4901-b0e0-de2058bd5e29",
"ParentTaskId": "a6f121a5-d1d5-4e6a-8797-64c53a13650c",
"Integration": {
"IntegrationId": "1e17f9ec-82e5-4e89-8634-b7b6d472977c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2aaf5c6a-298b-480d-962e-c45c42e2fc2e": 2.0,
"055d409d-422c-48d2-aa28-46adf8e32c54": 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": "c06b48ef-eede-4303-971a-2bf4b80ae285",
"Name": "sample string 1",
"Created": "2026-06-25T01:29:50.4064643+00:00",
"Modified": "2026-06-25T01:29:50.4064643+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d730b42e-fb70-428e-9979-9c75f5a098f5",
"98ae0d45-725c-4c47-832e-6e397e1ad396"
],
"NonLaborAssignments": [
{
"Id": "d38cc9a8-67e3-411d-9724-328fea46ad22",
"ResourceId": "3fc11931-edf7-4d06-88a2-5ba05e365188",
"Quantity": 3.0
},
{
"Id": "d38cc9a8-67e3-411d-9724-328fea46ad22",
"ResourceId": "3fc11931-edf7-4d06-88a2-5ba05e365188",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e56099aa-4c6c-46d5-9dde-e9c463f43c0f",
"Type": 0,
"ResourceId": "7141222b-d198-4c92-8790-3ce5f8ec638d",
"Units": 3.0
},
{
"Id": "e56099aa-4c6c-46d5-9dde-e9c463f43c0f",
"Type": 0,
"ResourceId": "7141222b-d198-4c92-8790-3ce5f8ec638d",
"Units": 3.0
}
],
"ParentId": "cc0159be-6897-44ff-baf7-9a161d6422b3",
"WorkTypeParentId": "4d159f67-907e-4576-b73d-e8433a2eb506",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "de8ca2f1-1d1e-4fa9-ba08-8b72751ef687",
"UPN": "382ea83d-9f16-40c3-839a-200b07b80409",
"PostDate": "2026-06-25T01:29:50.4064643+00:00",
"Comment": "sample string 4",
"CC": [
"d6e78e74-c756-479f-9265-749d68cd79fa",
"33377afa-fdd0-461f-8983-8e0d36d36c97"
],
"Users": [
"5c7b84fb-4d06-4b5f-9e2e-59c14a930c1c",
"33884f60-bc64-4fd7-8cdc-29c82f226fd3"
]
},
{
"Id": "de8ca2f1-1d1e-4fa9-ba08-8b72751ef687",
"UPN": "382ea83d-9f16-40c3-839a-200b07b80409",
"PostDate": "2026-06-25T01:29:50.4064643+00:00",
"Comment": "sample string 4",
"CC": [
"d6e78e74-c756-479f-9265-749d68cd79fa",
"33377afa-fdd0-461f-8983-8e0d36d36c97"
],
"Users": [
"5c7b84fb-4d06-4b5f-9e2e-59c14a930c1c",
"33884f60-bc64-4fd7-8cdc-29c82f226fd3"
]
}
],
"StartDate": "2026-06-25T01:29:50.4064643+00:00",
"DueDate": "2026-06-25T01:29:50.4064643+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"8328d706-1ea0-4a87-b4ab-4a7b2e525c40": "f5c6ff96-138b-4976-bef4-9a3ee47edee1",
"e294d10f-717e-44bc-a65e-f1ddc9ba8cdb": "11eb3e53-4efd-484f-8dcf-ae9f31083fb2"
},
"HasUpdates": true,
"Modified": "2026-06-25T01:29:50.4064643+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-06-25T01:29:50.4064643+00:00"
},
"LastComment": "2026-06-25T01:29:50.4220914+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f7f86e20-fd81-4461-9e9e-15ab14783fe2",
"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": "72ed1bb9-9eb9-49eb-afbc-529f9d2b237a",
"id": "54037f7d-4fd3-4d33-9510-fc349d41376c",
"ConfigId": "e5a4dd86-e760-40b9-86c5-a7459734cbf4"
}