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": "57240db5-9e57-40f6-9302-bf17f87455a0", "ParentTaskId": "a075aac1-9a10-478a-ac2b-cae5a8750764", "Integration": { "IntegrationId": "f513e548-8e47-447d-9f27-898589ad4b19", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "Assignments": { "da7cac4b-9c3c-4f43-8f57-8f9150876c7c": 2.0, "c73cd2de-0ba5-4eee-a635-b65fb7ddd952": 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": "938e372b-4bb2-4753-a3ae-0de93d4e6b56", "Name": "sample string 1", "Created": "2025-07-18T23:50:35.4516423+00:00", "Modified": "2025-07-18T23:50:35.4516423+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "55909d26-b04d-41c8-b0a6-514bb0bac5b2", "e977bf21-a765-4c93-a5d6-b90516ebfb88" ], "NonLaborAssignments": [ { "Id": "9c18c06b-7b13-412f-b2bb-a5e0320acdbe", "ResourceId": "a0dc73ca-f7cd-4cb7-a48c-a14aca06a4b5", "Quantity": 3.0 }, { "Id": "9c18c06b-7b13-412f-b2bb-a5e0320acdbe", "ResourceId": "a0dc73ca-f7cd-4cb7-a48c-a14aca06a4b5", "Quantity": 3.0 } ], "Assignments": [ { "Id": "eb4e2317-f7d5-49dd-93a3-1117ed342e93", "Type": 0, "ResourceId": "323d9ba8-6dfa-4d39-901b-3823eeba4bfd", "Units": 3.0 }, { "Id": "eb4e2317-f7d5-49dd-93a3-1117ed342e93", "Type": 0, "ResourceId": "323d9ba8-6dfa-4d39-901b-3823eeba4bfd", "Units": 3.0 } ], "ParentId": "7b57cf52-b14b-4b25-8ad5-19ef0ea946fc", "WorkTypeParentId": "3ffd02d6-fdd8-426f-be59-b1e38c65a3b9", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "58df3ba9-0867-4a76-9455-6e58dab06cd9", "UPN": "1ba95c03-296a-481c-b676-8ceb5f6b7e6c", "PostDate": "2025-07-18T23:50:35.4516423+00:00", "Comment": "sample string 4", "CC": [ "d2fee605-0590-4ee1-b163-ce13977a4986", "fb40dfe9-1def-44a3-a03b-bde78dd63caa" ], "Users": [ "80b2ad04-e3a7-477e-9703-2742b6e5b477", "a7b98ae7-cb1d-40c6-84aa-e517b04a035d" ] }, { "Id": "58df3ba9-0867-4a76-9455-6e58dab06cd9", "UPN": "1ba95c03-296a-481c-b676-8ceb5f6b7e6c", "PostDate": "2025-07-18T23:50:35.4516423+00:00", "Comment": "sample string 4", "CC": [ "d2fee605-0590-4ee1-b163-ce13977a4986", "fb40dfe9-1def-44a3-a03b-bde78dd63caa" ], "Users": [ "80b2ad04-e3a7-477e-9703-2742b6e5b477", "a7b98ae7-cb1d-40c6-84aa-e517b04a035d" ] } ], "StartDate": "2025-07-18T23:50:35.4516423+00:00", "DueDate": "2025-07-18T23:50:35.4516423+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "13858dec-d5bf-4136-8f93-3d28ec64de20": "c8f1adfe-4aa4-4e2f-81b8-cc5fdfc9e3e9", "c5d7c829-a3e4-46e9-bd4e-033dcd276a57": "65cece5f-ed88-416b-9589-9bfcf0b63118" }, "HasUpdates": true, "Modified": "2025-07-18T23:50:35.4516423+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-07-18T23:50:35.4516423+00:00" }, "LastComment": "2025-07-18T23:50:35.4516423+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "450de877-9d20-48e8-b8fb-5e5a749f1d22", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "231bde69-6c82-449b-aca8-3a6cae848caa", "id": "9c775a74-d131-4245-a545-5c9179f5f718", "ConfigId": "085c9810-9226-4c79-b768-00bbd1ad4a8e" }