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": "23c1dd31-8bdb-4735-bd44-f0aee75e63d1",
"ParentTaskId": "0faa9a55-7463-4c70-8cb5-92a20dcf5cc7",
"Integration": {
"IntegrationId": "039fe87e-0bad-4df4-bdf9-948136f597a0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3d255407-8738-4aa6-9bf5-ad70d0ce7b1c": 2.0,
"57ba705d-981a-4362-bc8c-40f6ecc59cf5": 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": "f0771a57-848e-498c-a900-9ff1eb4352c9",
"Name": "sample string 1",
"Created": "2026-09-03T09:25:28.1144096+00:00",
"Modified": "2026-09-03T09:25:28.1144096+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2c29850a-c85c-4ff8-82c0-113cd82ab655",
"fcad32dd-02ea-4b7a-b69a-184d288db285"
],
"NonLaborAssignments": [
{
"Id": "27e637a0-e2d5-4bec-b704-076739c38a7f",
"ResourceId": "6ad29c5d-7451-4653-aef7-454d281018db",
"Quantity": 3.0
},
{
"Id": "27e637a0-e2d5-4bec-b704-076739c38a7f",
"ResourceId": "6ad29c5d-7451-4653-aef7-454d281018db",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7b371f73-95dd-4eb1-9748-ffac4f5cc77e",
"Type": 0,
"ResourceId": "ddb17e06-456b-4f0a-8181-8394a4eae425",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "5fbcbd17-f9af-444d-bf92-3dd62ac76762",
"Start": "2026-09-03T09:25:28.1144096+00:00",
"Due": "2026-09-03T09:25:28.1144096+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "5fbcbd17-f9af-444d-bf92-3dd62ac76762",
"Start": "2026-09-03T09:25:28.1144096+00:00",
"Due": "2026-09-03T09:25:28.1144096+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7b371f73-95dd-4eb1-9748-ffac4f5cc77e",
"Type": 0,
"ResourceId": "ddb17e06-456b-4f0a-8181-8394a4eae425",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "5fbcbd17-f9af-444d-bf92-3dd62ac76762",
"Start": "2026-09-03T09:25:28.1144096+00:00",
"Due": "2026-09-03T09:25:28.1144096+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "5fbcbd17-f9af-444d-bf92-3dd62ac76762",
"Start": "2026-09-03T09:25:28.1144096+00:00",
"Due": "2026-09-03T09:25:28.1144096+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c4ec2835-4719-4753-8ced-4561fed0c29c",
"WorkTypeParentId": "eddaa7dc-a2bf-4c5b-822f-f3d60b210005",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d2623d34-059b-497a-ace9-dfa37ddf1415",
"UPN": "9ce2381a-3849-4732-966a-891fa0520dff",
"PostDate": "2026-09-03T09:25:28.1144096+00:00",
"Comment": "sample string 4",
"CC": [
"cfedd705-95e9-443b-bd8d-19616d3f9240",
"91079ca7-f2ac-4c47-a349-38b4aa34883b"
],
"Users": [
"cbfcadaf-a056-4ed8-aea5-81d234efa369",
"25fbb9f2-8332-4ae3-ab27-b55f313bcf02"
]
},
{
"Id": "d2623d34-059b-497a-ace9-dfa37ddf1415",
"UPN": "9ce2381a-3849-4732-966a-891fa0520dff",
"PostDate": "2026-09-03T09:25:28.1144096+00:00",
"Comment": "sample string 4",
"CC": [
"cfedd705-95e9-443b-bd8d-19616d3f9240",
"91079ca7-f2ac-4c47-a349-38b4aa34883b"
],
"Users": [
"cbfcadaf-a056-4ed8-aea5-81d234efa369",
"25fbb9f2-8332-4ae3-ab27-b55f313bcf02"
]
}
],
"StartDate": "2026-09-03T09:25:28.1144096+00:00",
"DueDate": "2026-09-03T09:25:28.1144096+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bac7a95d-44cb-4bca-857d-ebd99e71cf17": "864fff6f-857a-4c6f-874a-b448f24dac96",
"6b666a88-f542-4a48-89ef-a98384d789cf": "1b8fd2d7-3243-4fc7-8423-95508f3711fe"
},
"HasUpdates": true,
"Modified": "2026-09-03T09:25:28.1144096+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-03T09:25:28.1144096+00:00"
},
"LastComment": "2026-09-03T09:25:28.1144096+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "fb6079c8-41e6-441f-99a4-35321f642ff9",
"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": "b0b48439-ef6d-495d-b1de-e9351bb1c6a8",
"id": "1011e89c-b50f-40be-add3-05c6b8a503a8",
"ConfigId": "517de97c-1a4a-4433-98cf-87ac0fd23211"
}