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": "3225ff5f-8c53-4a1f-a892-63a46fa86be0",
"ParentTaskId": "9ad16c72-328b-4865-a3a1-90413c749ede",
"Integration": {
"IntegrationId": "4255a4d2-599b-4547-962d-c68e76aae9c7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4d6ec792-b0f0-4d6f-922c-94114241cbdf": 2.0,
"bd239179-32bb-4d37-afba-a141093323b9": 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": "1e34e2bc-6b34-4289-af15-4336a94f0be0",
"Name": "sample string 1",
"Created": "2026-07-01T05:37:17.0865219+00:00",
"Modified": "2026-07-01T05:37:17.0865219+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5bb50a86-db95-40f4-b55d-6b476730bdab",
"0bc8dcd3-9436-47f3-afe7-1e8ca688d89b"
],
"NonLaborAssignments": [
{
"Id": "41325be9-f508-4952-b267-b93403d72927",
"ResourceId": "14bd711a-06b2-4e55-87f8-762d954f9749",
"Quantity": 3.0
},
{
"Id": "41325be9-f508-4952-b267-b93403d72927",
"ResourceId": "14bd711a-06b2-4e55-87f8-762d954f9749",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "501f1b37-efbf-4310-a2af-2b8616bd16b4",
"Type": 0,
"ResourceId": "5c22219a-d8fa-435d-ad07-3d03bfa3f1e8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "501f1b37-efbf-4310-a2af-2b8616bd16b4",
"Type": 0,
"ResourceId": "5c22219a-d8fa-435d-ad07-3d03bfa3f1e8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "7216dabf-30d0-437f-a33a-5fb414610def",
"WorkTypeParentId": "51817db4-6dc8-414b-b2d6-cf0d9b864b1d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7663d149-74b7-4402-9c34-7f0613eea000",
"UPN": "b96ef3a4-1159-45c7-8961-01fb8948a543",
"PostDate": "2026-07-01T05:37:17.0865219+00:00",
"Comment": "sample string 4",
"CC": [
"2c34df11-87e6-44cf-b4a9-e08bf6f03358",
"755bd217-96ae-4b4e-8e16-f119c325ea69"
],
"Users": [
"bfa7bba6-dfee-41fa-b1fd-55108afeb20c",
"62a8fa82-6178-485d-bbf6-e907a4322720"
]
},
{
"Id": "7663d149-74b7-4402-9c34-7f0613eea000",
"UPN": "b96ef3a4-1159-45c7-8961-01fb8948a543",
"PostDate": "2026-07-01T05:37:17.0865219+00:00",
"Comment": "sample string 4",
"CC": [
"2c34df11-87e6-44cf-b4a9-e08bf6f03358",
"755bd217-96ae-4b4e-8e16-f119c325ea69"
],
"Users": [
"bfa7bba6-dfee-41fa-b1fd-55108afeb20c",
"62a8fa82-6178-485d-bbf6-e907a4322720"
]
}
],
"StartDate": "2026-07-01T05:37:17.0865219+00:00",
"DueDate": "2026-07-01T05:37:17.0865219+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"de81b943-e942-4761-9e83-3fa430f5c105": "d50e0bb6-d344-4a72-9700-1f1e38c1b949",
"81b77906-5c5c-477b-9876-c9a80881929b": "19d10883-82cb-4796-acc0-dc0d3f36cab9"
},
"HasUpdates": true,
"Modified": "2026-07-01T05:37:17.0865219+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-01T05:37:17.0865219+00:00"
},
"LastComment": "2026-07-01T05:37:17.0865219+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "08aa8282-1688-4cc7-89aa-0a1ad2b54a2f",
"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": "8930a412-4966-42d3-a365-a2cd7801c5de",
"id": "2c1c4e8d-3002-40e6-8429-b58436c00fcc",
"ConfigId": "dce9de88-7d6a-43aa-b86e-e9466dcefbf8"
}