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": "f7d2da60-2894-440c-a65f-dbebf51964a7",
"ParentTaskId": "cd9aba0f-4170-4200-936c-73725aeae3af",
"Integration": {
"IntegrationId": "9980224f-c2d8-4774-a810-80fca88b816a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b723f4e4-c594-4734-a6d0-9b3a910690cd": 2.0,
"84613980-c57e-4098-8a9d-fdfbab6c72c7": 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": "dfe7512a-0ae1-4b93-a1ab-10fc97f554e4",
"Name": "sample string 1",
"Created": "2026-02-14T15:46:51.02987+00:00",
"Modified": "2026-02-14T15:46:51.02987+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8886fbcb-0d12-482e-bc50-4fdccef1f857",
"add24fec-4368-4825-abc1-479c48531cfe"
],
"NonLaborAssignments": [
{
"Id": "27a258d1-6032-40e6-b8af-f161fcaaf977",
"ResourceId": "f644d950-f67e-47b2-a4b8-ab928ec93bcc",
"Quantity": 3.0
},
{
"Id": "27a258d1-6032-40e6-b8af-f161fcaaf977",
"ResourceId": "f644d950-f67e-47b2-a4b8-ab928ec93bcc",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5714d65d-c0e0-4508-bf13-1056e9f9d214",
"Type": 0,
"ResourceId": "506c27f6-9b00-4c8a-bae0-a58d5b9d33eb",
"Units": 3.0
},
{
"Id": "5714d65d-c0e0-4508-bf13-1056e9f9d214",
"Type": 0,
"ResourceId": "506c27f6-9b00-4c8a-bae0-a58d5b9d33eb",
"Units": 3.0
}
],
"ParentId": "bd601aa8-c3c3-4474-b131-27467faa7a4e",
"WorkTypeParentId": "aa8f3ba7-17c1-4485-94d8-fd0d8c588ea5",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "fcf606b7-600b-4a90-9d1c-1953aea5b1dc",
"UPN": "a6e7327e-ac10-4703-be93-f9b751a5cbd1",
"PostDate": "2026-02-14T15:46:51.02987+00:00",
"Comment": "sample string 4",
"CC": [
"5727e53d-7677-42de-934b-39f5745d9312",
"879174d3-acd5-49c2-aeb1-d22c9c40574f"
],
"Users": [
"3e69f3f5-fde1-46d3-9b0a-317a89f83946",
"0f63d836-a079-49f5-a26d-edc2e4c362ed"
]
},
{
"Id": "fcf606b7-600b-4a90-9d1c-1953aea5b1dc",
"UPN": "a6e7327e-ac10-4703-be93-f9b751a5cbd1",
"PostDate": "2026-02-14T15:46:51.02987+00:00",
"Comment": "sample string 4",
"CC": [
"5727e53d-7677-42de-934b-39f5745d9312",
"879174d3-acd5-49c2-aeb1-d22c9c40574f"
],
"Users": [
"3e69f3f5-fde1-46d3-9b0a-317a89f83946",
"0f63d836-a079-49f5-a26d-edc2e4c362ed"
]
}
],
"StartDate": "2026-02-14T15:46:51.02987+00:00",
"DueDate": "2026-02-14T15:46:51.02987+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0caf2e55-2b14-4c95-8450-66010fbc5549": "48dbafd0-9cea-48d8-8aa5-e0256ac0b0be",
"7c3035ff-61ed-4d9e-a66d-b5deff54b87f": "293129b5-a9bf-4bb0-8a40-d26731d74a1d"
},
"HasUpdates": true,
"Modified": "2026-02-14T15:46:51.02987+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-02-14T15:46:51.02987+00:00"
},
"LastComment": "2026-02-14T15:46:51.02987+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "142bfcad-f0a3-45a4-93a2-6c4af6918892",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "5cd6cf3f-45e2-40d0-a77e-97bd4b4d7ea9",
"id": "5c6d5403-b327-40ab-b653-eb695febca60",
"ConfigId": "13174598-f38c-4e58-afa1-dcd2354afd8f"
}