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": "dd2c2168-51aa-4b4c-8b26-1853721ee387",
"ParentTaskId": "e7e1970d-1b20-4795-a675-fc1d6121993f",
"Integration": {
"IntegrationId": "33ccf52f-5293-4086-9c06-9dacf1d6e629",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"db2771f3-0dbe-4c0f-bd93-c01bb90cefd8": 2.0,
"475f0b41-b2f9-4b9c-ba6f-c0dd812516d6": 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": "828dae8f-bdb3-4170-90ab-11b562a6b048",
"Name": "sample string 1",
"Created": "2026-10-22T03:58:27.2215577+00:00",
"Modified": "2026-10-22T03:58:27.2215577+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1eda0c88-3de4-41c6-badc-9c8c0eb812bd",
"a2895aa4-bf69-4f58-aec9-785f2cca028c"
],
"NonLaborAssignments": [
{
"Id": "a07864d7-cbef-4ab8-8034-e61422075ff1",
"ResourceId": "c43f3f3a-f7e8-4d27-b7ce-1ff5b3281a11",
"Quantity": 3.0
},
{
"Id": "a07864d7-cbef-4ab8-8034-e61422075ff1",
"ResourceId": "c43f3f3a-f7e8-4d27-b7ce-1ff5b3281a11",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "33f691a7-ff67-4a06-bdf8-83f76ad55847",
"Type": 0,
"ResourceId": "fbf453fc-7d74-4fbf-bfd4-65664859bef2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9d4b5275-2521-4a65-8172-dc079e1cf630",
"Start": "2026-10-22T03:58:27.2215577+00:00",
"Due": "2026-10-22T03:58:27.2215577+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9d4b5275-2521-4a65-8172-dc079e1cf630",
"Start": "2026-10-22T03:58:27.2215577+00:00",
"Due": "2026-10-22T03:58:27.2215577+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "33f691a7-ff67-4a06-bdf8-83f76ad55847",
"Type": 0,
"ResourceId": "fbf453fc-7d74-4fbf-bfd4-65664859bef2",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9d4b5275-2521-4a65-8172-dc079e1cf630",
"Start": "2026-10-22T03:58:27.2215577+00:00",
"Due": "2026-10-22T03:58:27.2215577+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9d4b5275-2521-4a65-8172-dc079e1cf630",
"Start": "2026-10-22T03:58:27.2215577+00:00",
"Due": "2026-10-22T03:58:27.2215577+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "420c85f8-b4d3-4a0a-a584-6dcf269bc86a",
"WorkTypeParentId": "436e2f64-3083-4391-bcd3-5ad80b751f8e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4820020a-d708-4aee-b52f-1c2048a3df63",
"UPN": "a86e4a23-6f9b-4b94-925e-86a75fd21e52",
"PostDate": "2026-10-22T03:58:27.2215577+00:00",
"Comment": "sample string 4",
"CC": [
"a5274b7e-fdc8-4785-a2e9-9db032f40840",
"136d579d-977e-4885-9582-0b810fdfea37"
],
"Users": [
"b77884af-5778-4844-9a0d-a39899452ab7",
"4742984d-467a-45ae-b8a1-096abddb9052"
]
},
{
"Id": "4820020a-d708-4aee-b52f-1c2048a3df63",
"UPN": "a86e4a23-6f9b-4b94-925e-86a75fd21e52",
"PostDate": "2026-10-22T03:58:27.2215577+00:00",
"Comment": "sample string 4",
"CC": [
"a5274b7e-fdc8-4785-a2e9-9db032f40840",
"136d579d-977e-4885-9582-0b810fdfea37"
],
"Users": [
"b77884af-5778-4844-9a0d-a39899452ab7",
"4742984d-467a-45ae-b8a1-096abddb9052"
]
}
],
"StartDate": "2026-10-22T03:58:27.2215577+00:00",
"DueDate": "2026-10-22T03:58:27.2215577+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e8077f5e-fa4a-4a9c-9140-7f608b7b7142": "45663f74-1cc9-4f7b-bbc0-3e5ef9d3ed68",
"93e8c9ad-9b64-41a9-8525-27c770bf3194": "6917bf65-3292-435e-9700-de712b40bc26"
},
"HasUpdates": true,
"Modified": "2026-10-22T03:58:27.2215577+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-22T03:58:27.2215577+00:00"
},
"LastComment": "2026-10-22T03:58:27.2215577+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "77ba53b4-8a19-4faa-a891-2c9467030857",
"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": "6cd9637b-b267-4b97-aa42-fffdf2232181",
"id": "dc0f4232-157a-4899-b5bf-f4142933ff7f",
"ConfigId": "1cd80f99-5a62-4bc4-84df-55732639e6da"
}