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": "ca88a3f9-0306-4e7f-8337-c641b4563a97",
"ParentTaskId": "eb24558b-f777-4379-ad15-dabf6a196e2d",
"Integration": {
"IntegrationId": "67ef1c51-e4f1-4e17-9510-1e4cc88373c8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d3273138-92d0-4970-badd-80414e513784": 2.0,
"51903dd3-b4ba-4421-8690-68a0a5d428c0": 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": "1724e839-d98f-442c-88f5-2cb79a479a15",
"Name": "sample string 1",
"Created": "2026-10-07T10:33:15.6573624+00:00",
"Modified": "2026-10-07T10:33:15.6573624+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ee855fa0-c525-479f-af0b-e5c1fe1683ff",
"d5c78941-ae74-4837-89d2-4f3869eb78ff"
],
"NonLaborAssignments": [
{
"Id": "7832656a-77be-4fc7-9516-680e42c2d6a5",
"ResourceId": "6abf27ca-a6bf-415c-87a9-3f8ca3ed0ea4",
"Quantity": 3.0
},
{
"Id": "7832656a-77be-4fc7-9516-680e42c2d6a5",
"ResourceId": "6abf27ca-a6bf-415c-87a9-3f8ca3ed0ea4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "24882eb0-62bb-4c35-82b6-030199108697",
"Type": 0,
"ResourceId": "7cd00966-2153-49ac-94e8-767d4df3a33a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "75862c86-d357-4155-a228-71cb309decda",
"Start": "2026-10-07T10:33:15.6573624+00:00",
"Due": "2026-10-07T10:33:15.6573624+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "75862c86-d357-4155-a228-71cb309decda",
"Start": "2026-10-07T10:33:15.6573624+00:00",
"Due": "2026-10-07T10:33:15.6573624+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "24882eb0-62bb-4c35-82b6-030199108697",
"Type": 0,
"ResourceId": "7cd00966-2153-49ac-94e8-767d4df3a33a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "75862c86-d357-4155-a228-71cb309decda",
"Start": "2026-10-07T10:33:15.6573624+00:00",
"Due": "2026-10-07T10:33:15.6573624+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "75862c86-d357-4155-a228-71cb309decda",
"Start": "2026-10-07T10:33:15.6573624+00:00",
"Due": "2026-10-07T10:33:15.6573624+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "27a5e79f-47d4-4e50-9ddb-184a8fef228d",
"WorkTypeParentId": "2289f0b8-329e-413d-bab0-6d4f355f3a8f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "178fdff5-4f0e-4af9-bb22-2fa6b59064db",
"UPN": "219c0d1b-4ea1-4e78-82a9-9202050f9b65",
"PostDate": "2026-10-07T10:33:15.6573624+00:00",
"Comment": "sample string 4",
"CC": [
"ff4151ea-2433-45ee-a00c-e44a522ed98f",
"98a03997-7f88-4894-890c-b280cf5af5f1"
],
"Users": [
"27645426-d3ae-4a96-ba4a-5b9f3eb4a135",
"4bdb4c76-e496-44cd-81d6-e1552c7ab9f2"
]
},
{
"Id": "178fdff5-4f0e-4af9-bb22-2fa6b59064db",
"UPN": "219c0d1b-4ea1-4e78-82a9-9202050f9b65",
"PostDate": "2026-10-07T10:33:15.6573624+00:00",
"Comment": "sample string 4",
"CC": [
"ff4151ea-2433-45ee-a00c-e44a522ed98f",
"98a03997-7f88-4894-890c-b280cf5af5f1"
],
"Users": [
"27645426-d3ae-4a96-ba4a-5b9f3eb4a135",
"4bdb4c76-e496-44cd-81d6-e1552c7ab9f2"
]
}
],
"StartDate": "2026-10-07T10:33:15.6573624+00:00",
"DueDate": "2026-10-07T10:33:15.6573624+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0045815f-bfa4-4597-8070-1de2388b5153": "5395f7a7-87ed-4798-b9a4-403338d23896",
"5b913116-1c75-4c03-b98e-949fc2df2264": "03290e09-c2fe-45b7-b96a-93e7be6acb81"
},
"HasUpdates": true,
"Modified": "2026-10-07T10:33:15.6573624+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-07T10:33:15.6573624+00:00"
},
"LastComment": "2026-10-07T10:33:15.6573624+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "eeb52f19-83b8-46cc-b016-d3b132056eed",
"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": "1d60d1be-7f8b-4a13-b7cb-e784cccc87b6",
"id": "5642db0a-7956-4c1e-a07c-182ef50e7795",
"ConfigId": "30409b92-2ad4-45fd-b3a3-fc3f4013d69d"
}