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": "b6260ffd-4b9f-46ac-987d-41ce3c791899",
"ParentTaskId": "f4323b44-8747-4415-8892-5ad6ce5c59ae",
"Integration": {
"IntegrationId": "64be5d3c-9ab9-42c5-9784-0a5e5ae50173",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"63603533-0a63-4460-92b0-c58ca7f976f6": 2.0,
"a327dd41-209d-47bb-9de1-30c063c95d07": 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": "afa22b3b-9f53-4ca3-86dd-fa02008eb26e",
"Name": "sample string 1",
"Created": "2026-09-20T07:12:55.2711977+00:00",
"Modified": "2026-09-20T07:12:55.2711977+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"80aed3dc-dd31-4658-8cfa-e9918360735f",
"2f190bc3-aa31-48b8-a78c-31c35a71d213"
],
"NonLaborAssignments": [
{
"Id": "d56d74e3-ce13-4981-8a70-2402630cd505",
"ResourceId": "5ff01435-0cee-43bb-90b1-e417f01d40cb",
"Quantity": 3.0
},
{
"Id": "d56d74e3-ce13-4981-8a70-2402630cd505",
"ResourceId": "5ff01435-0cee-43bb-90b1-e417f01d40cb",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ba955b4e-fa38-4d84-b917-f47fd2fc6308",
"Type": 0,
"ResourceId": "944fa9ff-b585-4dc7-9d3a-4f48783171b6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "68b90b7a-73f5-406c-bf27-7857e5ef5741",
"Start": "2026-09-20T07:12:55.2711977+00:00",
"Due": "2026-09-20T07:12:55.2711977+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "68b90b7a-73f5-406c-bf27-7857e5ef5741",
"Start": "2026-09-20T07:12:55.2711977+00:00",
"Due": "2026-09-20T07:12:55.2711977+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "ba955b4e-fa38-4d84-b917-f47fd2fc6308",
"Type": 0,
"ResourceId": "944fa9ff-b585-4dc7-9d3a-4f48783171b6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "68b90b7a-73f5-406c-bf27-7857e5ef5741",
"Start": "2026-09-20T07:12:55.2711977+00:00",
"Due": "2026-09-20T07:12:55.2711977+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "68b90b7a-73f5-406c-bf27-7857e5ef5741",
"Start": "2026-09-20T07:12:55.2711977+00:00",
"Due": "2026-09-20T07:12:55.2711977+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c192d356-c694-4e88-bbaa-19248de9f786",
"WorkTypeParentId": "c1790cb6-dfd7-484f-a770-1728094e352b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "801da96f-0070-4ed1-ac45-87b8f1bfe489",
"UPN": "d53d76eb-ff8a-484b-90e3-6d5778902f90",
"PostDate": "2026-09-20T07:12:55.2711977+00:00",
"Comment": "sample string 4",
"CC": [
"e49503b1-2805-433b-a4f5-d396a934f0ec",
"dc513819-af6c-45ec-b6d7-30bec0c7ae32"
],
"Users": [
"3c15f1f8-7245-46db-8625-eae45cb10e2f",
"e74bb9d5-e528-4235-8468-988f445e5dde"
]
},
{
"Id": "801da96f-0070-4ed1-ac45-87b8f1bfe489",
"UPN": "d53d76eb-ff8a-484b-90e3-6d5778902f90",
"PostDate": "2026-09-20T07:12:55.2711977+00:00",
"Comment": "sample string 4",
"CC": [
"e49503b1-2805-433b-a4f5-d396a934f0ec",
"dc513819-af6c-45ec-b6d7-30bec0c7ae32"
],
"Users": [
"3c15f1f8-7245-46db-8625-eae45cb10e2f",
"e74bb9d5-e528-4235-8468-988f445e5dde"
]
}
],
"StartDate": "2026-09-20T07:12:55.2711977+00:00",
"DueDate": "2026-09-20T07:12:55.2711977+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b02f03b7-d8bc-4048-97de-cbbc3f23de78": "de52b8de-d2e2-43c3-8ac6-acb9e0ebb665",
"b0af14f9-5f06-41ec-b733-ad992d1255e0": "5d607d5b-a6b6-47d5-80da-2ad3e00e3b93"
},
"HasUpdates": true,
"Modified": "2026-09-20T07:12:55.2711977+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-20T07:12:55.2711977+00:00"
},
"LastComment": "2026-09-20T07:12:55.2711977+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e9b4f68b-364a-49de-82da-34bf24489ec5",
"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": "48bdc106-2657-4d50-9bcc-6c0823722a07",
"id": "d02d65c1-5808-4599-bb73-36a15b61ff78",
"ConfigId": "52d3fed5-563a-4d92-bc9d-68ce6bb54307"
}