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": "cb19e7bd-822f-45fd-8149-ca815d6411bb",
"ParentTaskId": "b1ae906e-28df-42b7-8d31-ee8dc6b0fa0d",
"Integration": {
"IntegrationId": "084ca371-3d91-4e01-a6c3-013fb1539fc6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"44892e5a-7f77-42c9-a2be-531a51cb2d9d": 2.0,
"05302efe-eb66-4b15-8c42-74e1613cf613": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "e5ee8286-d778-47b9-bae1-72ee8f343f67",
"Name": "sample string 1",
"Created": "2025-12-15T16:11:21.2806945+00:00",
"Modified": "2025-12-15T16:11:21.2806945+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"9b67de27-606f-4f4f-b829-e25be18c13c6",
"c5021c96-0934-4a60-9076-87dd8d64b907"
],
"NonLaborAssignments": [
{
"Id": "2c748e73-b029-4515-886b-71dbae84da52",
"ResourceId": "d7cf799b-83dd-4f55-abb6-0146f2532d84",
"Quantity": 3.0
},
{
"Id": "2c748e73-b029-4515-886b-71dbae84da52",
"ResourceId": "d7cf799b-83dd-4f55-abb6-0146f2532d84",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b8e6c51c-a8dc-46d3-8891-d765e595bab0",
"Type": 0,
"ResourceId": "6ab45467-6079-4f42-bae2-cb8da2b807ad",
"Units": 3.0
},
{
"Id": "b8e6c51c-a8dc-46d3-8891-d765e595bab0",
"Type": 0,
"ResourceId": "6ab45467-6079-4f42-bae2-cb8da2b807ad",
"Units": 3.0
}
],
"ParentId": "3d4ee617-d695-49bf-b007-c1eb51605521",
"WorkTypeParentId": "11069bf9-33ab-4700-ad15-635256a75eea",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "363c1875-cf48-4600-b3a4-60d72d358dc7",
"UPN": "fb25f324-1479-44d5-aa42-7c228b09aeed",
"PostDate": "2025-12-15T16:11:21.2806945+00:00",
"Comment": "sample string 4",
"CC": [
"94cb4d4f-993a-499f-b4f5-f3fe8915fc6b",
"12b50520-bdf7-43aa-b4dc-078e621128bc"
],
"Users": [
"e381596b-b943-41aa-aaad-d29ec5d67a6c",
"51b4dbff-2669-4a01-b277-1bb29e65ac4c"
]
},
{
"Id": "363c1875-cf48-4600-b3a4-60d72d358dc7",
"UPN": "fb25f324-1479-44d5-aa42-7c228b09aeed",
"PostDate": "2025-12-15T16:11:21.2806945+00:00",
"Comment": "sample string 4",
"CC": [
"94cb4d4f-993a-499f-b4f5-f3fe8915fc6b",
"12b50520-bdf7-43aa-b4dc-078e621128bc"
],
"Users": [
"e381596b-b943-41aa-aaad-d29ec5d67a6c",
"51b4dbff-2669-4a01-b277-1bb29e65ac4c"
]
}
],
"StartDate": "2025-12-15T16:11:21.2806945+00:00",
"DueDate": "2025-12-15T16:11:21.2806945+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"32fd4589-b6de-4d0f-b82e-b79f95f02bdf": "5db65e22-a77f-49b9-9db3-91866c49c025",
"c093ac26-d97d-47c7-9bf7-ce79ef9b9da2": "9cbd6797-a6b1-41ff-8b80-9a817ec27c1e"
},
"HasUpdates": true,
"Modified": "2025-12-15T16:11:21.2806945+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": "2025-12-15T16:11:21.2806945+00:00"
},
"LastComment": "2025-12-15T16:11:21.2806945+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d3ffcc66-1f4a-48bc-b55d-91306eb8ac20",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "e573f76d-e2aa-47d1-99ed-a70661143b37",
"id": "4de46bed-4772-4a24-81e0-f5a00836d0da",
"ConfigId": "8ef35939-c022-4bf9-bff0-7d4524cbb634"
}