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": "0ec0f678-4b29-4e75-9266-9d3f0a4c4d11",
"ParentTaskId": "18bdbda9-868f-4b28-9024-c439ed560024",
"Integration": {
"IntegrationId": "b2f42d4e-ebe1-4c42-87f0-a0afc9978e1b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1a4aaad3-e7a5-410a-8508-65237da338d4": 2.0,
"7d52889e-2809-4553-aecd-dae7a8ce4b0d": 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": "79794776-ee13-46c5-8845-d9c7c04f1617",
"Name": "sample string 1",
"Created": "2026-11-06T13:32:13.147401+00:00",
"Modified": "2026-11-06T13:32:13.147401+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5b32e158-5d50-4892-8652-d34ea24bf948",
"95fd281c-af1f-40e5-965e-4203752fc867"
],
"NonLaborAssignments": [
{
"Id": "b91dd5b3-cd6a-4245-af51-126303398f1f",
"ResourceId": "57f93060-e13a-4d19-ae5c-cca1a167e22c",
"Quantity": 3.0
},
{
"Id": "b91dd5b3-cd6a-4245-af51-126303398f1f",
"ResourceId": "57f93060-e13a-4d19-ae5c-cca1a167e22c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "80143962-0a29-48eb-a689-2696c6701a52",
"Type": 0,
"ResourceId": "6fe98bd5-f856-4ba7-b867-400d02c1ebca",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c135b02e-6223-4aff-a073-94bd2c553204",
"Start": "2026-11-06T13:32:13.147401+00:00",
"Due": "2026-11-06T13:32:13.147401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c135b02e-6223-4aff-a073-94bd2c553204",
"Start": "2026-11-06T13:32:13.147401+00:00",
"Due": "2026-11-06T13:32:13.147401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "80143962-0a29-48eb-a689-2696c6701a52",
"Type": 0,
"ResourceId": "6fe98bd5-f856-4ba7-b867-400d02c1ebca",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c135b02e-6223-4aff-a073-94bd2c553204",
"Start": "2026-11-06T13:32:13.147401+00:00",
"Due": "2026-11-06T13:32:13.147401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c135b02e-6223-4aff-a073-94bd2c553204",
"Start": "2026-11-06T13:32:13.147401+00:00",
"Due": "2026-11-06T13:32:13.147401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "bf2de130-b932-4a19-a942-685fb9aba7a3",
"WorkTypeParentId": "1238e33e-edbc-41af-b41d-c8580504c17f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a4977eb2-1a48-4089-98d1-95bf4954c485",
"UPN": "a41f0a34-b638-44e2-9a39-4a1d514c87c2",
"PostDate": "2026-11-06T13:32:13.147401+00:00",
"Comment": "sample string 4",
"CC": [
"4aa7ab86-c6ff-4daf-9306-23781d6056f0",
"8ad8ef52-35ed-4ac4-a26b-141822ca1f91"
],
"Users": [
"dac96517-d5a9-43fa-9c1c-d8b8962caa3e",
"f2b48c27-da19-434a-a937-de8919cbd6dc"
]
},
{
"Id": "a4977eb2-1a48-4089-98d1-95bf4954c485",
"UPN": "a41f0a34-b638-44e2-9a39-4a1d514c87c2",
"PostDate": "2026-11-06T13:32:13.147401+00:00",
"Comment": "sample string 4",
"CC": [
"4aa7ab86-c6ff-4daf-9306-23781d6056f0",
"8ad8ef52-35ed-4ac4-a26b-141822ca1f91"
],
"Users": [
"dac96517-d5a9-43fa-9c1c-d8b8962caa3e",
"f2b48c27-da19-434a-a937-de8919cbd6dc"
]
}
],
"StartDate": "2026-11-06T13:32:13.147401+00:00",
"DueDate": "2026-11-06T13:32:13.147401+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7ba0c04d-f157-4367-9258-e7ef76eaf762": "875bc1ae-cedd-42c7-b8f1-d8867b50f601",
"3325f553-e772-45fa-b2a4-a0c4ab02519f": "74b41759-49ad-4d95-9b79-bd1145ea4c9e"
},
"HasUpdates": true,
"Modified": "2026-11-06T13:32:13.147401+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-11-06T13:32:13.147401+00:00"
},
"LastComment": "2026-11-06T13:32:13.147401+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "821157d8-4619-4214-9f42-17b432883314",
"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": "ce28167b-9ae2-4e7f-b9e3-09961e5a5e83",
"id": "ee31edc5-aa2a-44b6-9462-835195c1b4bb",
"ConfigId": "24cdbaf3-f881-4c23-b7c5-86167f05b126"
}