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": "1e2c7bf8-ace7-4f2d-ab72-f4993a7949e8",
"ParentTaskId": "d08ee1f0-9ed0-45d2-9872-da7f232d004f",
"Integration": {
"IntegrationId": "c0d2a0fa-e75d-4b3e-ace1-ae61a59e5f79",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"db5e8cf3-b524-4d45-bb54-ac63819c8527": 2.0,
"651eb410-7e95-4f1b-9b9c-12890a27c5b7": 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": "5564699c-203a-42c1-a95b-f22968b886c8",
"Name": "sample string 1",
"Created": "2026-09-14T18:23:35.6710089+00:00",
"Modified": "2026-09-14T18:23:35.6710089+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bf137f58-8c75-448a-911e-7886d4fa81a6",
"db170f3b-ab1b-4ccb-bdaa-4d86a10911f4"
],
"NonLaborAssignments": [
{
"Id": "8c7614ba-ab00-4a81-a660-215438eb4c78",
"ResourceId": "2f6e0072-b916-4755-8839-35af9eb32b56",
"Quantity": 3.0
},
{
"Id": "8c7614ba-ab00-4a81-a660-215438eb4c78",
"ResourceId": "2f6e0072-b916-4755-8839-35af9eb32b56",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1f3121c7-160d-49a5-a195-c790f9d5f9aa",
"Type": 0,
"ResourceId": "728fc375-659d-430d-9fde-14e6bc4a19d7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "1c480e43-8327-41ff-a8dc-ff5a9601a40b",
"Start": "2026-09-14T18:23:35.6710089+00:00",
"Due": "2026-09-14T18:23:35.6710089+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "1c480e43-8327-41ff-a8dc-ff5a9601a40b",
"Start": "2026-09-14T18:23:35.6710089+00:00",
"Due": "2026-09-14T18:23:35.6710089+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "1f3121c7-160d-49a5-a195-c790f9d5f9aa",
"Type": 0,
"ResourceId": "728fc375-659d-430d-9fde-14e6bc4a19d7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "1c480e43-8327-41ff-a8dc-ff5a9601a40b",
"Start": "2026-09-14T18:23:35.6710089+00:00",
"Due": "2026-09-14T18:23:35.6710089+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "1c480e43-8327-41ff-a8dc-ff5a9601a40b",
"Start": "2026-09-14T18:23:35.6710089+00:00",
"Due": "2026-09-14T18:23:35.6710089+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "b4038fe0-690d-44da-be83-339fb9a93c68",
"WorkTypeParentId": "6a639cd2-7baf-4365-ab50-f9aa0089d7e0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a6c8fe2f-54c9-484d-a630-f226cca468fd",
"UPN": "bf30ec7d-b02f-4e5a-9b45-260fe62ea97a",
"PostDate": "2026-09-14T18:23:35.6710089+00:00",
"Comment": "sample string 4",
"CC": [
"d1f5e890-8cbc-433e-95d4-08a82c0259b8",
"b66a18d5-9476-421e-b8bd-752ab9cc0f0a"
],
"Users": [
"8c4d9686-7d21-4aa6-a47f-e31d2cd3b4a7",
"caeddac6-106f-43e3-94b7-b3d5eb9e67a4"
]
},
{
"Id": "a6c8fe2f-54c9-484d-a630-f226cca468fd",
"UPN": "bf30ec7d-b02f-4e5a-9b45-260fe62ea97a",
"PostDate": "2026-09-14T18:23:35.6710089+00:00",
"Comment": "sample string 4",
"CC": [
"d1f5e890-8cbc-433e-95d4-08a82c0259b8",
"b66a18d5-9476-421e-b8bd-752ab9cc0f0a"
],
"Users": [
"8c4d9686-7d21-4aa6-a47f-e31d2cd3b4a7",
"caeddac6-106f-43e3-94b7-b3d5eb9e67a4"
]
}
],
"StartDate": "2026-09-14T18:23:35.686638+00:00",
"DueDate": "2026-09-14T18:23:35.686638+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9343dd38-61e4-40b0-8f6b-f0a3f0f66773": "6909708a-a0c4-47ba-a3e5-e410e59301c4",
"09f31a2a-2e3c-4020-91d4-9db077e606c8": "7373b5b9-0d8d-40b3-896f-b57ed4fc306e"
},
"HasUpdates": true,
"Modified": "2026-09-14T18:23:35.686638+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-14T18:23:35.686638+00:00"
},
"LastComment": "2026-09-14T18:23:35.686638+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d49de4ff-fa38-473e-b75c-872a6075be2e",
"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": "862eae36-d9a1-484f-bc6f-2bea4384155a",
"id": "aa10eea9-3091-4540-bbcb-a3ebeca1138b",
"ConfigId": "54e6a67f-d378-4b3c-972e-0d620a8b01c2"
}