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": "2072dc16-fa9b-4bff-a5ae-8b07a1a57a82", "ParentTaskId": "f8b8188b-8b1b-4d39-88ab-2cdc031c3920", "Integration": { "IntegrationId": "ba52311f-45bc-48f3-87f3-f161ee8709a4", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "Assignments": { "c695ff4c-ba17-46a0-b665-7ffec3a7ab52": 2.0, "504801b2-859e-4db6-b751-fe9c3762393e": 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": "9f0c4b62-48dc-4269-b275-22163f9a927b", "Name": "sample string 1", "Created": "2025-07-08T08:16:38.1885469+00:00", "Modified": "2025-07-08T08:16:38.1885469+00:00", "Author": "sample string 4", "Editor": "sample string 5", "AssignedTo": [ "ca0fa59f-bcf3-462f-9530-e7d0c1faa11b", "b1113a60-ae41-435f-a944-a23f81e3a425" ], "NonLaborAssignments": [ { "Id": "36f08a1e-cebe-4499-868f-38e18dee6803", "ResourceId": "def3c004-582d-4678-ac20-9e19569e7572", "Quantity": 3.0 }, { "Id": "36f08a1e-cebe-4499-868f-38e18dee6803", "ResourceId": "def3c004-582d-4678-ac20-9e19569e7572", "Quantity": 3.0 } ], "Assignments": [ { "Id": "37f0b7a1-e07d-43fb-b31d-8b21cc20b552", "Type": 0, "ResourceId": "cce66a39-32dc-47e2-9dcf-05fbbfc89c84", "Units": 3.0 }, { "Id": "37f0b7a1-e07d-43fb-b31d-8b21cc20b552", "Type": 0, "ResourceId": "cce66a39-32dc-47e2-9dcf-05fbbfc89c84", "Units": 3.0 } ], "ParentId": "5f53e560-703d-4a75-b2b0-736178dffdc3", "WorkTypeParentId": "15a627af-546e-46ce-a2d5-6719b3ff027f", "WorkTypeIndex": 9, "Fields": { "sample string 1": {}, "sample string 3": {} }, "Index": 10, "Complete": true, "Comments": [ { "Id": "194a922c-272a-4d40-a5f4-0a00b5b30538", "UPN": "cd5c75c2-2c8f-4d12-ad62-f6d95ce97609", "PostDate": "2025-07-08T08:16:38.1885469+00:00", "Comment": "sample string 4", "CC": [ "62d1987a-6735-42ee-9d5d-857b6e9a4127", "0ee22873-dd40-498c-a2e5-ba4d6966d4c7" ], "Users": [ "0e4e0e6b-808f-4ad6-b510-3c4f2c02d087", "b81b543c-c18b-4c98-9590-d15db1208784" ] }, { "Id": "194a922c-272a-4d40-a5f4-0a00b5b30538", "UPN": "cd5c75c2-2c8f-4d12-ad62-f6d95ce97609", "PostDate": "2025-07-08T08:16:38.1885469+00:00", "Comment": "sample string 4", "CC": [ "62d1987a-6735-42ee-9d5d-857b6e9a4127", "0ee22873-dd40-498c-a2e5-ba4d6966d4c7" ], "Users": [ "0e4e0e6b-808f-4ad6-b510-3c4f2c02d087", "b81b543c-c18b-4c98-9590-d15db1208784" ] } ], "StartDate": "2025-07-08T08:16:38.1885469+00:00", "DueDate": "2025-07-08T08:16:38.1885469+00:00", "TaskScheduleType": 0, "StatusUpdate": { "ResourceReplacements": { "506bfc6b-2188-472b-8441-b7dd0ba83519": "03874087-9b8f-4775-bb93-0df7a019255f", "df9dd556-4d68-4d64-8fee-f7977b5f7bfc": "31128582-3179-4d9a-b070-cefff9ea114e" }, "HasUpdates": true, "Modified": "2025-07-08T08:16:38.1885469+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-08T08:16:38.2041687+00:00" }, "LastComment": "2025-07-08T08:16:38.2041687+00:00", "IsScheduled": true, "Integration": { "IntegrationId": "ec2821fb-715b-486d-99a6-c6e3b20885c2", "ExternalItemId": "sample string 2", "ExternalUrl": "sample string 3", "ReadOnlyFields": [ "sample string 1", "sample string 2" ] }, "WorkPlanId": "d18dd2eb-e540-4156-888b-e974fd17f629", "id": "7feee8b8-ada5-45a8-bf08-9ab3417e4d8d", "ConfigId": "c8b5e53b-b992-4006-81ac-c273d1d0d83a" }