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": "d2edf0be-315d-45a9-81e2-800d2c0d4d38",
"ParentTaskId": "801a5d2c-9848-4c31-b2ed-4dab4e47c703",
"Integration": {
"IntegrationId": "5f016714-08ff-4b04-b232-0e9c760f0c22",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"85bc40bb-c04b-4c28-afa8-13f9a9de5f2c": 2.0,
"540cfc16-92d4-4ecb-8a59-1e35ba1a0768": 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": "99e1d116-c7d9-404d-9617-5c1ca99c0af2",
"Name": "sample string 1",
"Created": "2026-09-19T06:48:38.0709055+00:00",
"Modified": "2026-09-19T06:48:38.0709055+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"5430ba2c-1b6a-43b9-8fa0-8a0fdfcd7ca8",
"53f058a1-1530-4be2-ab2c-d8e6c495229c"
],
"NonLaborAssignments": [
{
"Id": "56640f69-6331-42ee-87d6-4600d04df5c4",
"ResourceId": "90c38b19-f9cf-439e-814b-d03de4800774",
"Quantity": 3.0
},
{
"Id": "56640f69-6331-42ee-87d6-4600d04df5c4",
"ResourceId": "90c38b19-f9cf-439e-814b-d03de4800774",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "45c4db14-7eea-4d91-8ea2-89de44e99a3c",
"Type": 0,
"ResourceId": "985d4082-baa8-4bf2-a731-acd45b72a85c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2e51aff1-e30b-44b1-ae79-ecea20975c8a",
"Start": "2026-09-19T06:48:38.0865266+00:00",
"Due": "2026-09-19T06:48:38.0865266+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2e51aff1-e30b-44b1-ae79-ecea20975c8a",
"Start": "2026-09-19T06:48:38.0865266+00:00",
"Due": "2026-09-19T06:48:38.0865266+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "45c4db14-7eea-4d91-8ea2-89de44e99a3c",
"Type": 0,
"ResourceId": "985d4082-baa8-4bf2-a731-acd45b72a85c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "2e51aff1-e30b-44b1-ae79-ecea20975c8a",
"Start": "2026-09-19T06:48:38.0865266+00:00",
"Due": "2026-09-19T06:48:38.0865266+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "2e51aff1-e30b-44b1-ae79-ecea20975c8a",
"Start": "2026-09-19T06:48:38.0865266+00:00",
"Due": "2026-09-19T06:48:38.0865266+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "fcc629a6-0702-480f-b5ea-5f571b3b096e",
"WorkTypeParentId": "4c879eb5-a830-468c-9b5b-1d1fb627b81c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "96f76697-b04c-451d-a03b-881e7ac32ef3",
"UPN": "9082525c-86f4-435f-aedd-23710d50c51a",
"PostDate": "2026-09-19T06:48:38.0865266+00:00",
"Comment": "sample string 4",
"CC": [
"8a307c38-48c7-44bc-9dfd-9b920e5a7dbc",
"551e9c96-a934-4c8f-b18f-53a1dd33ef9d"
],
"Users": [
"c3372f8a-3a5a-42ce-93c3-86cadf1cf806",
"a80bf900-f68c-497f-a290-5ea808dace98"
]
},
{
"Id": "96f76697-b04c-451d-a03b-881e7ac32ef3",
"UPN": "9082525c-86f4-435f-aedd-23710d50c51a",
"PostDate": "2026-09-19T06:48:38.0865266+00:00",
"Comment": "sample string 4",
"CC": [
"8a307c38-48c7-44bc-9dfd-9b920e5a7dbc",
"551e9c96-a934-4c8f-b18f-53a1dd33ef9d"
],
"Users": [
"c3372f8a-3a5a-42ce-93c3-86cadf1cf806",
"a80bf900-f68c-497f-a290-5ea808dace98"
]
}
],
"StartDate": "2026-09-19T06:48:38.0865266+00:00",
"DueDate": "2026-09-19T06:48:38.0865266+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"45cbd54d-4c0d-47e3-957f-54dd3b62b5c0": "581fd43b-2a3c-4ede-99f2-74e859b1dd3c",
"ac261a26-8a3b-4d8c-92fd-5e026a52d863": "6a9dca0a-d0c9-4186-b573-b9fc0ef5701e"
},
"HasUpdates": true,
"Modified": "2026-09-19T06:48:38.0865266+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-19T06:48:38.0865266+00:00"
},
"LastComment": "2026-09-19T06:48:38.0865266+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9764faaa-4433-4e79-b276-4abff7f7539c",
"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": "208541fb-97ec-4a8f-a915-62a61ea813a4",
"id": "463b4468-4c7b-4bb1-9e86-aa32cfe4ac0b",
"ConfigId": "7424fa07-3d9a-4baa-aba1-338b3b3f8645"
}