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": "5de08039-5c92-4960-84f8-397c184bff79",
"ParentTaskId": "4d50d10f-bf14-44b4-8676-978e97050dd6",
"Integration": {
"IntegrationId": "19bfa803-5bf6-4018-97f4-8d86f4991e7e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b742a396-e8cd-45f0-b495-fe241ab7fe5c": 2.0,
"bfd3f7c0-7735-4d17-b700-3a7b6f9d768b": 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": "2800e718-5653-49c9-bf39-050a8b86964b",
"Name": "sample string 1",
"Created": "2026-10-27T00:55:52.8403586+00:00",
"Modified": "2026-10-27T00:55:52.8403586+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"204bf0d3-343c-4a58-8935-5102c2b79b81",
"9e4a4e2c-4b42-4132-b10d-c839187f1148"
],
"NonLaborAssignments": [
{
"Id": "79971ba0-d80e-4349-b5a4-6503e3ed2963",
"ResourceId": "8daaa7dc-8b7b-44a4-bfc5-27b287e335bc",
"Quantity": 3.0
},
{
"Id": "79971ba0-d80e-4349-b5a4-6503e3ed2963",
"ResourceId": "8daaa7dc-8b7b-44a4-bfc5-27b287e335bc",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ea3e790e-ff87-4784-854c-da3035bcf98b",
"Type": 0,
"ResourceId": "bc329fd4-6f79-4979-bdde-2783deeb209a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c5d8f705-7bb3-459e-83ef-b35fda1e36cf",
"Start": "2026-10-27T00:55:52.8403586+00:00",
"Due": "2026-10-27T00:55:52.8403586+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c5d8f705-7bb3-459e-83ef-b35fda1e36cf",
"Start": "2026-10-27T00:55:52.8403586+00:00",
"Due": "2026-10-27T00:55:52.8403586+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "ea3e790e-ff87-4784-854c-da3035bcf98b",
"Type": 0,
"ResourceId": "bc329fd4-6f79-4979-bdde-2783deeb209a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c5d8f705-7bb3-459e-83ef-b35fda1e36cf",
"Start": "2026-10-27T00:55:52.8403586+00:00",
"Due": "2026-10-27T00:55:52.8403586+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c5d8f705-7bb3-459e-83ef-b35fda1e36cf",
"Start": "2026-10-27T00:55:52.8403586+00:00",
"Due": "2026-10-27T00:55:52.8403586+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "22275379-42da-416a-8899-31daf45b8a49",
"WorkTypeParentId": "35c53065-38ca-4f53-a5eb-a9ab4a1f62c6",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ca6c042f-3214-4402-82a0-27c9858fb340",
"UPN": "431d47d4-d443-494b-854a-8177d20d9831",
"PostDate": "2026-10-27T00:55:52.8403586+00:00",
"Comment": "sample string 4",
"CC": [
"7759d2d4-889e-430f-8e05-d46290fff48b",
"10fa0b96-4af1-48df-acf7-eebea09d7a83"
],
"Users": [
"09f579fa-7350-45a6-b0f7-80a35d45dd35",
"a756a1b9-0e3e-4ebd-884f-4770d387a670"
]
},
{
"Id": "ca6c042f-3214-4402-82a0-27c9858fb340",
"UPN": "431d47d4-d443-494b-854a-8177d20d9831",
"PostDate": "2026-10-27T00:55:52.8403586+00:00",
"Comment": "sample string 4",
"CC": [
"7759d2d4-889e-430f-8e05-d46290fff48b",
"10fa0b96-4af1-48df-acf7-eebea09d7a83"
],
"Users": [
"09f579fa-7350-45a6-b0f7-80a35d45dd35",
"a756a1b9-0e3e-4ebd-884f-4770d387a670"
]
}
],
"StartDate": "2026-10-27T00:55:52.8403586+00:00",
"DueDate": "2026-10-27T00:55:52.8403586+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"61cefda0-4dce-4ded-bb42-81172d0a948d": "5f12ca15-fb2b-4442-b89a-876ef284600c",
"0458a4f3-eee1-4c85-bf71-334ff4870d72": "2cd1574f-4b10-4a4f-9030-cf70c790bdb9"
},
"HasUpdates": true,
"Modified": "2026-10-27T00:55:52.8403586+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-27T00:55:52.8403586+00:00"
},
"LastComment": "2026-10-27T00:55:52.8403586+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ccecee72-fd81-4bde-b6f1-b65e061b1955",
"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": "e29c27d7-8a44-4e72-a7f6-417357fd296a",
"id": "d1073e8f-37e8-4fd5-81d8-fcd5a0c06c1a",
"ConfigId": "a685bff3-bcf9-4881-a19f-96e926e847cc"
}