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": "5b65cc6d-228a-49d7-83cf-94b7654b561d",
"ParentTaskId": "6ec64d0c-f18b-401f-937e-2a237864dbe4",
"Integration": {
"IntegrationId": "f563d0b2-a85b-447c-8223-5a68ddfa49f8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"30934e94-1d63-4157-8aaf-630ceeb6251e": 2.0,
"75776d24-bd61-4e42-bc79-af246c5fdb96": 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": "ad1f6ccb-0838-4a15-a3b8-2230e0c67c6e",
"Name": "sample string 1",
"Created": "2026-09-03T22:09:57.8053882+00:00",
"Modified": "2026-09-03T22:09:57.8053882+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d62c7c1d-c551-4cf8-b77e-5b67f4306a83",
"a668f6b1-ed18-4f95-b76f-aff4619264c3"
],
"NonLaborAssignments": [
{
"Id": "12a7b397-b4e4-4883-a6d5-703dfbb9b996",
"ResourceId": "b9e0b572-cbd2-48d4-9200-3e21a34732a7",
"Quantity": 3.0
},
{
"Id": "12a7b397-b4e4-4883-a6d5-703dfbb9b996",
"ResourceId": "b9e0b572-cbd2-48d4-9200-3e21a34732a7",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5d3d0dba-f745-428b-91cb-59a60df18cbd",
"Type": 0,
"ResourceId": "174e4c76-bda6-44d7-98c8-bec1ac6867e1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c7d5784e-ec57-4047-94e8-d48cd95ffb91",
"Start": "2026-09-03T22:09:57.8053882+00:00",
"Due": "2026-09-03T22:09:57.8053882+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c7d5784e-ec57-4047-94e8-d48cd95ffb91",
"Start": "2026-09-03T22:09:57.8053882+00:00",
"Due": "2026-09-03T22:09:57.8053882+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "5d3d0dba-f745-428b-91cb-59a60df18cbd",
"Type": 0,
"ResourceId": "174e4c76-bda6-44d7-98c8-bec1ac6867e1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "c7d5784e-ec57-4047-94e8-d48cd95ffb91",
"Start": "2026-09-03T22:09:57.8053882+00:00",
"Due": "2026-09-03T22:09:57.8053882+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "c7d5784e-ec57-4047-94e8-d48cd95ffb91",
"Start": "2026-09-03T22:09:57.8053882+00:00",
"Due": "2026-09-03T22:09:57.8053882+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "d9454a64-d6d1-44e5-8f5e-af0836df0bd7",
"WorkTypeParentId": "7acc1767-d5f9-4a00-a7d6-45f02d8ad169",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "50075b6e-7cd1-49c3-b609-3cdd68de8659",
"UPN": "518cc240-6ef5-4f18-bdb4-52a6159e12f0",
"PostDate": "2026-09-03T22:09:57.8053882+00:00",
"Comment": "sample string 4",
"CC": [
"f9dec0c1-50ba-45a9-a28d-7679082f4195",
"a2d15b38-5006-4920-bffd-47bedac436f8"
],
"Users": [
"bfa676e9-13d8-45f8-a9c0-6170393f01a4",
"a964c672-ae71-40c3-bf23-1e577df65fec"
]
},
{
"Id": "50075b6e-7cd1-49c3-b609-3cdd68de8659",
"UPN": "518cc240-6ef5-4f18-bdb4-52a6159e12f0",
"PostDate": "2026-09-03T22:09:57.8053882+00:00",
"Comment": "sample string 4",
"CC": [
"f9dec0c1-50ba-45a9-a28d-7679082f4195",
"a2d15b38-5006-4920-bffd-47bedac436f8"
],
"Users": [
"bfa676e9-13d8-45f8-a9c0-6170393f01a4",
"a964c672-ae71-40c3-bf23-1e577df65fec"
]
}
],
"StartDate": "2026-09-03T22:09:57.8053882+00:00",
"DueDate": "2026-09-03T22:09:57.8053882+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a11b791c-f857-4da9-ab97-c1b6ee44973d": "bd69ede6-14fd-42e0-b2a1-24e7c97f306a",
"211298c0-344f-4f3d-9fe1-934946fd98e2": "0a34f517-10cf-4375-8340-5f224f2ad322"
},
"HasUpdates": true,
"Modified": "2026-09-03T22:09:57.8053882+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-03T22:09:57.8053882+00:00"
},
"LastComment": "2026-09-03T22:09:57.8053882+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3b1ded3e-40f7-440b-b547-f3d30cdbfec3",
"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": "f2a9c9a6-ef4c-4cd6-af53-018d8dfaa824",
"id": "875d2729-5f67-487c-ae50-c804dfa4a5bd",
"ConfigId": "b558105d-e7f4-4bd3-93a0-728b62ec2989"
}