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": "89766799-27c2-4989-8978-97748ef9aa20",
"ParentTaskId": "47fd381d-add9-42f3-9d4a-98ef0e0e7659",
"Integration": {
"IntegrationId": "a884e1b1-46d3-44e7-aa6d-d5b5f223d3c0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"cf6dee3f-e3c8-455c-aa33-0634e5e395f0": 2.0,
"c3f5e8e7-6b3b-4e9a-be3e-9d753c83c608": 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": "9feecad8-91e6-4b9a-95d1-05057412d281",
"Name": "sample string 1",
"Created": "2026-07-02T07:56:32.0354333+00:00",
"Modified": "2026-07-02T07:56:32.0354333+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"67417359-6e42-477f-8d16-eda905203de6",
"e55527d0-d639-400a-a082-7eb41d57affe"
],
"NonLaborAssignments": [
{
"Id": "bbc0f19d-4fb7-42eb-9da6-01a938bce54d",
"ResourceId": "e9889dfa-0a7a-4e21-9b62-527587eb48d9",
"Quantity": 3.0
},
{
"Id": "bbc0f19d-4fb7-42eb-9da6-01a938bce54d",
"ResourceId": "e9889dfa-0a7a-4e21-9b62-527587eb48d9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f41bca3b-87f0-474b-a37e-3e9916f39ce1",
"Type": 0,
"ResourceId": "279f6733-1ca9-4756-bd8a-c90385ab3488",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "f41bca3b-87f0-474b-a37e-3e9916f39ce1",
"Type": 0,
"ResourceId": "279f6733-1ca9-4756-bd8a-c90385ab3488",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "c88cffae-dab5-41aa-b423-1fd4695d34ce",
"WorkTypeParentId": "fc827942-6523-4129-9a72-ec16984d41ff",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f7f8774b-9172-4651-802b-1d3c35ae598a",
"UPN": "b2eb743a-d158-4a64-924b-ae437977dde7",
"PostDate": "2026-07-02T07:56:32.0354333+00:00",
"Comment": "sample string 4",
"CC": [
"16042643-a95d-4684-806e-3f4d15ea3e6d",
"9a1a8a0d-d45a-4ecb-a221-669877f604d1"
],
"Users": [
"c2243e77-4f71-4c6e-9e1d-bd5384f7ae07",
"6c38d98c-a5cd-4a8e-b008-c2bc40581451"
]
},
{
"Id": "f7f8774b-9172-4651-802b-1d3c35ae598a",
"UPN": "b2eb743a-d158-4a64-924b-ae437977dde7",
"PostDate": "2026-07-02T07:56:32.0354333+00:00",
"Comment": "sample string 4",
"CC": [
"16042643-a95d-4684-806e-3f4d15ea3e6d",
"9a1a8a0d-d45a-4ecb-a221-669877f604d1"
],
"Users": [
"c2243e77-4f71-4c6e-9e1d-bd5384f7ae07",
"6c38d98c-a5cd-4a8e-b008-c2bc40581451"
]
}
],
"StartDate": "2026-07-02T07:56:32.0354333+00:00",
"DueDate": "2026-07-02T07:56:32.0354333+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5832aa56-b3b0-471f-adcf-c2ce7a3596bb": "6cef8c5d-0c3f-40eb-a67a-01fb22f09a48",
"f177bd9b-3109-4a32-a50a-a97ef9144a91": "3c1c33d4-2d8d-4867-ae61-d5dfe5aa335c"
},
"HasUpdates": true,
"Modified": "2026-07-02T07:56:32.0354333+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-02T07:56:32.0354333+00:00"
},
"LastComment": "2026-07-02T07:56:32.0354333+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5860ca50-c1ae-40b4-892c-9feef9d5fa2c",
"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": "e4bfde5d-b728-41c8-bc92-dc01c25364da",
"id": "60a334d2-143c-446d-bb4d-b3166c4701f5",
"ConfigId": "9d7120df-9df6-4941-b222-c3c90e6477c8"
}