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": "637ae75c-1f6c-4bb3-a7a7-e374c7e29bc7",
"ParentTaskId": "c8d16adc-b478-4535-9a2a-69d0b39669de",
"Integration": {
"IntegrationId": "dafde99f-66a6-4c24-be9d-3ef05c37a90f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"bed1734a-56bd-4e04-986f-fba74560e855": 2.0,
"64167626-0386-4b19-b17f-7adb01e3f915": 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": "01a81145-c38a-4a07-b431-695997c5067c",
"Name": "sample string 1",
"Created": "2026-08-07T23:41:03.7245594+00:00",
"Modified": "2026-08-07T23:41:03.7245594+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c66e69ec-3c1a-4166-8a33-97678626918b",
"58042a8c-4da8-48e6-aef8-2d1089e53635"
],
"NonLaborAssignments": [
{
"Id": "cc958d43-f64c-47da-bd9c-bda76694f6c7",
"ResourceId": "dbd0c42b-da69-4f24-91b4-802de92cbf57",
"Quantity": 3.0
},
{
"Id": "cc958d43-f64c-47da-bd9c-bda76694f6c7",
"ResourceId": "dbd0c42b-da69-4f24-91b4-802de92cbf57",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e6654a5a-62f5-4d40-ae51-ac91c417dd42",
"Type": 0,
"ResourceId": "9abc00eb-2d56-4478-b977-50f7586f2324",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "e6654a5a-62f5-4d40-ae51-ac91c417dd42",
"Type": 0,
"ResourceId": "9abc00eb-2d56-4478-b977-50f7586f2324",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "4de8386a-3a83-4a78-aa5c-9046e6810d51",
"WorkTypeParentId": "1f0b12ba-3c0a-4642-97b9-a4f55ec7818a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "90558e52-38ec-4769-aff6-74494475775a",
"UPN": "61ae30bf-8068-4fee-ab42-d88c30f634de",
"PostDate": "2026-08-07T23:41:03.7245594+00:00",
"Comment": "sample string 4",
"CC": [
"da5948f3-4042-41db-a98b-2a99f2e91554",
"134bba2e-b17c-4347-957f-55d18bc490bd"
],
"Users": [
"a342d608-6e34-4c0c-9e0b-f3aba8567c52",
"88b826d4-55d7-484c-b0a8-507ec63fffdb"
]
},
{
"Id": "90558e52-38ec-4769-aff6-74494475775a",
"UPN": "61ae30bf-8068-4fee-ab42-d88c30f634de",
"PostDate": "2026-08-07T23:41:03.7245594+00:00",
"Comment": "sample string 4",
"CC": [
"da5948f3-4042-41db-a98b-2a99f2e91554",
"134bba2e-b17c-4347-957f-55d18bc490bd"
],
"Users": [
"a342d608-6e34-4c0c-9e0b-f3aba8567c52",
"88b826d4-55d7-484c-b0a8-507ec63fffdb"
]
}
],
"StartDate": "2026-08-07T23:41:03.7245594+00:00",
"DueDate": "2026-08-07T23:41:03.7245594+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b7f563ce-f0c9-44c0-bb64-36f267132a4f": "62f06f2f-f361-4fc8-9966-c28f7da8c64c",
"1b67e9ff-cfca-4ea1-a5b5-56a31baec3bb": "da52e534-2fec-42fc-b3b7-fc0c7a4376bd"
},
"HasUpdates": true,
"Modified": "2026-08-07T23:41:03.7245594+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-07T23:41:03.7245594+00:00"
},
"LastComment": "2026-08-07T23:41:03.7245594+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c57c1b59-8137-4f76-9c42-1b97c9a8b1cb",
"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": "6cf3d624-6573-4c9a-989b-0bb4e13afbcb",
"id": "235876a5-1fcb-4d9a-a32d-f7b59c8f83ce",
"ConfigId": "024633ac-098a-4429-a2b9-8e32a5813686"
}