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": "9427481e-6afb-4d91-a412-795135b0575b",
"ParentTaskId": "5b0499ae-ed12-4265-b068-b1946c5ea8d1",
"Integration": {
"IntegrationId": "236d6970-e91f-48d3-9612-e2a79a66e926",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7ba141b4-a910-4327-b710-6e6c7ab7dc78": 2.0,
"ed6dcf41-3c72-4592-9cba-2bd7ea621f30": 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": "b2d1ac59-5d3e-4189-a664-859f06692996",
"Name": "sample string 1",
"Created": "2026-10-26T09:56:25.4909434+00:00",
"Modified": "2026-10-26T09:56:25.4909434+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d737b1eb-dc67-4b28-8a49-717a3ebf3793",
"9e04c851-ff32-4804-b73f-d0e23dc38b66"
],
"NonLaborAssignments": [
{
"Id": "0cc6e78c-fdc7-41fe-8149-aa1944fab0e9",
"ResourceId": "c8665f75-ee58-45ab-87cc-73a1923e03d7",
"Quantity": 3.0
},
{
"Id": "0cc6e78c-fdc7-41fe-8149-aa1944fab0e9",
"ResourceId": "c8665f75-ee58-45ab-87cc-73a1923e03d7",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6da3830a-da77-464c-8d07-85ba2bc096c8",
"Type": 0,
"ResourceId": "ef5a2ca4-9c8b-47b2-a224-59bdfa262aa0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b1416ab1-7a39-45b3-b8c3-07c3fd579cd2",
"Start": "2026-10-26T09:56:25.4909434+00:00",
"Due": "2026-10-26T09:56:25.4909434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b1416ab1-7a39-45b3-b8c3-07c3fd579cd2",
"Start": "2026-10-26T09:56:25.4909434+00:00",
"Due": "2026-10-26T09:56:25.4909434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "6da3830a-da77-464c-8d07-85ba2bc096c8",
"Type": 0,
"ResourceId": "ef5a2ca4-9c8b-47b2-a224-59bdfa262aa0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b1416ab1-7a39-45b3-b8c3-07c3fd579cd2",
"Start": "2026-10-26T09:56:25.4909434+00:00",
"Due": "2026-10-26T09:56:25.4909434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b1416ab1-7a39-45b3-b8c3-07c3fd579cd2",
"Start": "2026-10-26T09:56:25.4909434+00:00",
"Due": "2026-10-26T09:56:25.4909434+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "fc84dcf3-979d-4d09-862f-da7f224c2e7a",
"WorkTypeParentId": "cb3463fb-5afa-498e-8a00-95d38b858c60",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "71df9e11-e1fb-442a-a0a4-9fc0178119c3",
"UPN": "c8bb436d-436f-4161-9a93-f7586a695e9e",
"PostDate": "2026-10-26T09:56:25.4909434+00:00",
"Comment": "sample string 4",
"CC": [
"2b53923a-84d0-4676-baa5-f7bd27017b6c",
"cce442cc-ae75-48a2-9516-cceb64011714"
],
"Users": [
"c754fab4-8b03-4f79-acbc-abd6a8f85232",
"7354ea9b-4256-4ae3-9948-9df11304b11a"
]
},
{
"Id": "71df9e11-e1fb-442a-a0a4-9fc0178119c3",
"UPN": "c8bb436d-436f-4161-9a93-f7586a695e9e",
"PostDate": "2026-10-26T09:56:25.4909434+00:00",
"Comment": "sample string 4",
"CC": [
"2b53923a-84d0-4676-baa5-f7bd27017b6c",
"cce442cc-ae75-48a2-9516-cceb64011714"
],
"Users": [
"c754fab4-8b03-4f79-acbc-abd6a8f85232",
"7354ea9b-4256-4ae3-9948-9df11304b11a"
]
}
],
"StartDate": "2026-10-26T09:56:25.4909434+00:00",
"DueDate": "2026-10-26T09:56:25.4909434+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"349040f0-d7cc-4ded-b7a1-0748be9684a9": "9cc8699a-3bc0-4bdf-9fbd-5d3764823bfb",
"0d7265ab-4ec7-401a-bdc3-3c65b6691957": "7a25aa65-3991-46a8-a44e-b33697fdd8c1"
},
"HasUpdates": true,
"Modified": "2026-10-26T09:56:25.4909434+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-26T09:56:25.4909434+00:00"
},
"LastComment": "2026-10-26T09:56:25.4909434+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d569e410-069f-4ef7-9c73-ada52158aab3",
"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": "c2aad3d9-4f56-490a-9040-18c9284b54ce",
"id": "c2cacc4f-9199-4ffc-baf8-f66c5f4652e0",
"ConfigId": "e95fcabe-af1a-43e1-ba48-3afbb26514f8"
}