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": "92543045-9997-4b81-8f7a-b4a0dab3bb23",
"ParentTaskId": "bb3c033d-5f40-42ef-b36c-f525dd18c892",
"Integration": {
"IntegrationId": "364d5d49-131c-4928-93a4-93d4e9cd6fd6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"8a252cd8-1bbb-4399-a5b4-2b1336dfbd31": 2.0,
"188e189c-bb8b-493d-bab5-e854170e08f6": 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": "ba8a98f0-4dcc-4832-9656-6b51457832e6",
"Name": "sample string 1",
"Created": "2026-10-02T08:58:37.5071971+00:00",
"Modified": "2026-10-02T08:58:37.5071971+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d03d6069-1e3b-40b5-b627-df1c896203fb",
"33c6f121-af8e-40f9-8925-e612a9823b99"
],
"NonLaborAssignments": [
{
"Id": "22dd9471-afe8-4ca4-a655-41fc9e7ff47d",
"ResourceId": "5ab0f1f6-3483-418b-ba76-09a8c759b1ec",
"Quantity": 3.0
},
{
"Id": "22dd9471-afe8-4ca4-a655-41fc9e7ff47d",
"ResourceId": "5ab0f1f6-3483-418b-ba76-09a8c759b1ec",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "110140ba-6009-4b35-b9e8-81067c6ad13d",
"Type": 0,
"ResourceId": "38e44592-9eb9-4243-afbd-cde014db2604",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c4147a97-4a84-4d9d-868f-7d04440e674f",
"Start": "2026-10-02T08:58:37.5071971+00:00",
"Due": "2026-10-02T08:58:37.5071971+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c4147a97-4a84-4d9d-868f-7d04440e674f",
"Start": "2026-10-02T08:58:37.5071971+00:00",
"Due": "2026-10-02T08:58:37.5071971+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "110140ba-6009-4b35-b9e8-81067c6ad13d",
"Type": 0,
"ResourceId": "38e44592-9eb9-4243-afbd-cde014db2604",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c4147a97-4a84-4d9d-868f-7d04440e674f",
"Start": "2026-10-02T08:58:37.5071971+00:00",
"Due": "2026-10-02T08:58:37.5071971+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c4147a97-4a84-4d9d-868f-7d04440e674f",
"Start": "2026-10-02T08:58:37.5071971+00:00",
"Due": "2026-10-02T08:58:37.5071971+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "a70765cf-365c-4084-9f5f-3f8bc9e10083",
"WorkTypeParentId": "e912e2de-10bf-499d-98b2-4d3e1760d648",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "abe8dc79-92ca-4bc8-9a32-3354ac5cbe1d",
"UPN": "7f6e138c-ff21-4013-b11d-d282346819f9",
"PostDate": "2026-10-02T08:58:37.5071971+00:00",
"Comment": "sample string 4",
"CC": [
"e476ee6e-2f70-4d40-b47d-d5368b924d10",
"f1cda356-2143-404b-992b-7d3eb33e97bb"
],
"Users": [
"e65c4fb9-3639-46d2-b99c-152b1a760278",
"e9c3ae27-533d-48b2-92e3-25ac5105c4e0"
]
},
{
"Id": "abe8dc79-92ca-4bc8-9a32-3354ac5cbe1d",
"UPN": "7f6e138c-ff21-4013-b11d-d282346819f9",
"PostDate": "2026-10-02T08:58:37.5071971+00:00",
"Comment": "sample string 4",
"CC": [
"e476ee6e-2f70-4d40-b47d-d5368b924d10",
"f1cda356-2143-404b-992b-7d3eb33e97bb"
],
"Users": [
"e65c4fb9-3639-46d2-b99c-152b1a760278",
"e9c3ae27-533d-48b2-92e3-25ac5105c4e0"
]
}
],
"StartDate": "2026-10-02T08:58:37.5071971+00:00",
"DueDate": "2026-10-02T08:58:37.5071971+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b9b82b3a-836d-451d-859d-1e11c3e7a4b8": "8a12ea07-9c13-477d-aaae-91c63c09629e",
"d190f4fe-e0f3-4a17-be0c-5c13cde47b6c": "99763abb-7186-4b67-af0a-631bbe9a0d3e"
},
"HasUpdates": true,
"Modified": "2026-10-02T08:58:37.5071971+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-02T08:58:37.5071971+00:00"
},
"LastComment": "2026-10-02T08:58:37.5071971+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "09bb7486-ed66-422e-8c99-1e3545cd1f84",
"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": "7894b091-69b3-4d7d-affb-d1a4d1885cb2",
"id": "d97059d9-d0a0-40f7-9a58-09f33f99516c",
"ConfigId": "371b06d9-3c62-4dad-9a4f-4bed4f5951d2"
}