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": "5e1ee9d2-2a5c-4650-a807-dbb0a6601224",
"ParentTaskId": "90eae3f0-15de-4bba-8a02-53d7681035d0",
"Integration": {
"IntegrationId": "53203bea-491b-4b1f-8b5a-62df55d8295a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"db61de4b-0a5c-49f9-ba72-83470c343094": 2.0,
"830262f3-7305-4d36-a169-8db2b5da5414": 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": "efad971d-99bb-4461-8f30-cf37abb3ec74",
"Name": "sample string 1",
"Created": "2026-10-22T16:06:00.2379767+00:00",
"Modified": "2026-10-22T16:06:00.2379767+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b256f9d0-91d1-4172-9557-392858223843",
"ea789f6b-10f4-4dcb-a697-abeddf6deb51"
],
"NonLaborAssignments": [
{
"Id": "889aa52e-c0f7-49e3-93c4-76a4a0ebc03d",
"ResourceId": "71ed6bb5-5e48-4220-a173-ee8436964676",
"Quantity": 3.0
},
{
"Id": "889aa52e-c0f7-49e3-93c4-76a4a0ebc03d",
"ResourceId": "71ed6bb5-5e48-4220-a173-ee8436964676",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3ca66eb4-4374-4758-947f-56c3d4d32a09",
"Type": 0,
"ResourceId": "05874e7d-8612-4f83-9307-df50aac0c948",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7b55046f-9a88-44cd-86f5-4560593d27ad",
"Start": "2026-10-22T16:06:00.2379767+00:00",
"Due": "2026-10-22T16:06:00.2379767+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7b55046f-9a88-44cd-86f5-4560593d27ad",
"Start": "2026-10-22T16:06:00.2379767+00:00",
"Due": "2026-10-22T16:06:00.2379767+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "3ca66eb4-4374-4758-947f-56c3d4d32a09",
"Type": 0,
"ResourceId": "05874e7d-8612-4f83-9307-df50aac0c948",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7b55046f-9a88-44cd-86f5-4560593d27ad",
"Start": "2026-10-22T16:06:00.2379767+00:00",
"Due": "2026-10-22T16:06:00.2379767+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7b55046f-9a88-44cd-86f5-4560593d27ad",
"Start": "2026-10-22T16:06:00.2379767+00:00",
"Due": "2026-10-22T16:06:00.2379767+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "f03e6a80-7689-4dac-976e-a19a99eaca66",
"WorkTypeParentId": "05ed1f9d-6341-4ac2-a677-56b4bc0e217c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "13d32fd3-a24f-49e8-b059-e39d535f8fcd",
"UPN": "18c64ee5-65d4-49c3-a50b-264783d17184",
"PostDate": "2026-10-22T16:06:00.2379767+00:00",
"Comment": "sample string 4",
"CC": [
"dc977c90-00be-4b20-8129-acab0e115605",
"eb0f48ca-7b4a-46de-a8af-1561fc9ab1a6"
],
"Users": [
"a59cce4d-989c-4b0d-b876-18c39d76909b",
"134e3291-45c2-4b28-a118-176207625460"
]
},
{
"Id": "13d32fd3-a24f-49e8-b059-e39d535f8fcd",
"UPN": "18c64ee5-65d4-49c3-a50b-264783d17184",
"PostDate": "2026-10-22T16:06:00.2379767+00:00",
"Comment": "sample string 4",
"CC": [
"dc977c90-00be-4b20-8129-acab0e115605",
"eb0f48ca-7b4a-46de-a8af-1561fc9ab1a6"
],
"Users": [
"a59cce4d-989c-4b0d-b876-18c39d76909b",
"134e3291-45c2-4b28-a118-176207625460"
]
}
],
"StartDate": "2026-10-22T16:06:00.2379767+00:00",
"DueDate": "2026-10-22T16:06:00.2379767+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"1b3d8521-f396-4fdd-8e9d-3b53adec4abd": "c52343d1-3fa9-4eaf-9e7b-e54808b1f04d",
"93118fcc-01b2-4bc2-8e02-9a31651d86c9": "a045527b-4830-43be-8554-b1b259c66d97"
},
"HasUpdates": true,
"Modified": "2026-10-22T16:06:00.2379767+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-10-22T16:06:00.2379767+00:00"
},
"LastComment": "2026-10-22T16:06:00.2379767+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a6712adb-f108-459f-bf4b-5f67ccb52164",
"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": "0e11cf8f-debc-4297-bbb2-13e409be139f",
"id": "c0048785-7cd6-46f8-bbee-0df3f2af9a51",
"ConfigId": "a2f597aa-d5d3-4e83-82bc-d3a947f9cd2d"
}