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": "27a9ae34-15ad-4b86-945a-cc5eede45502",
"ParentTaskId": "68922a78-f965-478d-8b11-0c3dcee6b865",
"Integration": {
"IntegrationId": "ca037858-8f62-4e93-a7f3-61a447e52ec3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c3150514-6299-4ad0-bddb-c8312cc31383": 2.0,
"bdff6f42-27c8-45cd-b8c4-4b1aedd13233": 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": "d0120921-84ee-4eca-a9cb-829561649d18",
"Name": "sample string 1",
"Created": "2026-06-26T19:41:48.7228513+00:00",
"Modified": "2026-06-26T19:41:48.7228513+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"64e16323-812d-401e-a0f3-b2e135169a7f",
"30eecf69-e2d0-4de8-833f-e69458f60c3f"
],
"NonLaborAssignments": [
{
"Id": "fe8e226e-d6c8-42e2-836b-ecbc3be6d5a9",
"ResourceId": "dde5c788-d949-430f-bab2-9ef4dbcc378b",
"Quantity": 3.0
},
{
"Id": "fe8e226e-d6c8-42e2-836b-ecbc3be6d5a9",
"ResourceId": "dde5c788-d949-430f-bab2-9ef4dbcc378b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "951fc3fa-41bf-494a-a615-97c4322407ca",
"Type": 0,
"ResourceId": "73995844-0dfe-42a9-8492-7985fb622e01",
"Units": 3.0
},
{
"Id": "951fc3fa-41bf-494a-a615-97c4322407ca",
"Type": 0,
"ResourceId": "73995844-0dfe-42a9-8492-7985fb622e01",
"Units": 3.0
}
],
"ParentId": "52730a07-ee6d-46d7-993d-944bd98f1f84",
"WorkTypeParentId": "180b2129-5573-454b-bf68-9cd48ef49230",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "050b7365-5cda-4941-84c9-ee112ec8f35c",
"UPN": "ea2da533-b7e2-46b8-8735-02e701d80339",
"PostDate": "2026-06-26T19:41:48.7228513+00:00",
"Comment": "sample string 4",
"CC": [
"23cad672-33c9-4eeb-87cf-d12411f14344",
"cd2a22b3-bf63-47a0-9c91-28123db56754"
],
"Users": [
"84a24bb1-122a-425b-a8aa-d7286c29083a",
"47620349-86ab-47ad-8c60-e54a667238da"
]
},
{
"Id": "050b7365-5cda-4941-84c9-ee112ec8f35c",
"UPN": "ea2da533-b7e2-46b8-8735-02e701d80339",
"PostDate": "2026-06-26T19:41:48.7228513+00:00",
"Comment": "sample string 4",
"CC": [
"23cad672-33c9-4eeb-87cf-d12411f14344",
"cd2a22b3-bf63-47a0-9c91-28123db56754"
],
"Users": [
"84a24bb1-122a-425b-a8aa-d7286c29083a",
"47620349-86ab-47ad-8c60-e54a667238da"
]
}
],
"StartDate": "2026-06-26T19:41:48.7228513+00:00",
"DueDate": "2026-06-26T19:41:48.7228513+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"40d104cd-922d-45b3-9501-437a463acf61": "f29d3e8c-0121-4654-8f8b-7eb1ad9291d7",
"5d8cadd5-fcae-4832-857c-125997398e53": "18a4fda4-a8dc-4153-9fff-e6c9633e50e0"
},
"HasUpdates": true,
"Modified": "2026-06-26T19:41:48.7228513+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-06-26T19:41:48.7228513+00:00"
},
"LastComment": "2026-06-26T19:41:48.7228513+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1dc7fb2c-1971-4350-8b3e-cda668921780",
"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": "6c7fa8c9-c6b3-4c46-a987-573cda279d79",
"id": "1cf83ecd-9be6-455c-af4e-85de882eb700",
"ConfigId": "10b111ea-bfd2-4e9d-a388-431df768ca37"
}