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": "2b751977-0b48-4454-a405-455049e8075d",
"ParentTaskId": "ff035d28-f519-4a22-86e8-e38d8b4309fa",
"Integration": {
"IntegrationId": "acd0f98f-c39e-4469-b33f-7a5dc14d65a3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3d8f6c39-6c3f-43c5-acdb-e1ad061c0cb5": 2.0,
"964b81ee-9c5c-4f00-8d0b-2c5b5cec758e": 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": "14c2d6e9-3b17-4470-87f4-a897b54927c8",
"Name": "sample string 1",
"Created": "2026-03-20T16:28:12.8349293+00:00",
"Modified": "2026-03-20T16:28:12.8349293+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"023c7501-fb9b-4533-8d82-5ef5006b8455",
"85695fa9-2e37-4bb4-9b7a-a76252ce98e4"
],
"NonLaborAssignments": [
{
"Id": "321155e8-5dba-499c-9842-6c664498861e",
"ResourceId": "0d570658-5fb9-45dd-8f56-782567b072f8",
"Quantity": 3.0
},
{
"Id": "321155e8-5dba-499c-9842-6c664498861e",
"ResourceId": "0d570658-5fb9-45dd-8f56-782567b072f8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "66e5cec8-1b59-45af-a044-b3aa570508d3",
"Type": 0,
"ResourceId": "11b9beb3-a7ea-411a-b276-a159c3bc767b",
"Units": 3.0
},
{
"Id": "66e5cec8-1b59-45af-a044-b3aa570508d3",
"Type": 0,
"ResourceId": "11b9beb3-a7ea-411a-b276-a159c3bc767b",
"Units": 3.0
}
],
"ParentId": "e0467e83-d219-4e74-a2e6-e70796dfc040",
"WorkTypeParentId": "44b1d517-bcbb-42ed-a833-98d63c7934a5",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "18501f7e-9bfe-41d9-ad83-18a27b382cb0",
"UPN": "d0931b9a-6924-4a57-8aad-ba59564d3bc8",
"PostDate": "2026-03-20T16:28:12.8349293+00:00",
"Comment": "sample string 4",
"CC": [
"106109c1-ba25-4237-942c-4cf9bf2eb6a0",
"6cbab726-a1da-4806-8a3e-9eab4c7296d1"
],
"Users": [
"7ae5cc0f-baa1-48a3-aa52-92d1f6f41324",
"0411fafa-5f22-43eb-be6b-1f710a1f2dc5"
]
},
{
"Id": "18501f7e-9bfe-41d9-ad83-18a27b382cb0",
"UPN": "d0931b9a-6924-4a57-8aad-ba59564d3bc8",
"PostDate": "2026-03-20T16:28:12.8349293+00:00",
"Comment": "sample string 4",
"CC": [
"106109c1-ba25-4237-942c-4cf9bf2eb6a0",
"6cbab726-a1da-4806-8a3e-9eab4c7296d1"
],
"Users": [
"7ae5cc0f-baa1-48a3-aa52-92d1f6f41324",
"0411fafa-5f22-43eb-be6b-1f710a1f2dc5"
]
}
],
"StartDate": "2026-03-20T16:28:12.8349293+00:00",
"DueDate": "2026-03-20T16:28:12.8349293+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2466bdb1-bc8d-4b2b-ae28-2562dd85fdbf": "a993708d-be4c-4c14-8fae-8c00542144a1",
"f674441f-0ea1-4197-8468-86ba590ae7a3": "eef5202c-9c5c-4cb0-b4df-6dfeb7b0db4d"
},
"HasUpdates": true,
"Modified": "2026-03-20T16:28:12.8349293+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-03-20T16:28:12.8349293+00:00"
},
"LastComment": "2026-03-20T16:28:12.8349293+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "821ffeaf-a0dd-4002-9899-cf8a0c902920",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "2e43c376-93c0-4458-aadc-b55f13d7db3f",
"id": "7bad6f16-b79d-483a-b0d1-19124ab84d01",
"ConfigId": "4145da28-ec1c-4182-8022-d37b9a7f5c38"
}