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": "cbb55b80-312d-49bb-a8a5-419a6b8e83c6",
"ParentTaskId": "8e62ff54-b3e4-488d-af8f-f348ee905526",
"Integration": {
"IntegrationId": "8f105f87-0c4e-4f4e-a6a8-2c9d6e41378f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a7e04adb-30c4-496c-9738-33f44ca13814": 2.0,
"7bbf412c-8a48-4980-b1af-1aee004ee5cb": 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": "b0830fc2-4541-4a68-a600-f390daee5fbd",
"Name": "sample string 1",
"Created": "2026-09-29T05:31:31.4196209+00:00",
"Modified": "2026-09-29T05:31:31.4196209+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"77734b62-d30e-494c-ba83-f9b36e568a4f",
"1c63cba1-2344-4811-82e8-035001dcc406"
],
"NonLaborAssignments": [
{
"Id": "340a1472-8aa6-486b-b839-11fddee20b68",
"ResourceId": "b1dc08af-85af-4aed-ad0b-89b3e66df878",
"Quantity": 3.0
},
{
"Id": "340a1472-8aa6-486b-b839-11fddee20b68",
"ResourceId": "b1dc08af-85af-4aed-ad0b-89b3e66df878",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "74770224-4fc7-41d3-9276-cb7420402e1d",
"Type": 0,
"ResourceId": "727a10a8-0fea-448f-9244-4550d8dafa2d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f9e145df-1688-4686-84b6-3722568f9580",
"Start": "2026-09-29T05:31:31.4196209+00:00",
"Due": "2026-09-29T05:31:31.4196209+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f9e145df-1688-4686-84b6-3722568f9580",
"Start": "2026-09-29T05:31:31.4196209+00:00",
"Due": "2026-09-29T05:31:31.4196209+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "74770224-4fc7-41d3-9276-cb7420402e1d",
"Type": 0,
"ResourceId": "727a10a8-0fea-448f-9244-4550d8dafa2d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f9e145df-1688-4686-84b6-3722568f9580",
"Start": "2026-09-29T05:31:31.4196209+00:00",
"Due": "2026-09-29T05:31:31.4196209+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f9e145df-1688-4686-84b6-3722568f9580",
"Start": "2026-09-29T05:31:31.4196209+00:00",
"Due": "2026-09-29T05:31:31.4196209+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "daa86d9e-d73f-402e-936b-ae9774ecf38a",
"WorkTypeParentId": "3baa7edd-bb64-4da1-9895-8adfa5e08412",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b2e14c56-a7be-4fdc-ab81-09a6346cdf46",
"UPN": "b6d204ba-1352-49b1-a09a-949b356208d5",
"PostDate": "2026-09-29T05:31:31.4196209+00:00",
"Comment": "sample string 4",
"CC": [
"3d2cfe03-4d63-4e35-942e-3aab56a62112",
"354207b2-577a-44b7-a61a-c4566f2628a3"
],
"Users": [
"2a0f39d3-4007-4227-802c-ce0b6bd17b22",
"058251b8-7870-4b91-9157-6975b5b38d96"
]
},
{
"Id": "b2e14c56-a7be-4fdc-ab81-09a6346cdf46",
"UPN": "b6d204ba-1352-49b1-a09a-949b356208d5",
"PostDate": "2026-09-29T05:31:31.4196209+00:00",
"Comment": "sample string 4",
"CC": [
"3d2cfe03-4d63-4e35-942e-3aab56a62112",
"354207b2-577a-44b7-a61a-c4566f2628a3"
],
"Users": [
"2a0f39d3-4007-4227-802c-ce0b6bd17b22",
"058251b8-7870-4b91-9157-6975b5b38d96"
]
}
],
"StartDate": "2026-09-29T05:31:31.4196209+00:00",
"DueDate": "2026-09-29T05:31:31.4196209+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"111d8f5d-53a6-4168-8b48-c0aec599680d": "7a84927f-687d-4f30-aadb-47d18a24f76f",
"e8e4f8a1-2dce-451e-a315-f161790b85a0": "b86155e9-364a-4a1a-ad2c-ebf716505c21"
},
"HasUpdates": true,
"Modified": "2026-09-29T05:31:31.4196209+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-09-29T05:31:31.4196209+00:00"
},
"LastComment": "2026-09-29T05:31:31.4196209+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "085946a2-fac6-41d9-932f-d8b4dbd9f203",
"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": "b98caf3c-78de-4ccd-81a8-e2dc2bc5997b",
"id": "afa8653a-1028-4124-aa4f-31b6f334fcd1",
"ConfigId": "bcb49be2-4eaa-4b22-a446-deb5ca46abdd"
}