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": "012a3716-4405-4a12-b3a6-21f815d01da6",
"ParentTaskId": "d17b1645-c5ec-4c10-ae89-83afe8df77a1",
"Integration": {
"IntegrationId": "f84c64c0-7556-4fb3-a89d-4b57965ab741",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"895d74ac-880a-4f06-b601-fed20373d63c": 2.0,
"94f94246-97af-4301-bd7f-8869db76581a": 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": "8148c35a-2b51-4c01-a330-283d76c9fabf",
"Name": "sample string 1",
"Created": "2026-06-20T17:36:27.5576076+00:00",
"Modified": "2026-06-20T17:36:27.5576076+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f087b6cd-b215-4132-a36a-2282cc460763",
"22375a3d-b170-48ae-ad7a-c17935fbd6e6"
],
"NonLaborAssignments": [
{
"Id": "b15896c1-366a-48ab-8a98-2364b415d131",
"ResourceId": "f61beed8-f8a5-4a0d-878c-27191a1ff46a",
"Quantity": 3.0
},
{
"Id": "b15896c1-366a-48ab-8a98-2364b415d131",
"ResourceId": "f61beed8-f8a5-4a0d-878c-27191a1ff46a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "408bf5b4-7f0b-4cdc-8682-6a9873bffee6",
"Type": 0,
"ResourceId": "96cedb89-b826-4ecb-aa0b-7956b812d5cd",
"Units": 3.0
},
{
"Id": "408bf5b4-7f0b-4cdc-8682-6a9873bffee6",
"Type": 0,
"ResourceId": "96cedb89-b826-4ecb-aa0b-7956b812d5cd",
"Units": 3.0
}
],
"ParentId": "bd010e36-c4ca-4b76-b561-80df5fef24b1",
"WorkTypeParentId": "91aa689a-996e-4003-9824-b1f9c29e7780",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8b21d192-5b5b-46a0-ab22-2d9bef7cc791",
"UPN": "ccc5753c-23df-48c9-b0c7-87f680ff9b67",
"PostDate": "2026-06-20T17:36:27.5576076+00:00",
"Comment": "sample string 4",
"CC": [
"ecc3676b-5c81-4000-9243-5517cf9578bb",
"140634b4-be78-4491-919c-c2116feda910"
],
"Users": [
"1bca000d-1f70-48db-b314-853c52814254",
"cbdec5dc-dd7e-425d-91a3-eba148cc9e93"
]
},
{
"Id": "8b21d192-5b5b-46a0-ab22-2d9bef7cc791",
"UPN": "ccc5753c-23df-48c9-b0c7-87f680ff9b67",
"PostDate": "2026-06-20T17:36:27.5576076+00:00",
"Comment": "sample string 4",
"CC": [
"ecc3676b-5c81-4000-9243-5517cf9578bb",
"140634b4-be78-4491-919c-c2116feda910"
],
"Users": [
"1bca000d-1f70-48db-b314-853c52814254",
"cbdec5dc-dd7e-425d-91a3-eba148cc9e93"
]
}
],
"StartDate": "2026-06-20T17:36:27.5576076+00:00",
"DueDate": "2026-06-20T17:36:27.5576076+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5e7ea15d-cb68-475d-bcdc-e4535cd28df5": "3b06657a-a3f1-43c8-af50-44d328ad17d3",
"b997f918-0d59-426b-a17f-a53981f9253c": "a0421881-d3c1-4092-9fbd-79aaaec0ca2b"
},
"HasUpdates": true,
"Modified": "2026-06-20T17:36:27.5576076+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-06-20T17:36:27.5576076+00:00"
},
"LastComment": "2026-06-20T17:36:27.5576076+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3653e64b-2864-4e66-a1fb-30477f9a9721",
"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": "60c5f702-9667-4b8f-b712-2dcc45dd0fa0",
"id": "fd7b6e4a-f9e1-457d-9495-96f3017681fb",
"ConfigId": "849b9a7c-b602-48f5-90d5-72cec1bbfcee"
}