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": "a9c2dcbb-bfe0-4c69-9d19-b4f8d1daba53",
"ParentTaskId": "2651c764-32cc-48d7-9a8e-920f065d7937",
"Integration": {
"IntegrationId": "b791f35d-b5a0-44a3-a83d-e400b7d37be0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"66a7a2c5-efff-484f-8abd-371d1b413d96": 2.0,
"aa6fd61b-0454-4caa-9ff5-5650e3704353": 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": "944a0708-5a70-4b8b-a0ba-adbd6860f135",
"Name": "sample string 1",
"Created": "2026-10-09T23:41:29.9845471+00:00",
"Modified": "2026-10-09T23:41:29.9845471+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"900617cc-38d3-42a8-b3fd-3c3d83e836d6",
"4c6d1340-052e-4151-a293-1e060177636b"
],
"NonLaborAssignments": [
{
"Id": "3464c914-6485-4311-8168-2ee5df26c5a7",
"ResourceId": "bfe7edfb-3555-4c2d-9c1d-156f6ab95ec6",
"Quantity": 3.0
},
{
"Id": "3464c914-6485-4311-8168-2ee5df26c5a7",
"ResourceId": "bfe7edfb-3555-4c2d-9c1d-156f6ab95ec6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "148e52be-f3df-4c0a-82c4-efc1736970a9",
"Type": 0,
"ResourceId": "f8e79698-3024-4e3c-9b6e-522a3f882eb0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2b5ad4e4-e383-44ae-a9b4-ee64edda8689",
"Start": "2026-10-09T23:41:29.9845471+00:00",
"Due": "2026-10-09T23:41:29.9845471+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2b5ad4e4-e383-44ae-a9b4-ee64edda8689",
"Start": "2026-10-09T23:41:29.9845471+00:00",
"Due": "2026-10-09T23:41:29.9845471+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "148e52be-f3df-4c0a-82c4-efc1736970a9",
"Type": 0,
"ResourceId": "f8e79698-3024-4e3c-9b6e-522a3f882eb0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2b5ad4e4-e383-44ae-a9b4-ee64edda8689",
"Start": "2026-10-09T23:41:29.9845471+00:00",
"Due": "2026-10-09T23:41:29.9845471+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2b5ad4e4-e383-44ae-a9b4-ee64edda8689",
"Start": "2026-10-09T23:41:29.9845471+00:00",
"Due": "2026-10-09T23:41:29.9845471+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "16bca9b7-d0ea-4fe1-b337-2d9b0b465244",
"WorkTypeParentId": "679507b4-4d57-4137-a500-6a5125feb161",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "401904f0-2385-4c7a-8ecd-d97e4bee45d8",
"UPN": "13c814c0-649a-4d37-aacf-00ff180c0b8b",
"PostDate": "2026-10-09T23:41:29.9845471+00:00",
"Comment": "sample string 4",
"CC": [
"d6928079-9f8f-4cf5-9de5-13a06cbbfc92",
"3310d349-02de-4b8f-8146-230da3338208"
],
"Users": [
"2dfdd31e-31ea-4d6c-bc29-8718bba4f7df",
"ada97c02-ebc8-4fb3-a42b-63cd640a93bd"
]
},
{
"Id": "401904f0-2385-4c7a-8ecd-d97e4bee45d8",
"UPN": "13c814c0-649a-4d37-aacf-00ff180c0b8b",
"PostDate": "2026-10-09T23:41:29.9845471+00:00",
"Comment": "sample string 4",
"CC": [
"d6928079-9f8f-4cf5-9de5-13a06cbbfc92",
"3310d349-02de-4b8f-8146-230da3338208"
],
"Users": [
"2dfdd31e-31ea-4d6c-bc29-8718bba4f7df",
"ada97c02-ebc8-4fb3-a42b-63cd640a93bd"
]
}
],
"StartDate": "2026-10-09T23:41:29.9845471+00:00",
"DueDate": "2026-10-09T23:41:29.9845471+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"aadd997d-73a7-4b52-92d1-deb2e69317c5": "184caf9d-9795-4d17-926c-f6cd10ea4738",
"28431a1b-0a5c-436c-9650-2c9d6d958254": "723cdef4-0800-45da-8326-5c6b6065d19f"
},
"HasUpdates": true,
"Modified": "2026-10-09T23:41:29.9845471+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-09T23:41:29.9845471+00:00"
},
"LastComment": "2026-10-09T23:41:29.9845471+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "055ad636-7cc0-45e4-accb-a899ee1da2cc",
"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": "4de0baf1-4437-4304-9a9a-3ddc95b35ecd",
"id": "ff9c0473-cfb6-4cec-8868-0f6fd2bbd55d",
"ConfigId": "48428e5b-b095-4539-aa56-e3b8fd5e7e43"
}