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": "09a06ac6-8d9a-4ca6-af18-5e8afcd0a021",
"ParentTaskId": "3386fc90-8ec5-4bdd-acfe-41422824a53e",
"Integration": {
"IntegrationId": "9c9a1d26-c894-43de-93cd-20bb5e873aef",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2b41bc19-731b-4f99-8c12-82193b508c65": 2.0,
"39201ce7-9c80-4907-a122-d50c59f03675": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "fb640b8b-5d10-4110-9ce6-6efd0a491883",
"Name": "sample string 1",
"Created": "2025-11-25T15:11:59.0183895+00:00",
"Modified": "2025-11-25T15:11:59.0183895+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"064fcd57-cb85-4af8-b48e-8491c91b00ce",
"191b0f52-5c5a-4c2b-93fe-7b815aff71c7"
],
"NonLaborAssignments": [
{
"Id": "69032318-0810-4e5a-a992-291dd0801a4b",
"ResourceId": "4a1a337e-dd90-453f-8dd2-385e24c1b4ae",
"Quantity": 3.0
},
{
"Id": "69032318-0810-4e5a-a992-291dd0801a4b",
"ResourceId": "4a1a337e-dd90-453f-8dd2-385e24c1b4ae",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3bdeb1d2-d11e-4a62-b46a-1bdf1deae5c5",
"Type": 0,
"ResourceId": "689259c0-038a-4daa-9ef6-3d5117359b6c",
"Units": 3.0
},
{
"Id": "3bdeb1d2-d11e-4a62-b46a-1bdf1deae5c5",
"Type": 0,
"ResourceId": "689259c0-038a-4daa-9ef6-3d5117359b6c",
"Units": 3.0
}
],
"ParentId": "48b2d3ea-2ff0-4fb4-9d7e-77f00817508c",
"WorkTypeParentId": "5517ed0c-43bf-434c-9bad-ef3ed4140d95",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bf05a3b1-fd56-4699-9f86-02213c19706a",
"UPN": "6f72255e-d156-42f9-8779-3f65e26338a6",
"PostDate": "2025-11-25T15:11:59.0183895+00:00",
"Comment": "sample string 4",
"CC": [
"a2fd4b6f-4b6d-4312-9d79-14fe366eaa7d",
"b0283283-3073-44f7-954d-beb739ba4ab4"
],
"Users": [
"5d07440e-e08e-4378-8567-40f775e48030",
"1759d12e-9f75-4113-91e7-1e8d65f83684"
]
},
{
"Id": "bf05a3b1-fd56-4699-9f86-02213c19706a",
"UPN": "6f72255e-d156-42f9-8779-3f65e26338a6",
"PostDate": "2025-11-25T15:11:59.0183895+00:00",
"Comment": "sample string 4",
"CC": [
"a2fd4b6f-4b6d-4312-9d79-14fe366eaa7d",
"b0283283-3073-44f7-954d-beb739ba4ab4"
],
"Users": [
"5d07440e-e08e-4378-8567-40f775e48030",
"1759d12e-9f75-4113-91e7-1e8d65f83684"
]
}
],
"StartDate": "2025-11-25T15:11:59.0183895+00:00",
"DueDate": "2025-11-25T15:11:59.0183895+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4323a652-6dc2-4c1f-b53b-6c4dafb30808": "b5834a0a-625a-4d50-a1f9-0b1b483460f7",
"26f3635d-5a08-4afa-980b-4ceeee47f27f": "2cf38173-81a0-47c5-ae12-6cbadd528d26"
},
"HasUpdates": true,
"Modified": "2025-11-25T15:11:59.0183895+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": "2025-11-25T15:11:59.0183895+00:00"
},
"LastComment": "2025-11-25T15:11:59.0183895+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0bc1ad1c-405c-4845-86b8-c0d0afe8f349",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "b8c3b9b1-a2ed-4488-9aff-3a3435943b05",
"id": "78957421-f740-4a91-8a02-c22b459138dd",
"ConfigId": "9d520dff-6e42-4c50-876c-5f2753ce2e94"
}