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": "222baa7d-53a0-472e-840f-a9e835d98938",
"ParentTaskId": "f88f7aa8-68c5-46b3-8234-30970fc6837d",
"Integration": {
"IntegrationId": "0d8c72c7-0f4e-4018-95bf-600c6a4c8b83",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"5f28ce06-ee3f-49cb-9264-5540c2e6324f": 2.0,
"5f61f81b-f22d-4695-b00e-43367fcef7de": 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": "76becf68-3bfa-4b51-a870-57d73b68389e",
"Name": "sample string 1",
"Created": "2026-07-23T13:47:12.0572194+00:00",
"Modified": "2026-07-23T13:47:12.0572194+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3a3ea501-aa66-48ea-a1b4-e8023bbc49cd",
"1a6462cb-c73e-41b1-9ac7-24422fb7cfee"
],
"NonLaborAssignments": [
{
"Id": "67eb9067-803d-43e6-b06e-cbab3103d5d8",
"ResourceId": "7e226909-df8e-4bca-809a-515279152809",
"Quantity": 3.0
},
{
"Id": "67eb9067-803d-43e6-b06e-cbab3103d5d8",
"ResourceId": "7e226909-df8e-4bca-809a-515279152809",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "33ccea69-0ab9-4eb6-9d64-8a685d1ff628",
"Type": 0,
"ResourceId": "2ac37be5-3880-4f29-be02-4fa893e99348",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "33ccea69-0ab9-4eb6-9d64-8a685d1ff628",
"Type": 0,
"ResourceId": "2ac37be5-3880-4f29-be02-4fa893e99348",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "301684cd-2b8e-46bd-b899-9be28533acba",
"WorkTypeParentId": "e279403b-e878-4bb1-98c7-4cbe2ee43bbb",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "eb5b153a-b381-4e0a-82f8-c1d1ce88bbe4",
"UPN": "ef717ee3-a4a6-43fb-b9d9-0599307fd745",
"PostDate": "2026-07-23T13:47:12.0572194+00:00",
"Comment": "sample string 4",
"CC": [
"b0f59c68-2389-4ca3-87d7-ee818e6d60d7",
"ade500c6-f4fd-4ca0-a001-eb3c76514a79"
],
"Users": [
"cd88884d-5f43-47f1-9426-5a1635424e1f",
"ee58a3f1-5a8b-4b10-a5e4-cba1e4f49bc2"
]
},
{
"Id": "eb5b153a-b381-4e0a-82f8-c1d1ce88bbe4",
"UPN": "ef717ee3-a4a6-43fb-b9d9-0599307fd745",
"PostDate": "2026-07-23T13:47:12.0572194+00:00",
"Comment": "sample string 4",
"CC": [
"b0f59c68-2389-4ca3-87d7-ee818e6d60d7",
"ade500c6-f4fd-4ca0-a001-eb3c76514a79"
],
"Users": [
"cd88884d-5f43-47f1-9426-5a1635424e1f",
"ee58a3f1-5a8b-4b10-a5e4-cba1e4f49bc2"
]
}
],
"StartDate": "2026-07-23T13:47:12.0572194+00:00",
"DueDate": "2026-07-23T13:47:12.0572194+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3207e318-ec25-43ad-9b77-40aef7cd02e4": "1e3fc758-252b-4b50-bb71-0ffdc851ad37",
"7a124a72-df3d-4592-ac84-b68dd04006f8": "843be61e-6c82-4714-ba83-318dc51273ae"
},
"HasUpdates": true,
"Modified": "2026-07-23T13:47:12.0572194+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-07-23T13:47:12.0572194+00:00"
},
"LastComment": "2026-07-23T13:47:12.0572194+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7068c82c-0efa-4269-aa12-ee8d860f4461",
"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": "e7acdf16-a8c7-4f1e-9562-4e7c14f45b80",
"id": "6a977004-2242-4f1a-a88e-e7600e3393cf",
"ConfigId": "e93cb817-dff7-4951-aab5-be989c65d388"
}