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": "8ce427bc-314f-48ad-8c6f-4755cb8bf947",
"ParentTaskId": "51e2c35b-cf0b-45e2-97c5-65636d1026a1",
"Integration": {
"IntegrationId": "91f8a83b-0c94-4059-8a24-de84716451d4",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f6fb7f9c-313d-4fec-b2d9-84e2cc5334f8": 2.0,
"40003faa-33c7-47d3-a73f-c8025956291d": 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": "56df9255-e339-4923-8d71-bec102cd7c0d",
"Name": "sample string 1",
"Created": "2026-07-25T04:18:10.0213799+00:00",
"Modified": "2026-07-25T04:18:10.0213799+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b7c4d9dc-fbb4-4b07-80f2-16efa3c557c3",
"2835111d-087e-4d06-a4c9-309212b42279"
],
"NonLaborAssignments": [
{
"Id": "fb8e4dc8-5ddb-42f5-8cc5-9871b6454550",
"ResourceId": "f71f0037-2535-4472-a7d0-85fd51b30ad8",
"Quantity": 3.0
},
{
"Id": "fb8e4dc8-5ddb-42f5-8cc5-9871b6454550",
"ResourceId": "f71f0037-2535-4472-a7d0-85fd51b30ad8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7d9b3470-9312-420b-8bed-eb3d284f95e4",
"Type": 0,
"ResourceId": "dd08b71f-8472-4bd9-b370-40bb275e6b7c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "7d9b3470-9312-420b-8bed-eb3d284f95e4",
"Type": 0,
"ResourceId": "dd08b71f-8472-4bd9-b370-40bb275e6b7c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "c1f0c4aa-ec96-486a-ba1b-6614b27f5468",
"WorkTypeParentId": "c3f9ec83-c902-4413-92fd-69da270136ab",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7ac7c81a-4df1-40d6-af2f-ba31767120fb",
"UPN": "79095062-5c5d-464e-861a-405911e40280",
"PostDate": "2026-07-25T04:18:10.0213799+00:00",
"Comment": "sample string 4",
"CC": [
"58f2ed00-c1bc-4088-8cfb-5a9fa0f5d1ef",
"767eb125-33a7-4b3d-95d9-cb6a4ce816b7"
],
"Users": [
"51270370-7f2c-45ba-80bf-582e95e3ac52",
"8e5a7da9-f196-427d-8d81-079df05d1b79"
]
},
{
"Id": "7ac7c81a-4df1-40d6-af2f-ba31767120fb",
"UPN": "79095062-5c5d-464e-861a-405911e40280",
"PostDate": "2026-07-25T04:18:10.0213799+00:00",
"Comment": "sample string 4",
"CC": [
"58f2ed00-c1bc-4088-8cfb-5a9fa0f5d1ef",
"767eb125-33a7-4b3d-95d9-cb6a4ce816b7"
],
"Users": [
"51270370-7f2c-45ba-80bf-582e95e3ac52",
"8e5a7da9-f196-427d-8d81-079df05d1b79"
]
}
],
"StartDate": "2026-07-25T04:18:10.0213799+00:00",
"DueDate": "2026-07-25T04:18:10.0213799+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"86eb252a-e785-4ff6-8450-aa87be35e4a4": "07f9b30e-070d-408c-9599-aadfecc2cddd",
"eb15b53d-ff18-4229-9310-7821910cb697": "d8aed763-d099-4a67-9bd9-020de3723653"
},
"HasUpdates": true,
"Modified": "2026-07-25T04:18:10.0213799+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-25T04:18:10.0213799+00:00"
},
"LastComment": "2026-07-25T04:18:10.0213799+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cc7e6864-7e3d-4140-86ca-11de327ea08f",
"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": "44419d2f-ffc7-4073-95b3-1aefafb895f6",
"id": "49329886-85cf-4a24-8941-bf52f968d965",
"ConfigId": "0c25d512-584e-40a8-b25b-d1d83ea58996"
}