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": "d0521804-8c77-4194-822b-7117109c610d",
"ParentTaskId": "47daef4a-5c51-4f9f-9c37-74d49c1c0398",
"Integration": {
"IntegrationId": "8ad23753-8060-40ce-9b29-239093e4a729",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3e707211-2cfc-4dff-9775-588dba3e6944": 2.0,
"6586c42e-0be8-4022-a3e7-7a0f051a04c5": 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": "8e113069-64f9-4444-9403-b73f7da135a1",
"Name": "sample string 1",
"Created": "2026-09-11T05:30:24.1134221+00:00",
"Modified": "2026-09-11T05:30:24.1134221+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"a42090a8-7a76-4c99-822b-f376ab5f54fa",
"9b31e806-0d77-4932-8489-d0a1f1140048"
],
"NonLaborAssignments": [
{
"Id": "98ac6e51-8420-42f5-baa5-61af487383f2",
"ResourceId": "62b03f5a-1a13-4898-9744-02a2afb00ee6",
"Quantity": 3.0
},
{
"Id": "98ac6e51-8420-42f5-baa5-61af487383f2",
"ResourceId": "62b03f5a-1a13-4898-9744-02a2afb00ee6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "51173354-ea72-422c-af50-0b837ccd5eeb",
"Type": 0,
"ResourceId": "0efc8ea6-ac6f-498a-9148-fe5cb68e6a75",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "314b3f71-be9f-4cfe-9d51-04c74a6445bc",
"Start": "2026-09-11T05:30:24.1134221+00:00",
"Due": "2026-09-11T05:30:24.1134221+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "314b3f71-be9f-4cfe-9d51-04c74a6445bc",
"Start": "2026-09-11T05:30:24.1134221+00:00",
"Due": "2026-09-11T05:30:24.1134221+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "51173354-ea72-422c-af50-0b837ccd5eeb",
"Type": 0,
"ResourceId": "0efc8ea6-ac6f-498a-9148-fe5cb68e6a75",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "314b3f71-be9f-4cfe-9d51-04c74a6445bc",
"Start": "2026-09-11T05:30:24.1134221+00:00",
"Due": "2026-09-11T05:30:24.1134221+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "314b3f71-be9f-4cfe-9d51-04c74a6445bc",
"Start": "2026-09-11T05:30:24.1134221+00:00",
"Due": "2026-09-11T05:30:24.1134221+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "abef8969-117a-4368-8c94-e0ffa6fac8e2",
"WorkTypeParentId": "deb013ab-52c7-459d-8542-c61d08b62ba1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ed076818-e6e5-435b-bb67-f8e937fe8963",
"UPN": "d26f7275-da34-481a-9913-60fb2e29f33a",
"PostDate": "2026-09-11T05:30:24.1134221+00:00",
"Comment": "sample string 4",
"CC": [
"117d7493-c0a9-4f03-af9b-bf2aa2b6eea4",
"919d4046-6b7f-4dcb-80ea-001baffca7be"
],
"Users": [
"9c7836e5-f4a4-45fd-8c3a-1abedbae879e",
"eb947b64-d07b-4df2-a42a-3287a39c504b"
]
},
{
"Id": "ed076818-e6e5-435b-bb67-f8e937fe8963",
"UPN": "d26f7275-da34-481a-9913-60fb2e29f33a",
"PostDate": "2026-09-11T05:30:24.1134221+00:00",
"Comment": "sample string 4",
"CC": [
"117d7493-c0a9-4f03-af9b-bf2aa2b6eea4",
"919d4046-6b7f-4dcb-80ea-001baffca7be"
],
"Users": [
"9c7836e5-f4a4-45fd-8c3a-1abedbae879e",
"eb947b64-d07b-4df2-a42a-3287a39c504b"
]
}
],
"StartDate": "2026-09-11T05:30:24.1134221+00:00",
"DueDate": "2026-09-11T05:30:24.1134221+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5b94b589-f785-4c2d-8e41-c4c61e623e22": "6dda33ad-641a-4fef-b849-a6ead55c4a96",
"256f6095-2816-46de-aff9-04d9758ddca5": "b4faa6cb-8c47-43c9-a8d7-322db40ca24e"
},
"HasUpdates": true,
"Modified": "2026-09-11T05:30:24.1134221+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-11T05:30:24.1134221+00:00"
},
"LastComment": "2026-09-11T05:30:24.1134221+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5947df39-2175-4ba7-9ea9-a4dbe1d9afcc",
"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": "1c1a74f5-54d4-4114-b274-3582e1232b53",
"id": "cfd188f7-483d-4b32-b400-e39781cbf7fd",
"ConfigId": "09443554-1cfa-4930-9a37-a82cb016147e"
}