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": "acc6836b-7325-4e8f-8069-2ff1fcb0c6df",
"ParentTaskId": "5d2b2c64-fab4-454f-9fed-1af70f02d6ac",
"Integration": {
"IntegrationId": "a4f2d1db-0394-4e61-9291-8aa975993e0d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c421b047-09a0-45de-9bf4-04312d64951c": 2.0,
"ac0953b9-42fb-464e-991f-3746f50976a8": 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": "752c9467-13a2-426d-b86c-cdcacd686b3e",
"Name": "sample string 1",
"Created": "2026-09-04T09:45:12.1609368+00:00",
"Modified": "2026-09-04T09:45:12.1609368+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"34d9aee7-bf7c-4149-9707-b1289acd45de",
"370152ab-8e23-48b6-9ebb-cf66d0d76b9e"
],
"NonLaborAssignments": [
{
"Id": "a0e9546a-3351-426b-9838-e9badb276eb6",
"ResourceId": "68e2d9e1-28dd-4271-8154-8f28c323c936",
"Quantity": 3.0
},
{
"Id": "a0e9546a-3351-426b-9838-e9badb276eb6",
"ResourceId": "68e2d9e1-28dd-4271-8154-8f28c323c936",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "79ef0cac-0146-4815-a364-684acfb366dc",
"Type": 0,
"ResourceId": "268c6fa6-2b9c-46a4-b78f-aefbcf58bc92",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6208b604-1ddf-4537-b350-bea1019b7157",
"Start": "2026-09-04T09:45:12.1609368+00:00",
"Due": "2026-09-04T09:45:12.1609368+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6208b604-1ddf-4537-b350-bea1019b7157",
"Start": "2026-09-04T09:45:12.1609368+00:00",
"Due": "2026-09-04T09:45:12.1609368+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "79ef0cac-0146-4815-a364-684acfb366dc",
"Type": 0,
"ResourceId": "268c6fa6-2b9c-46a4-b78f-aefbcf58bc92",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6208b604-1ddf-4537-b350-bea1019b7157",
"Start": "2026-09-04T09:45:12.1609368+00:00",
"Due": "2026-09-04T09:45:12.1609368+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6208b604-1ddf-4537-b350-bea1019b7157",
"Start": "2026-09-04T09:45:12.1609368+00:00",
"Due": "2026-09-04T09:45:12.1609368+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "affaf55b-732d-4c8a-8322-cdd98fe20dda",
"WorkTypeParentId": "9ddcb229-2723-48fe-a31d-d30d83565857",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bc9079d7-0d03-4fe3-8582-03c2b557a82e",
"UPN": "984604f7-8719-4ef1-9884-2d60f59a94fe",
"PostDate": "2026-09-04T09:45:12.1609368+00:00",
"Comment": "sample string 4",
"CC": [
"610c57a6-1eb2-4590-840a-41610839d478",
"15ddc947-c5d1-4d19-9740-3f2680e6893c"
],
"Users": [
"ac0e9314-1fa9-442e-a8ed-09b1fe04c362",
"da0ff3ea-2cb8-4488-ac68-9d05a2ae9c25"
]
},
{
"Id": "bc9079d7-0d03-4fe3-8582-03c2b557a82e",
"UPN": "984604f7-8719-4ef1-9884-2d60f59a94fe",
"PostDate": "2026-09-04T09:45:12.1609368+00:00",
"Comment": "sample string 4",
"CC": [
"610c57a6-1eb2-4590-840a-41610839d478",
"15ddc947-c5d1-4d19-9740-3f2680e6893c"
],
"Users": [
"ac0e9314-1fa9-442e-a8ed-09b1fe04c362",
"da0ff3ea-2cb8-4488-ac68-9d05a2ae9c25"
]
}
],
"StartDate": "2026-09-04T09:45:12.1609368+00:00",
"DueDate": "2026-09-04T09:45:12.1609368+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b5f1782f-8afd-4420-9a46-2a36ded97c51": "0cca87d1-c7e8-40d1-a298-1f60319f7dfb",
"2bf4224b-9adf-46bd-a725-dd8a6bfe24c0": "1328e208-0d20-497a-a30d-cbb811153a85"
},
"HasUpdates": true,
"Modified": "2026-09-04T09:45:12.1609368+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-04T09:45:12.1609368+00:00"
},
"LastComment": "2026-09-04T09:45:12.1609368+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c00b8382-7003-41b8-9af0-3dba6912ce95",
"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": "ac817aa5-7a4a-4a68-a849-2ed4360e9d36",
"id": "89b399c0-e9ba-457b-8e22-8366a3fa94eb",
"ConfigId": "98702e54-152f-4aff-9c48-5817241aa06e"
}