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": "e9c334be-d0e6-4285-a598-d7aa45bf271b",
"ParentTaskId": "4d4464ba-ceed-44ae-94b6-4e5de42da451",
"Integration": {
"IntegrationId": "394f845b-fa82-4a45-afb7-f81b539b1dd6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fdfee848-2964-467f-a333-a59c5556f7fd": 2.0,
"93204f83-ab93-422a-b521-f205f0d49392": 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": "e551fee3-31c4-4ae9-90df-02b945a9ccfe",
"Name": "sample string 1",
"Created": "2026-07-02T11:41:59.0999801+00:00",
"Modified": "2026-07-02T11:41:59.0999801+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"583d8af5-0551-4184-a988-8aadb73a4ce5",
"3814f287-6ddb-40a4-b9d2-f9f13f744807"
],
"NonLaborAssignments": [
{
"Id": "ae3c64e8-30f5-4f3a-97b1-d6f9ba212886",
"ResourceId": "9e54ac07-6fec-406b-b606-2ef8924e5a67",
"Quantity": 3.0
},
{
"Id": "ae3c64e8-30f5-4f3a-97b1-d6f9ba212886",
"ResourceId": "9e54ac07-6fec-406b-b606-2ef8924e5a67",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a84ea9b9-2cbb-4419-a59d-43ea0c3e7bf4",
"Type": 0,
"ResourceId": "ae3b8dbb-fd37-4590-988e-d0b4eefa0fda",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "a84ea9b9-2cbb-4419-a59d-43ea0c3e7bf4",
"Type": 0,
"ResourceId": "ae3b8dbb-fd37-4590-988e-d0b4eefa0fda",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9aad2642-ea9c-4f0c-96ec-1c8b519dead5",
"WorkTypeParentId": "2d01545b-e6c0-432e-9fa1-85eaf87a7a1c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e35abd1c-db97-42b5-b269-3d67e1de4a92",
"UPN": "4f1f7cf3-c3e9-464b-9156-1aeb65dd76e9",
"PostDate": "2026-07-02T11:41:59.0999801+00:00",
"Comment": "sample string 4",
"CC": [
"8fac8a91-edd6-4045-bdec-c9f8f51241d8",
"25e833ef-245b-4f2c-922c-918b3ee58c56"
],
"Users": [
"9a925559-6ba8-45be-958f-86df99093d2d",
"d415b096-5b26-4a3b-ab3c-8edc2d54257b"
]
},
{
"Id": "e35abd1c-db97-42b5-b269-3d67e1de4a92",
"UPN": "4f1f7cf3-c3e9-464b-9156-1aeb65dd76e9",
"PostDate": "2026-07-02T11:41:59.0999801+00:00",
"Comment": "sample string 4",
"CC": [
"8fac8a91-edd6-4045-bdec-c9f8f51241d8",
"25e833ef-245b-4f2c-922c-918b3ee58c56"
],
"Users": [
"9a925559-6ba8-45be-958f-86df99093d2d",
"d415b096-5b26-4a3b-ab3c-8edc2d54257b"
]
}
],
"StartDate": "2026-07-02T11:41:59.0999801+00:00",
"DueDate": "2026-07-02T11:41:59.0999801+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cdf91178-a8b7-49e4-ad32-9db453c16939": "8ccbc7de-bdf4-47f2-92b9-dbe9e3143873",
"cce1360e-11cc-4c2c-8be4-c436173d0045": "eb51a432-f1e1-4737-8130-9bb41e964454"
},
"HasUpdates": true,
"Modified": "2026-07-02T11:41:59.0999801+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-02T11:41:59.0999801+00:00"
},
"LastComment": "2026-07-02T11:41:59.0999801+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "eed661d5-27e3-4fec-84de-da334b021ddc",
"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": "b6cba80b-8395-4330-b129-5e78f5b10bdb",
"id": "fcc2b632-7d8e-4fc9-9409-1d8a3c6c8c50",
"ConfigId": "12164a61-a595-4438-8a1d-7c6e9d775361"
}