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": "a767a5e5-a11a-457c-a9ce-099f88e6b8cd",
"ParentTaskId": "7be0bd6a-e21e-4236-901d-69584208d0e9",
"Integration": {
"IntegrationId": "606af6cd-fe5c-4507-9138-5ebc95c1020c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"960b5891-282a-45ed-9ccd-806fa24d8cc0": 2.0,
"83adf984-ecf8-4796-b989-5685b4923c3a": 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": "f9d6894f-1c57-4fe2-aa5e-c14bb592fbf2",
"Name": "sample string 1",
"Created": "2026-10-15T14:22:54.6858434+00:00",
"Modified": "2026-10-15T14:22:54.6858434+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"24caa6f2-1ab0-4cbd-84a2-202b455701be",
"e7f9d979-7c63-460a-ba2f-63a8c4577e25"
],
"NonLaborAssignments": [
{
"Id": "9d1f2dbc-3911-4e52-bad1-00a7443f5f13",
"ResourceId": "60854d55-3fa1-4e3d-8b3a-47cef8a5b05c",
"Quantity": 3.0
},
{
"Id": "9d1f2dbc-3911-4e52-bad1-00a7443f5f13",
"ResourceId": "60854d55-3fa1-4e3d-8b3a-47cef8a5b05c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1113ad9a-38fa-45be-acc9-f51299fc2ba5",
"Type": 0,
"ResourceId": "87c45ce9-7fb9-48e6-b34c-57b25698f720",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6fd74951-8c3a-42c4-8148-c8972691b845",
"Start": "2026-10-15T14:22:54.6858434+00:00",
"Due": "2026-10-15T14:22:54.6858434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6fd74951-8c3a-42c4-8148-c8972691b845",
"Start": "2026-10-15T14:22:54.6858434+00:00",
"Due": "2026-10-15T14:22:54.6858434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "1113ad9a-38fa-45be-acc9-f51299fc2ba5",
"Type": 0,
"ResourceId": "87c45ce9-7fb9-48e6-b34c-57b25698f720",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6fd74951-8c3a-42c4-8148-c8972691b845",
"Start": "2026-10-15T14:22:54.6858434+00:00",
"Due": "2026-10-15T14:22:54.6858434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6fd74951-8c3a-42c4-8148-c8972691b845",
"Start": "2026-10-15T14:22:54.6858434+00:00",
"Due": "2026-10-15T14:22:54.6858434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "47a898d7-49f8-4e68-b66f-14790ec35276",
"WorkTypeParentId": "0d094717-4143-4614-be36-6eebaed4550c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "be8db26e-af36-4e37-a849-bc20558fb290",
"UPN": "191cabc6-e924-427a-b314-54769704e1c4",
"PostDate": "2026-10-15T14:22:54.6858434+00:00",
"Comment": "sample string 4",
"CC": [
"39e4c440-686f-4ee2-9827-7545cafed9d9",
"6aa1da32-40be-4f63-919b-b458bb87df8d"
],
"Users": [
"ac2f99f4-eebb-4835-bdf7-902b67423454",
"2455fa81-ddd0-49cb-98d3-9a7cdfba548c"
]
},
{
"Id": "be8db26e-af36-4e37-a849-bc20558fb290",
"UPN": "191cabc6-e924-427a-b314-54769704e1c4",
"PostDate": "2026-10-15T14:22:54.6858434+00:00",
"Comment": "sample string 4",
"CC": [
"39e4c440-686f-4ee2-9827-7545cafed9d9",
"6aa1da32-40be-4f63-919b-b458bb87df8d"
],
"Users": [
"ac2f99f4-eebb-4835-bdf7-902b67423454",
"2455fa81-ddd0-49cb-98d3-9a7cdfba548c"
]
}
],
"StartDate": "2026-10-15T14:22:54.6858434+00:00",
"DueDate": "2026-10-15T14:22:54.6858434+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f301a4b0-6a42-47c1-83db-f750210183c3": "15936e8d-0de0-4b0c-a582-8b64ac203de2",
"35436d38-0eef-441d-a713-eeee8b979f23": "833dd232-082e-41bf-b6ff-e40e81c26734"
},
"HasUpdates": true,
"Modified": "2026-10-15T14:22:54.6858434+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-10-15T14:22:54.6858434+00:00"
},
"LastComment": "2026-10-15T14:22:54.6858434+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a30b4080-c798-4c9f-ad08-93fad1ef459a",
"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": "ff9bc0fd-7e42-41e8-9e7b-7c38c83f2d31",
"id": "ff23baac-8be2-4bf8-a0ab-9408b7c46a42",
"ConfigId": "9566180d-a191-418f-be5a-69bb78389169"
}