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": "c3d418d2-9522-4457-a164-9a8a780f3173",
"ParentTaskId": "6051165b-ea79-4bb8-a7cf-6f460b329ce0",
"Integration": {
"IntegrationId": "ffda04ac-fc2d-4836-b1a9-12e11fffd885",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4ff7b1f4-ea6d-4933-941e-27be86d35a7a": 2.0,
"2ca421a9-d83c-44d8-962a-b18a329ce3b1": 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": "7a01ec01-15fc-4620-be1d-8c3d5ecf9fdf",
"Name": "sample string 1",
"Created": "2026-06-12T11:38:56.9439908+00:00",
"Modified": "2026-06-12T11:38:56.9439908+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"61f26e59-0647-41ff-9265-b470dd45f92e",
"c89de426-5012-46f0-9ab4-fac2d788d999"
],
"NonLaborAssignments": [
{
"Id": "09732fd4-ed09-4df5-b252-15a4b6715901",
"ResourceId": "27729f07-f2f6-47a7-b42e-cf6659809e67",
"Quantity": 3.0
},
{
"Id": "09732fd4-ed09-4df5-b252-15a4b6715901",
"ResourceId": "27729f07-f2f6-47a7-b42e-cf6659809e67",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "97d4cc21-0230-468e-869a-41bd1d36eab5",
"Type": 0,
"ResourceId": "d7d8327d-bddb-48e0-b66a-54327779e281",
"Units": 3.0
},
{
"Id": "97d4cc21-0230-468e-869a-41bd1d36eab5",
"Type": 0,
"ResourceId": "d7d8327d-bddb-48e0-b66a-54327779e281",
"Units": 3.0
}
],
"ParentId": "cd4d84b9-f760-4dc1-b398-6bbe5facca07",
"WorkTypeParentId": "a7a3b334-b28f-44c4-89cf-fbd4b5ff6606",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6b8d4d51-cfde-47ff-817d-2c6983667e35",
"UPN": "b820d744-2a1f-405f-958e-2b35b27ee475",
"PostDate": "2026-06-12T11:38:56.9439908+00:00",
"Comment": "sample string 4",
"CC": [
"c64e2fbd-83e2-4cac-b544-1059d22aec86",
"f385d923-da0b-4dbe-8eb0-c1094446bc49"
],
"Users": [
"61ab3c53-21b3-4bf0-9788-13c8d5176888",
"a0c9e47f-8825-4808-95ee-cc1e0973fc42"
]
},
{
"Id": "6b8d4d51-cfde-47ff-817d-2c6983667e35",
"UPN": "b820d744-2a1f-405f-958e-2b35b27ee475",
"PostDate": "2026-06-12T11:38:56.9439908+00:00",
"Comment": "sample string 4",
"CC": [
"c64e2fbd-83e2-4cac-b544-1059d22aec86",
"f385d923-da0b-4dbe-8eb0-c1094446bc49"
],
"Users": [
"61ab3c53-21b3-4bf0-9788-13c8d5176888",
"a0c9e47f-8825-4808-95ee-cc1e0973fc42"
]
}
],
"StartDate": "2026-06-12T11:38:56.9439908+00:00",
"DueDate": "2026-06-12T11:38:56.9439908+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ad5cdecc-2860-4a84-83cf-c08e78c9cd0d": "45daa4ed-c5d6-479d-8240-2ef258fcdc07",
"12553edf-2642-467a-b8e9-2fb9e10766ad": "031bf65d-4bce-4d52-b77b-fc57b75975f4"
},
"HasUpdates": true,
"Modified": "2026-06-12T11:38:56.9439908+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-06-12T11:38:56.9439908+00:00"
},
"LastComment": "2026-06-12T11:38:56.9439908+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e98f5591-338c-4001-a884-8b56a56cb62d",
"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": "94ffb549-a962-4a23-bff9-d4144f676a62",
"id": "0a07bd8c-6b9d-4adc-9e2c-e9bc3ffbc409",
"ConfigId": "eb265eca-3b27-4d69-b875-3e4126816527"
}