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": "28f5107e-ec33-4c5f-bc68-64adce40cd0d", "ParentTaskId": "2d560493-10b3-4ebf-9960-5bd627fcd78b", "Integration": { "IntegrationId": "993e218c-bdb3-40d6-9706-b6b635426ca4", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "Assignments": { "735ef25e-c9c7-46b0-a06f-88a3ab3510fd": 2.0, "5f406250-4e2e-487f-9bfd-d4b846945490": 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": "26c75d5b-6c47-4cc5-a7dc-f15877b775a3", "Name": "sample string 1", "Created": "2025-07-07T00:35:14.8282436+00:00", "Modified": "2025-07-07T00:35:14.8282436+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "fe7f62ce-6dd2-4136-90dd-885c09b97c7e", "6becc8c7-2439-453a-93dc-3d9565519307" ], "NonLaborAssignments": [ { "Id": "8107ce92-88da-4b2e-b93c-e874e7249b40", "ResourceId": "4e066199-e95a-49fb-b774-a3f7d41e29cd", "Quantity": 3.0 }, { "Id": "8107ce92-88da-4b2e-b93c-e874e7249b40", "ResourceId": "4e066199-e95a-49fb-b774-a3f7d41e29cd", "Quantity": 3.0 } ], "Assignments": [ { "Id": "24e4f649-639b-4448-91ab-d216c8758494", "Type": 0, "ResourceId": "aa0094fe-d0c5-4b27-967e-22ddf0a5bf88", "Units": 3.0 }, { "Id": "24e4f649-639b-4448-91ab-d216c8758494", "Type": 0, "ResourceId": "aa0094fe-d0c5-4b27-967e-22ddf0a5bf88", "Units": 3.0 } ], "ParentId": "8485f6df-2112-4b9a-8833-0ed62a803eeb", "WorkTypeParentId": "34044907-647f-4b79-a89f-ee2ef0031b74", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "b4c5e5e8-17f1-44bf-8627-e099b97da3ec", "UPN": "7f52b223-4726-409c-9c16-34d05d8b251a", "PostDate": "2025-07-07T00:35:14.8438686+00:00", "Comment": "sample string 4", "CC": [ "3a88725d-de22-416c-811b-d1c7934c7e0d", "e35c4d1d-a13e-4e0d-9f47-ad903f72cada" ], "Users": [ "fe17c7c0-63c2-47ef-9755-1fd75b42d167", "df586f58-9de1-48b3-8556-7068ef215103" ] }, { "Id": "b4c5e5e8-17f1-44bf-8627-e099b97da3ec", "UPN": "7f52b223-4726-409c-9c16-34d05d8b251a", "PostDate": "2025-07-07T00:35:14.8438686+00:00", "Comment": "sample string 4", "CC": [ "3a88725d-de22-416c-811b-d1c7934c7e0d", "e35c4d1d-a13e-4e0d-9f47-ad903f72cada" ], "Users": [ "fe17c7c0-63c2-47ef-9755-1fd75b42d167", "df586f58-9de1-48b3-8556-7068ef215103" ] } ], "StartDate": "2025-07-07T00:35:14.8438686+00:00", "DueDate": "2025-07-07T00:35:14.8438686+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "3e5cb2d6-0cde-4d47-9295-877f609f34d7": "823bb118-929c-408e-ba87-b10359fe4720", "4ca25603-ca73-4fee-8ddd-6e137c83a09f": "74f81d19-9804-40cf-9b07-443d429b4141" }, "HasUpdates": true, "Modified": "2025-07-07T00:35:14.8438686+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-07T00:35:14.8438686+00:00" }, "LastComment": "2025-07-07T00:35:14.8438686+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "4eb1de8e-751b-4cc7-8497-e4d3fd0a2f45", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "9e49de57-4376-4629-80de-ccdbacbc2875", "id": "8d442e9d-6be7-49ed-a88d-d7f2cef927d8", "ConfigId": "c17b975e-b40f-47e1-b3ed-12c300a73af6" }