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": "ed3e4e28-503f-47d2-8bd9-ad4fd142d5be",
"ParentTaskId": "90c17524-2ff3-4045-9695-3f5347f3d8f5",
"Integration": {
"IntegrationId": "5513060e-7c60-4faa-b85f-ed5369d05ad2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0738424b-6c08-434f-bd1d-5f1892bf3bcb": 2.0,
"448b1b5f-5fd3-4458-b2c9-26a4bbcddaba": 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": "2d8de62a-447e-4768-b8dd-07502f3a90a3",
"Name": "sample string 1",
"Created": "2026-10-28T05:58:40.9484246+00:00",
"Modified": "2026-10-28T05:58:40.9484246+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"35fb8897-31dc-46ca-9c7e-20cf8442d415",
"de70bd72-fc95-4540-8d78-5bd0e630b08f"
],
"NonLaborAssignments": [
{
"Id": "55132a13-200b-4e8f-972b-7db126614756",
"ResourceId": "f0db0953-561a-4690-9df3-69fdc40fa7d9",
"Quantity": 3.0
},
{
"Id": "55132a13-200b-4e8f-972b-7db126614756",
"ResourceId": "f0db0953-561a-4690-9df3-69fdc40fa7d9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c5444eb6-48c6-43a7-b584-934722a13eb5",
"Type": 0,
"ResourceId": "13ba61ee-bc97-4003-b734-42791be820f0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "32be3f6b-c98f-470f-9eb2-11612b55c2b4",
"Start": "2026-10-28T05:58:40.9484246+00:00",
"Due": "2026-10-28T05:58:40.9484246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "32be3f6b-c98f-470f-9eb2-11612b55c2b4",
"Start": "2026-10-28T05:58:40.9484246+00:00",
"Due": "2026-10-28T05:58:40.9484246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "c5444eb6-48c6-43a7-b584-934722a13eb5",
"Type": 0,
"ResourceId": "13ba61ee-bc97-4003-b734-42791be820f0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "32be3f6b-c98f-470f-9eb2-11612b55c2b4",
"Start": "2026-10-28T05:58:40.9484246+00:00",
"Due": "2026-10-28T05:58:40.9484246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "32be3f6b-c98f-470f-9eb2-11612b55c2b4",
"Start": "2026-10-28T05:58:40.9484246+00:00",
"Due": "2026-10-28T05:58:40.9484246+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "dbc3474a-51f8-4507-a952-020d4608517a",
"WorkTypeParentId": "1111cdad-60a4-4012-b0b2-47cf2ec0d0ed",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "1a8d490a-c6e0-4bab-a971-8fc5d78a00be",
"UPN": "12bdc44f-254e-48eb-8ec4-7c84518697d1",
"PostDate": "2026-10-28T05:58:40.9484246+00:00",
"Comment": "sample string 4",
"CC": [
"5b8da5aa-6488-4c51-9d46-a79dc2af8eea",
"8a2c73d1-d1eb-4785-b85a-4c8964681e2d"
],
"Users": [
"4b782dfc-dfc2-4831-a7bf-4267a3e4e8dc",
"0f3df11f-41bf-4c4c-9b63-337703c7f581"
]
},
{
"Id": "1a8d490a-c6e0-4bab-a971-8fc5d78a00be",
"UPN": "12bdc44f-254e-48eb-8ec4-7c84518697d1",
"PostDate": "2026-10-28T05:58:40.9484246+00:00",
"Comment": "sample string 4",
"CC": [
"5b8da5aa-6488-4c51-9d46-a79dc2af8eea",
"8a2c73d1-d1eb-4785-b85a-4c8964681e2d"
],
"Users": [
"4b782dfc-dfc2-4831-a7bf-4267a3e4e8dc",
"0f3df11f-41bf-4c4c-9b63-337703c7f581"
]
}
],
"StartDate": "2026-10-28T05:58:40.9484246+00:00",
"DueDate": "2026-10-28T05:58:40.9484246+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"43fb66cc-bc7e-43fa-8dfe-d45666e2248b": "4101e6bd-228f-42ac-9c24-cbddb8bde743",
"6ca3961e-f5c5-44fa-b0e2-c7a360c065f3": "658d3a9a-fb75-466a-82fd-5ef814bfc778"
},
"HasUpdates": true,
"Modified": "2026-10-28T05:58:40.9484246+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-28T05:58:40.9484246+00:00"
},
"LastComment": "2026-10-28T05:58:40.9484246+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "00678a5a-0705-44a9-8817-a7783f0f4268",
"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": "009a72ed-5263-4ac5-8d4f-e698f7844fb2",
"id": "78b9ea95-44ab-480b-ae06-629d260f3fb3",
"ConfigId": "8c6f4237-a9ef-48e1-b8cc-d8a96e3db61e"
}