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": "435ee59a-7ec7-479b-9c72-1a7292ff6384",
"ParentTaskId": "8520f702-2ca1-4b6f-a0f8-12ebb33733f5",
"Integration": {
"IntegrationId": "e5f594d0-7034-4fc2-91ff-a8707147e611",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a79dbb54-9b24-4ee9-a5ad-c57eec5bf284": 2.0,
"5039d711-02cd-4724-adba-fb5a733c4c48": 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": "5de52971-0c2c-4c86-a07a-fcfa7af77e17",
"Name": "sample string 1",
"Created": "2026-09-20T19:35:06.2404522+00:00",
"Modified": "2026-09-20T19:35:06.2404522+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f49a7fb3-7272-46ef-868e-cb5829f1e882",
"00a4c025-341e-45b8-bdb0-ccd010f47a53"
],
"NonLaborAssignments": [
{
"Id": "9a16b3f0-fddd-41bf-b37f-842657e4b724",
"ResourceId": "eabca4fb-685f-4bc2-b4b7-2a1c6f803149",
"Quantity": 3.0
},
{
"Id": "9a16b3f0-fddd-41bf-b37f-842657e4b724",
"ResourceId": "eabca4fb-685f-4bc2-b4b7-2a1c6f803149",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7bf17500-4f65-4808-867c-e7048bab0996",
"Type": 0,
"ResourceId": "08860750-302d-4549-a48b-8752b6b1b0be",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b0e06720-92d1-4ab4-b159-a02a3aecaef3",
"Start": "2026-09-20T19:35:06.2404522+00:00",
"Due": "2026-09-20T19:35:06.2404522+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b0e06720-92d1-4ab4-b159-a02a3aecaef3",
"Start": "2026-09-20T19:35:06.2404522+00:00",
"Due": "2026-09-20T19:35:06.2404522+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7bf17500-4f65-4808-867c-e7048bab0996",
"Type": 0,
"ResourceId": "08860750-302d-4549-a48b-8752b6b1b0be",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b0e06720-92d1-4ab4-b159-a02a3aecaef3",
"Start": "2026-09-20T19:35:06.2404522+00:00",
"Due": "2026-09-20T19:35:06.2404522+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b0e06720-92d1-4ab4-b159-a02a3aecaef3",
"Start": "2026-09-20T19:35:06.2404522+00:00",
"Due": "2026-09-20T19:35:06.2404522+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "34672347-7b10-40ae-a7e3-c1c0f4a53c53",
"WorkTypeParentId": "7ae0fe48-5ace-416c-8b5a-be7ddb33ec53",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "57e694b1-5f78-4ded-9287-bc830dd7bfe9",
"UPN": "fc43c357-30ef-4771-b45d-2a697819f4dd",
"PostDate": "2026-09-20T19:35:06.2404522+00:00",
"Comment": "sample string 4",
"CC": [
"3ed72d83-5901-48fb-b782-7e68eba2a539",
"2a1e6e44-24c3-402d-b847-4e59afc5da34"
],
"Users": [
"ea2d8a2e-9445-4c2f-9365-75a45d922943",
"757cb0cf-fcc2-45c3-a126-cc2b5bde5aef"
]
},
{
"Id": "57e694b1-5f78-4ded-9287-bc830dd7bfe9",
"UPN": "fc43c357-30ef-4771-b45d-2a697819f4dd",
"PostDate": "2026-09-20T19:35:06.2404522+00:00",
"Comment": "sample string 4",
"CC": [
"3ed72d83-5901-48fb-b782-7e68eba2a539",
"2a1e6e44-24c3-402d-b847-4e59afc5da34"
],
"Users": [
"ea2d8a2e-9445-4c2f-9365-75a45d922943",
"757cb0cf-fcc2-45c3-a126-cc2b5bde5aef"
]
}
],
"StartDate": "2026-09-20T19:35:06.2404522+00:00",
"DueDate": "2026-09-20T19:35:06.2404522+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4e97d421-4b1f-40d6-8012-9f8c6b628725": "e50e2fa2-9f29-42a9-be6d-d80d1323de3d",
"f11ba753-0272-44f2-af8f-1baca2d9e864": "8de49d21-4753-41ff-99c5-5bf79c999530"
},
"HasUpdates": true,
"Modified": "2026-09-20T19:35:06.2404522+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-20T19:35:06.2404522+00:00"
},
"LastComment": "2026-09-20T19:35:06.2404522+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e3d5336a-099d-4eb1-8820-d60551cba40b",
"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": "81673f74-a94e-48f6-be1a-ba1583f34ed5",
"id": "db657cfe-e0e9-41de-a1b6-7cb6f65e2bf6",
"ConfigId": "485fa6db-bb62-493e-a9a2-636e8f024ece"
}