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": "3de84aa1-0819-4b1b-aa6c-5b9a65ce6046",
"ParentTaskId": "2b3131cd-50a4-4a21-9a40-1ff3d6e3c1fb",
"Integration": {
"IntegrationId": "c9ca561c-b0c4-4ffc-82dd-7ce9c7ae89a0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e4156db0-371f-4a1b-b349-0ed6ca025b57": 2.0,
"ee823dd0-670e-423a-9d90-9eb768403c28": 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": "40c735fb-85cb-45d2-aabf-8f8412d31e20",
"Name": "sample string 1",
"Created": "2026-05-27T16:46:03.773707+00:00",
"Modified": "2026-05-27T16:46:03.773707+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"db133b3e-3626-4ed4-b08c-7fa5fb560b9a",
"05eeece3-6697-40c3-a904-9dc144ac4d29"
],
"NonLaborAssignments": [
{
"Id": "c3321c2e-9f95-4302-b8da-727e637b182b",
"ResourceId": "33852f8a-516f-4434-9f19-614dd1063104",
"Quantity": 3.0
},
{
"Id": "c3321c2e-9f95-4302-b8da-727e637b182b",
"ResourceId": "33852f8a-516f-4434-9f19-614dd1063104",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "95d52ad5-0214-4ecf-87c2-694be9754e22",
"Type": 0,
"ResourceId": "86231f16-c4ee-4ad0-ab1e-2000e52ba0a4",
"Units": 3.0
},
{
"Id": "95d52ad5-0214-4ecf-87c2-694be9754e22",
"Type": 0,
"ResourceId": "86231f16-c4ee-4ad0-ab1e-2000e52ba0a4",
"Units": 3.0
}
],
"ParentId": "c7cc823d-72d3-4f66-b39b-cd1533e6f533",
"WorkTypeParentId": "4ce05d6b-464a-4b2f-b10a-784584ec317b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b6d1b9b2-eb20-4940-896f-449f4ab9724b",
"UPN": "9a53ddf9-4909-4cb8-93bc-26f6b479d1db",
"PostDate": "2026-05-27T16:46:03.773707+00:00",
"Comment": "sample string 4",
"CC": [
"5acc9c1b-d20e-4302-a2e4-13ba15d043ca",
"ddfb99b1-5042-4bfb-8f0a-8b7f5db052a2"
],
"Users": [
"1405d8ba-6502-4484-9a54-905bdb277ace",
"6712cf81-25b4-4e2d-aa7f-4fe7acf29b45"
]
},
{
"Id": "b6d1b9b2-eb20-4940-896f-449f4ab9724b",
"UPN": "9a53ddf9-4909-4cb8-93bc-26f6b479d1db",
"PostDate": "2026-05-27T16:46:03.773707+00:00",
"Comment": "sample string 4",
"CC": [
"5acc9c1b-d20e-4302-a2e4-13ba15d043ca",
"ddfb99b1-5042-4bfb-8f0a-8b7f5db052a2"
],
"Users": [
"1405d8ba-6502-4484-9a54-905bdb277ace",
"6712cf81-25b4-4e2d-aa7f-4fe7acf29b45"
]
}
],
"StartDate": "2026-05-27T16:46:03.773707+00:00",
"DueDate": "2026-05-27T16:46:03.773707+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"978a861e-4878-4beb-9240-29155bf64467": "ff66796f-74c7-4acb-a771-0364a03bd31a",
"99b99b13-9ebe-47e0-80ba-ed23e14c64a2": "55dfd0c7-19ac-4c56-ac77-f00009cd0288"
},
"HasUpdates": true,
"Modified": "2026-05-27T16:46:03.773707+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-05-27T16:46:03.773707+00:00"
},
"LastComment": "2026-05-27T16:46:03.773707+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5dff9375-1d0b-48a8-b56a-6adea061d16a",
"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": "b74969b4-1bad-4211-aa1d-3460c05686a5",
"id": "975a00b7-a4cb-40b0-aebb-342602be36e8",
"ConfigId": "b40af63a-e31c-4ce2-835a-ed1ae3d22804"
}