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": "24a29fd5-c8a5-476d-b333-1dc188d651d3",
"ParentTaskId": "4a70dac1-bb9d-4ef2-a9d3-101f3541be49",
"Integration": {
"IntegrationId": "39fb15a3-4455-4c57-a30c-572ec8b788b7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ac8a5f07-3436-48c2-9448-287be0601755": 2.0,
"24ee0465-a31d-4888-909d-d3ade56759e8": 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": "ad955308-5f79-4846-ae3b-7efcc456b64d",
"Name": "sample string 1",
"Created": "2026-08-15T00:20:14.4650837+00:00",
"Modified": "2026-08-15T00:20:14.4650837+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"15bbc5e6-618e-4e1a-baee-b155ee25c262",
"8a5b23de-d35b-4803-955b-a675d6f332a2"
],
"NonLaborAssignments": [
{
"Id": "a8b54b02-6ab5-4fc0-9db5-66c4938661b0",
"ResourceId": "33342bfa-54db-4dc8-aaaa-645b8edca69e",
"Quantity": 3.0
},
{
"Id": "a8b54b02-6ab5-4fc0-9db5-66c4938661b0",
"ResourceId": "33342bfa-54db-4dc8-aaaa-645b8edca69e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "74deb376-de30-4c07-ba92-0a349fc5ec14",
"Type": 0,
"ResourceId": "7604509d-0422-4119-bde3-a52ef4a29e1f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "74deb376-de30-4c07-ba92-0a349fc5ec14",
"Type": 0,
"ResourceId": "7604509d-0422-4119-bde3-a52ef4a29e1f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "959fdc33-a2fd-4ca2-a518-3dfe89ecc449",
"WorkTypeParentId": "34db46d4-a667-403f-aa56-aaea26b35244",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cc6dc999-395a-4b9b-aa43-4741f647a2b6",
"UPN": "c0eb5241-78a0-4571-ab5f-6e41c36c8ae7",
"PostDate": "2026-08-15T00:20:14.4650837+00:00",
"Comment": "sample string 4",
"CC": [
"1ce7bdda-2836-4df1-a35b-0979c0ecba13",
"9f436e6a-ec05-4d3c-b794-c037b369bb3e"
],
"Users": [
"f8a00743-2ba0-4f9c-bc9f-24ec03ed1977",
"3ebc6f15-ce5b-4f7e-9e5e-8c55a06aa896"
]
},
{
"Id": "cc6dc999-395a-4b9b-aa43-4741f647a2b6",
"UPN": "c0eb5241-78a0-4571-ab5f-6e41c36c8ae7",
"PostDate": "2026-08-15T00:20:14.4650837+00:00",
"Comment": "sample string 4",
"CC": [
"1ce7bdda-2836-4df1-a35b-0979c0ecba13",
"9f436e6a-ec05-4d3c-b794-c037b369bb3e"
],
"Users": [
"f8a00743-2ba0-4f9c-bc9f-24ec03ed1977",
"3ebc6f15-ce5b-4f7e-9e5e-8c55a06aa896"
]
}
],
"StartDate": "2026-08-15T00:20:14.4650837+00:00",
"DueDate": "2026-08-15T00:20:14.4650837+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"16105450-e1ab-4520-ac30-5718d97242e2": "de96f999-5e6d-4eca-a646-2bdf0977ad2e",
"be6edbb6-4538-44a7-8e94-2be7a2e2b1b0": "f68ccce1-daa5-4df2-b835-837462db8788"
},
"HasUpdates": true,
"Modified": "2026-08-15T00:20:14.4650837+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-08-15T00:20:14.4650837+00:00"
},
"LastComment": "2026-08-15T00:20:14.4650837+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8360dbc2-990a-4dce-8aff-5959df0534fb",
"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": "d3cfedcb-d8e8-4da2-945c-5a36e6a62f87",
"id": "aa59d270-7617-4014-90eb-d9556900e38b",
"ConfigId": "30a2acac-254b-422f-9821-52eabfc3f144"
}