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": "c04a2d6f-b959-4efc-934b-7f8b50b7729e",
"ParentTaskId": "07ef1d36-79a1-4c75-9c80-33bd7de6ec61",
"Integration": {
"IntegrationId": "5f86ca0a-5abf-42e6-a750-e8faf4a52e16",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9399d0ad-b443-496a-b57f-64f2a81c0f21": 2.0,
"6b4a775d-28c9-4fd9-ae4b-939fec5a3311": 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": "85fc150b-21d6-456f-8509-c7d44ee7e971",
"Name": "sample string 1",
"Created": "2026-10-05T17:09:06.701307+00:00",
"Modified": "2026-10-05T17:09:06.701307+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ff206eca-3f73-44d8-9c25-b8ff90c7baa5",
"d5920ee0-b447-4baf-b1bc-70675b34bf55"
],
"NonLaborAssignments": [
{
"Id": "eda46a92-8cc4-4a9d-809f-b0e098089806",
"ResourceId": "fc08f9c8-cd2a-48d6-b9eb-af2d5c7ee2bb",
"Quantity": 3.0
},
{
"Id": "eda46a92-8cc4-4a9d-809f-b0e098089806",
"ResourceId": "fc08f9c8-cd2a-48d6-b9eb-af2d5c7ee2bb",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e24848fb-17b5-41f4-afd1-31ba0aeef741",
"Type": 0,
"ResourceId": "c6a08e44-e57c-43ae-bbcb-a5cf03b889da",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "db0fcb19-eb99-45a8-9f34-d793e5e8ffcc",
"Start": "2026-10-05T17:09:06.701307+00:00",
"Due": "2026-10-05T17:09:06.701307+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "db0fcb19-eb99-45a8-9f34-d793e5e8ffcc",
"Start": "2026-10-05T17:09:06.701307+00:00",
"Due": "2026-10-05T17:09:06.701307+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "e24848fb-17b5-41f4-afd1-31ba0aeef741",
"Type": 0,
"ResourceId": "c6a08e44-e57c-43ae-bbcb-a5cf03b889da",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "db0fcb19-eb99-45a8-9f34-d793e5e8ffcc",
"Start": "2026-10-05T17:09:06.701307+00:00",
"Due": "2026-10-05T17:09:06.701307+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "db0fcb19-eb99-45a8-9f34-d793e5e8ffcc",
"Start": "2026-10-05T17:09:06.701307+00:00",
"Due": "2026-10-05T17:09:06.701307+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "07b22ef5-03d7-43e7-9843-7d2a5b27ca84",
"WorkTypeParentId": "58e96a99-fbd8-41a3-8edf-093c80abbcf9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "753b487f-d696-485b-ad30-2df87d96569e",
"UPN": "a28ff029-3242-4bdd-9534-2baa404ff4b0",
"PostDate": "2026-10-05T17:09:06.701307+00:00",
"Comment": "sample string 4",
"CC": [
"ac47e366-4f38-4881-821a-0f0dcb46b4ce",
"6da7cfa0-a366-4ce1-a01c-2df8c378123e"
],
"Users": [
"9c7d5cd0-c96f-4784-aeb3-9d5578593bb7",
"8880a69a-4fa9-4c14-8901-53fb2d79ca7e"
]
},
{
"Id": "753b487f-d696-485b-ad30-2df87d96569e",
"UPN": "a28ff029-3242-4bdd-9534-2baa404ff4b0",
"PostDate": "2026-10-05T17:09:06.701307+00:00",
"Comment": "sample string 4",
"CC": [
"ac47e366-4f38-4881-821a-0f0dcb46b4ce",
"6da7cfa0-a366-4ce1-a01c-2df8c378123e"
],
"Users": [
"9c7d5cd0-c96f-4784-aeb3-9d5578593bb7",
"8880a69a-4fa9-4c14-8901-53fb2d79ca7e"
]
}
],
"StartDate": "2026-10-05T17:09:06.701307+00:00",
"DueDate": "2026-10-05T17:09:06.701307+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d6ea3aff-1fe6-4756-b748-149898819a1e": "598b0d33-6abc-4c17-9ad9-ea23f9c28a40",
"321d7dad-f3a6-4013-b3c0-a219b03630db": "136c4a7c-68af-4165-a2a3-45483f7130df"
},
"HasUpdates": true,
"Modified": "2026-10-05T17:09:06.701307+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-05T17:09:06.701307+00:00"
},
"LastComment": "2026-10-05T17:09:06.701307+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "883b978b-5830-4a34-a46f-e2bd97b60f2e",
"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": "810eb72e-fc8b-4613-ba6d-a8b3fe6a4900",
"id": "052383d7-1311-4d7c-b4f6-b5776f04afbf",
"ConfigId": "aa92ea2a-fd15-4e52-bedd-59018a91134e"
}