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": "65744dbc-f230-4c19-ac98-ea6a0bb81879",
"ParentTaskId": "6d5bff96-c518-47c6-82d2-58ced0fc5e0d",
"Integration": {
"IntegrationId": "0eaf7cab-aa02-4549-a706-39b8d17439e9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"97c1f55e-b273-466a-8841-9701608c18e4": 2.0,
"3d7988c6-a8de-4816-a3ce-88604dba94b4": 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": "dd897f9d-08df-4c37-a572-ee81a60b47ac",
"Name": "sample string 1",
"Created": "2026-09-12T08:48:53.9461119+00:00",
"Modified": "2026-09-12T08:48:53.9461119+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"00c5e6c0-59d2-4d31-b881-03b3338e83e2",
"3ab6c8b4-8085-43ac-b664-0ed0c7c34487"
],
"NonLaborAssignments": [
{
"Id": "56964340-20f5-4c9a-bd00-6e57262161e1",
"ResourceId": "def7c51b-5fa7-433e-ae9a-2ff6d26baf36",
"Quantity": 3.0
},
{
"Id": "56964340-20f5-4c9a-bd00-6e57262161e1",
"ResourceId": "def7c51b-5fa7-433e-ae9a-2ff6d26baf36",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1158cb39-e37e-46fd-995b-7c2c379a39f1",
"Type": 0,
"ResourceId": "29c6bf6b-6915-40bc-8da8-f9eb9626dcea",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "8a96e66b-80b9-4d94-bdd5-e8ef2473f72d",
"Start": "2026-09-12T08:48:53.9461119+00:00",
"Due": "2026-09-12T08:48:53.9461119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "8a96e66b-80b9-4d94-bdd5-e8ef2473f72d",
"Start": "2026-09-12T08:48:53.9461119+00:00",
"Due": "2026-09-12T08:48:53.9461119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "1158cb39-e37e-46fd-995b-7c2c379a39f1",
"Type": 0,
"ResourceId": "29c6bf6b-6915-40bc-8da8-f9eb9626dcea",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "8a96e66b-80b9-4d94-bdd5-e8ef2473f72d",
"Start": "2026-09-12T08:48:53.9461119+00:00",
"Due": "2026-09-12T08:48:53.9461119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "8a96e66b-80b9-4d94-bdd5-e8ef2473f72d",
"Start": "2026-09-12T08:48:53.9461119+00:00",
"Due": "2026-09-12T08:48:53.9461119+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "8934b00b-febb-43ae-ac34-44817f9e6899",
"WorkTypeParentId": "b289e2cf-9863-4d58-9e78-accaedef3c6d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ebf85989-7c2f-4726-a55f-3715ba6d27a3",
"UPN": "a530e59b-01e6-402b-af6b-8094f257b3ab",
"PostDate": "2026-09-12T08:48:53.9461119+00:00",
"Comment": "sample string 4",
"CC": [
"249563e6-7c30-4be0-8689-29408a32a5f3",
"0486e26b-4d7a-4033-95d7-aaff7dca7b8b"
],
"Users": [
"e3a9724d-367a-4b45-b46b-e04b7bf7d49e",
"637ba08b-f4ab-4738-9d7f-9efdb7dc4af7"
]
},
{
"Id": "ebf85989-7c2f-4726-a55f-3715ba6d27a3",
"UPN": "a530e59b-01e6-402b-af6b-8094f257b3ab",
"PostDate": "2026-09-12T08:48:53.9461119+00:00",
"Comment": "sample string 4",
"CC": [
"249563e6-7c30-4be0-8689-29408a32a5f3",
"0486e26b-4d7a-4033-95d7-aaff7dca7b8b"
],
"Users": [
"e3a9724d-367a-4b45-b46b-e04b7bf7d49e",
"637ba08b-f4ab-4738-9d7f-9efdb7dc4af7"
]
}
],
"StartDate": "2026-09-12T08:48:53.9461119+00:00",
"DueDate": "2026-09-12T08:48:53.9461119+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0badff0b-4906-4144-afac-115565651005": "e3e0d874-886c-4ef3-83ed-55731ea1c67a",
"319b541e-a1cc-4b29-91d4-24fcaa0e953a": "8263e2d2-1762-49dd-9991-7a9e8f43a749"
},
"HasUpdates": true,
"Modified": "2026-09-12T08:48:53.9461119+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-09-12T08:48:53.9461119+00:00"
},
"LastComment": "2026-09-12T08:48:53.9461119+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "dd148c6b-3eea-456c-9b3c-bad94afdf649",
"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": "0ed97b8f-3958-4641-999a-e71af30e7418",
"id": "b04a5c16-9560-4406-b8fc-52c4e00c70f8",
"ConfigId": "fff8feee-b979-40b4-9412-984b3204f7ec"
}