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": "cd7ab1c4-f2c8-4aba-947d-b8b7261b9afa",
"ParentTaskId": "6d510ef6-803f-4a60-90fe-264ee20e9e47",
"Integration": {
"IntegrationId": "9d29a852-8a5d-4e8f-ab59-8e0896618688",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d1034878-eb94-4782-91dc-38c4160d9cd7": 2.0,
"0ac6d04a-5350-4b92-bc07-92df08652c7b": 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": "219d7a16-30c3-4708-901b-e8867ddfa9e4",
"Name": "sample string 1",
"Created": "2026-10-30T21:03:32.8117699+00:00",
"Modified": "2026-10-30T21:03:32.8117699+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1ee0a847-a0c1-4ffe-ac14-bb294c9a9770",
"38ed9137-4a05-4396-9183-f849b3d2c619"
],
"NonLaborAssignments": [
{
"Id": "ecb39138-7fce-4920-be9f-bca0a6723914",
"ResourceId": "5858b588-99aa-4a8b-be93-7d436f7683f8",
"Quantity": 3.0
},
{
"Id": "ecb39138-7fce-4920-be9f-bca0a6723914",
"ResourceId": "5858b588-99aa-4a8b-be93-7d436f7683f8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d3c36114-ab2d-401c-891b-6e38ae4f0aeb",
"Type": 0,
"ResourceId": "2c990e2a-b9f4-4faf-84f5-e1943b905384",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "932cd9ab-9b9c-4564-9d2e-0347cbd6d161",
"Start": "2026-10-30T21:03:32.8117699+00:00",
"Due": "2026-10-30T21:03:32.8117699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "932cd9ab-9b9c-4564-9d2e-0347cbd6d161",
"Start": "2026-10-30T21:03:32.8117699+00:00",
"Due": "2026-10-30T21:03:32.8117699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "d3c36114-ab2d-401c-891b-6e38ae4f0aeb",
"Type": 0,
"ResourceId": "2c990e2a-b9f4-4faf-84f5-e1943b905384",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "932cd9ab-9b9c-4564-9d2e-0347cbd6d161",
"Start": "2026-10-30T21:03:32.8117699+00:00",
"Due": "2026-10-30T21:03:32.8117699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "932cd9ab-9b9c-4564-9d2e-0347cbd6d161",
"Start": "2026-10-30T21:03:32.8117699+00:00",
"Due": "2026-10-30T21:03:32.8117699+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "d19203dd-a866-47d9-92b9-b558667546b4",
"WorkTypeParentId": "05c23c09-2d22-4897-9df0-a74d0ddf91e9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "de10bb55-51ab-4b4e-a75e-31e329e27346",
"UPN": "eadd3478-aeb4-4415-a536-a3729753aea9",
"PostDate": "2026-10-30T21:03:32.8117699+00:00",
"Comment": "sample string 4",
"CC": [
"d710c6ca-c091-4709-ba92-56a9c1eb5978",
"e52072da-8d95-450e-8254-386606424e01"
],
"Users": [
"cc796ce7-09d1-411a-b953-4546df8a9c46",
"8c920f02-a6b3-46df-83ac-9c960e79af26"
]
},
{
"Id": "de10bb55-51ab-4b4e-a75e-31e329e27346",
"UPN": "eadd3478-aeb4-4415-a536-a3729753aea9",
"PostDate": "2026-10-30T21:03:32.8117699+00:00",
"Comment": "sample string 4",
"CC": [
"d710c6ca-c091-4709-ba92-56a9c1eb5978",
"e52072da-8d95-450e-8254-386606424e01"
],
"Users": [
"cc796ce7-09d1-411a-b953-4546df8a9c46",
"8c920f02-a6b3-46df-83ac-9c960e79af26"
]
}
],
"StartDate": "2026-10-30T21:03:32.8117699+00:00",
"DueDate": "2026-10-30T21:03:32.8117699+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b5ea81bc-5ae8-40ae-810c-83d367e3e12d": "ff2d8d71-f73a-4549-8cb5-652cda218948",
"e168d802-0342-444f-8496-aa583160f8d3": "922b7849-6bb2-433b-baa1-92184bf6ad31"
},
"HasUpdates": true,
"Modified": "2026-10-30T21:03:32.8117699+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-30T21:03:32.8117699+00:00"
},
"LastComment": "2026-10-30T21:03:32.8117699+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8c3e85e7-baac-4cf6-9bb5-be13522448d5",
"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": "0a631626-cf57-41d8-883b-d7872d00efb1",
"id": "55e60d10-1915-4b45-ba92-1535c56c06be",
"ConfigId": "42eeacbe-67e3-4de3-a2ad-f33dc4cadb88"
}