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": "28f911b8-c1f8-4375-bdb0-20cac1517bc6",
"ParentTaskId": "d875d89c-62f0-4ec6-ab46-1f41ac3de8c8",
"Integration": {
"IntegrationId": "012c0772-f213-4597-a1a7-bab575880a90",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d08481a2-2a7c-43c0-8ef1-6480ad6e1958": 2.0,
"0cebd183-ab7c-4be0-84ee-becbf9451eb9": 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": "18694c08-1fed-4701-ad8a-4622e3eb58b3",
"Name": "sample string 1",
"Created": "2026-05-27T10:27:45.2114936+00:00",
"Modified": "2026-05-27T10:27:45.2114936+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"903c0bfc-b052-4bc5-8008-9c05c2f0ad35",
"9767b648-6454-41b4-8042-2368ff07557e"
],
"NonLaborAssignments": [
{
"Id": "e504c904-cbf6-4b31-8b93-1e50522a78b3",
"ResourceId": "28798de3-854b-40ad-b2ec-bdb0818fc286",
"Quantity": 3.0
},
{
"Id": "e504c904-cbf6-4b31-8b93-1e50522a78b3",
"ResourceId": "28798de3-854b-40ad-b2ec-bdb0818fc286",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8d8e15cb-f2a8-4006-b074-cb7283e3e4f4",
"Type": 0,
"ResourceId": "72c81700-9395-452e-aab5-bccef23f2d8a",
"Units": 3.0
},
{
"Id": "8d8e15cb-f2a8-4006-b074-cb7283e3e4f4",
"Type": 0,
"ResourceId": "72c81700-9395-452e-aab5-bccef23f2d8a",
"Units": 3.0
}
],
"ParentId": "f37552c3-5585-4e3b-8e22-26cda216fac2",
"WorkTypeParentId": "e7d60f44-a28a-4c5d-a792-2f614390b51a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bb47ba55-0fa6-42ba-82f6-aee8b538cab5",
"UPN": "5a546dce-a62b-4aa6-b7d1-ae6e428aa651",
"PostDate": "2026-05-27T10:27:45.2114936+00:00",
"Comment": "sample string 4",
"CC": [
"2f62e614-e7e4-4130-bbc4-285bd0088134",
"3925f57e-ec51-49e2-90a4-e7ad6ed10e70"
],
"Users": [
"5ea178ea-216b-4df6-b644-29859efb4b9c",
"01cfd388-f92c-4d5c-9a62-5ba6a8ea218b"
]
},
{
"Id": "bb47ba55-0fa6-42ba-82f6-aee8b538cab5",
"UPN": "5a546dce-a62b-4aa6-b7d1-ae6e428aa651",
"PostDate": "2026-05-27T10:27:45.2114936+00:00",
"Comment": "sample string 4",
"CC": [
"2f62e614-e7e4-4130-bbc4-285bd0088134",
"3925f57e-ec51-49e2-90a4-e7ad6ed10e70"
],
"Users": [
"5ea178ea-216b-4df6-b644-29859efb4b9c",
"01cfd388-f92c-4d5c-9a62-5ba6a8ea218b"
]
}
],
"StartDate": "2026-05-27T10:27:45.2114936+00:00",
"DueDate": "2026-05-27T10:27:45.2114936+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"042db618-5d84-4eea-b1c9-e5b7635157bb": "02228ece-8139-4e18-90ca-4becd502e552",
"2d8560f5-a93b-45cc-815d-ab7a975313f1": "998a70d7-4c1c-4aa3-b578-ca3bef79324e"
},
"HasUpdates": true,
"Modified": "2026-05-27T10:27:45.2114936+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-05-27T10:27:45.2114936+00:00"
},
"LastComment": "2026-05-27T10:27:45.2114936+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "809bc9a1-4aa1-4d8d-97cd-896483e6a15c",
"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": "83e52f35-60de-45bf-a67c-4d9bcea4de1a",
"id": "3016ab3f-d4db-476b-8588-559dddfc28de",
"ConfigId": "eab23767-7ffa-4328-b8d0-4087bb03a955"
}