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
TasksRequestName | 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": "2ef6b22a-2f62-42e2-b879-3f95580c4800", "ParentTaskId": "9d66fdc1-1ea5-4ec5-8b5a-79262071bc80", "Integration": { "IntegrationId": "567458d4-5f04-4526-8e2c-d5a62c4d4863", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "Assignments": { "071a938b-e42e-484b-bba7-6f1e6c8cad2f": 2.0, "9151a0f5-6331-48c6-a858-d3862c3a5503": 4.0 }, "ProcessAssignments": true }
Response Information
Resource Description
WorkPlanTaskName | 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": "bee359ac-4b61-49c4-be7d-2b98839936e8", "Name": "sample string 1", "Created": "2025-09-18T05:55:17.9728654+00:00", "Modified": "2025-09-18T05:55:17.9728654+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "9859d36f-ad1f-4ac5-a870-4d12e8118683", "b0d4e9d4-8dde-4d5d-b55b-f8e544080ee7" ], "NonLaborAssignments": [ { "Id": "04001d3c-1b90-4f19-bea1-7452f4db1e64", "ResourceId": "9334d8d2-8ef6-4496-948f-5050e893de17", "Quantity": 3.0 }, { "Id": "04001d3c-1b90-4f19-bea1-7452f4db1e64", "ResourceId": "9334d8d2-8ef6-4496-948f-5050e893de17", "Quantity": 3.0 } ], "Assignments": [ { "Id": "f9dc8a3a-3196-422c-92a3-e3e78d3eda18", "Type": 0, "ResourceId": "7a4060f2-a605-45b5-8bfa-dbce11b00307", "Units": 3.0 }, { "Id": "f9dc8a3a-3196-422c-92a3-e3e78d3eda18", "Type": 0, "ResourceId": "7a4060f2-a605-45b5-8bfa-dbce11b00307", "Units": 3.0 } ], "ParentId": "fbfab961-db61-45e5-a48f-2e28ef90d6fc", "WorkTypeParentId": "b65b05a7-735a-4b14-add9-35ca78d4edc5", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "e0414a27-1888-46eb-9949-a060cb844dae", "UPN": "a683f5b6-677d-4360-8456-48cf7e5a9684", "PostDate": "2025-09-18T05:55:17.9728654+00:00", "Comment": "sample string 4", "CC": [ "6ea36bc1-2b49-401c-b331-e83b656beb0a", "3c5dba01-77c4-4dee-9aee-2bf02d40a04d" ], "Users": [ "eb84e60a-f6c8-43f4-82cd-c44bbb8f2256", "1333fc64-12c2-4fdb-82af-d7e012379e54" ] }, { "Id": "e0414a27-1888-46eb-9949-a060cb844dae", "UPN": "a683f5b6-677d-4360-8456-48cf7e5a9684", "PostDate": "2025-09-18T05:55:17.9728654+00:00", "Comment": "sample string 4", "CC": [ "6ea36bc1-2b49-401c-b331-e83b656beb0a", "3c5dba01-77c4-4dee-9aee-2bf02d40a04d" ], "Users": [ "eb84e60a-f6c8-43f4-82cd-c44bbb8f2256", "1333fc64-12c2-4fdb-82af-d7e012379e54" ] } ], "StartDate": "2025-09-18T05:55:17.9728654+00:00", "DueDate": "2025-09-18T05:55:17.9728654+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "197d9ed1-6b8e-4ac5-ae0e-3e4448634e26": "4dc9cb42-8953-45e3-b0ef-d7d60be2b1ca", "f5159441-982a-4d0f-9169-5b7edb7becdb": "119daec9-db66-4895-9256-930d14f537b7" }, "HasUpdates": true, "Modified": "2025-09-18T05:55:17.9728654+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": "2025-09-18T05:55:17.9728654+00:00" }, "LastComment": "2025-09-18T05:55:17.9728654+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "68f369ce-56b1-4c7a-815a-784969d8599b", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "f0999c87-1fed-4493-ac22-a0ebb6212b0c", "id": "5df600a2-953e-4fde-9c16-2f80b98604a3", "ConfigId": "0928ee7d-9bdd-4456-a4a5-bf6a13913939" }