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": "407ae674-9590-42c3-bd1c-c4c9b9a7d5ad",
"ParentTaskId": "0530a908-920f-4882-a603-12f6199a69eb",
"Integration": {
"IntegrationId": "8717a75d-3d7e-49be-9511-a540bf72d22e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7aafdc73-0391-4772-8b77-2ed7f41563f7": 2.0,
"f6131759-fa11-4d80-8da0-bcdb7235c713": 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": "9eb0c356-9cf4-42fe-88eb-1de81754a621",
"Name": "sample string 1",
"Created": "2026-07-12T10:44:26.5422595+00:00",
"Modified": "2026-07-12T10:44:26.5422595+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ab88fc2e-c69c-4bd7-9ee6-728f545f6164",
"48a7a0c8-652c-485f-862f-3b88e3b930d4"
],
"NonLaborAssignments": [
{
"Id": "1de73fb4-bc48-4f55-b7b3-3825cf9c43e2",
"ResourceId": "bf0b7553-2bfe-45c7-9a6e-bbcff862abeb",
"Quantity": 3.0
},
{
"Id": "1de73fb4-bc48-4f55-b7b3-3825cf9c43e2",
"ResourceId": "bf0b7553-2bfe-45c7-9a6e-bbcff862abeb",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a6e47f5e-e8dd-4202-b5da-cb838373d37e",
"Type": 0,
"ResourceId": "54f24399-3ba8-4606-97b2-193f0abf90bf",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "a6e47f5e-e8dd-4202-b5da-cb838373d37e",
"Type": 0,
"ResourceId": "54f24399-3ba8-4606-97b2-193f0abf90bf",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9de9be28-99af-4616-a5fe-5d9165061ec4",
"WorkTypeParentId": "6f93bef0-7e8f-41b1-b6b6-75a185fd1b2c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "08a6f851-9444-40ad-a8fb-d014897d1c5b",
"UPN": "7e9dc939-1219-4a1d-9cb5-3d430d36fe05",
"PostDate": "2026-07-12T10:44:26.5422595+00:00",
"Comment": "sample string 4",
"CC": [
"8488362a-f75a-4dad-8c12-62c2e5dd7288",
"23d6a1b2-bd9d-4440-a53f-7659a61a451b"
],
"Users": [
"ac9e734f-40b6-44dc-8fa8-a67332448a25",
"f508149d-95ff-4b4b-86a5-9ff72a0205a0"
]
},
{
"Id": "08a6f851-9444-40ad-a8fb-d014897d1c5b",
"UPN": "7e9dc939-1219-4a1d-9cb5-3d430d36fe05",
"PostDate": "2026-07-12T10:44:26.5422595+00:00",
"Comment": "sample string 4",
"CC": [
"8488362a-f75a-4dad-8c12-62c2e5dd7288",
"23d6a1b2-bd9d-4440-a53f-7659a61a451b"
],
"Users": [
"ac9e734f-40b6-44dc-8fa8-a67332448a25",
"f508149d-95ff-4b4b-86a5-9ff72a0205a0"
]
}
],
"StartDate": "2026-07-12T10:44:26.5422595+00:00",
"DueDate": "2026-07-12T10:44:26.5422595+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d3bb9e40-4977-40da-a008-926cb20b96ac": "271f323f-3f33-4129-8a9e-dc0c8535616f",
"d5ba1c2d-15e1-4f89-8ff8-8f518152a1d1": "d9e8bb32-ca3b-44de-aaef-66f88da56490"
},
"HasUpdates": true,
"Modified": "2026-07-12T10:44:26.5422595+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-07-12T10:44:26.5422595+00:00"
},
"LastComment": "2026-07-12T10:44:26.5422595+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "132db87a-626b-4a97-bf73-7f6958f06fc4",
"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": "a513b0a1-6468-49c5-8b34-e8fc43f5d84f",
"id": "56c010e3-07db-4e0e-822a-f77a3d80c1bc",
"ConfigId": "af75b366-ba82-4250-b841-81fb373deb0d"
}