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": "84604ee8-6309-4e05-92cc-ab40e62c7183",
"ParentTaskId": "53f476c5-412a-45fd-b49b-0b837cd7429f",
"Integration": {
"IntegrationId": "5c395429-2d3a-4638-a4a4-f9d08a7f91df",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1c6b72de-1663-4fb6-9ea4-e9a22cfbad12": 2.0,
"abae6f60-1c08-4859-8aed-94a7068d4d0b": 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": "9912d6a7-4da1-4980-b537-1b0f3b40ca8f",
"Name": "sample string 1",
"Created": "2026-10-20T12:15:35.6103176+00:00",
"Modified": "2026-10-20T12:15:35.6103176+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d8287251-8d94-4a38-971d-ac75158da11a",
"e3ce42fc-8e3a-4689-8f33-7952f80c2e0d"
],
"NonLaborAssignments": [
{
"Id": "67fc1a2a-560d-4c86-9090-e9e871cf2a19",
"ResourceId": "d9651215-e438-4143-ab09-de865534c610",
"Quantity": 3.0
},
{
"Id": "67fc1a2a-560d-4c86-9090-e9e871cf2a19",
"ResourceId": "d9651215-e438-4143-ab09-de865534c610",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "76c2abdc-d615-4cd5-ba4f-e05792595f00",
"Type": 0,
"ResourceId": "4a23016d-a847-41f7-9a29-1a61c5fdc39c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "082de3a3-895a-4a0c-b00d-acc5e27ecb4a",
"Start": "2026-10-20T12:15:35.6103176+00:00",
"Due": "2026-10-20T12:15:35.6103176+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "082de3a3-895a-4a0c-b00d-acc5e27ecb4a",
"Start": "2026-10-20T12:15:35.6103176+00:00",
"Due": "2026-10-20T12:15:35.6103176+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "76c2abdc-d615-4cd5-ba4f-e05792595f00",
"Type": 0,
"ResourceId": "4a23016d-a847-41f7-9a29-1a61c5fdc39c",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "082de3a3-895a-4a0c-b00d-acc5e27ecb4a",
"Start": "2026-10-20T12:15:35.6103176+00:00",
"Due": "2026-10-20T12:15:35.6103176+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "082de3a3-895a-4a0c-b00d-acc5e27ecb4a",
"Start": "2026-10-20T12:15:35.6103176+00:00",
"Due": "2026-10-20T12:15:35.6103176+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "ad52b985-0323-4fac-a828-ad5fb37d874f",
"WorkTypeParentId": "c9e99aa2-4c51-4f73-b110-23666bb4338b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8bf1f27c-889b-49a7-b21d-659aabafd24a",
"UPN": "7291fd83-dcf2-452b-b696-308015fa24ea",
"PostDate": "2026-10-20T12:15:35.6103176+00:00",
"Comment": "sample string 4",
"CC": [
"24aabf1a-aceb-4a17-8709-c897f29015a8",
"37cf1cbb-d92e-4e67-acba-78af3f72e4c8"
],
"Users": [
"f1c340be-aac5-4be7-9051-d7525ee49ab9",
"1ead47b7-86b0-43b5-8745-4ca102ff652a"
]
},
{
"Id": "8bf1f27c-889b-49a7-b21d-659aabafd24a",
"UPN": "7291fd83-dcf2-452b-b696-308015fa24ea",
"PostDate": "2026-10-20T12:15:35.6103176+00:00",
"Comment": "sample string 4",
"CC": [
"24aabf1a-aceb-4a17-8709-c897f29015a8",
"37cf1cbb-d92e-4e67-acba-78af3f72e4c8"
],
"Users": [
"f1c340be-aac5-4be7-9051-d7525ee49ab9",
"1ead47b7-86b0-43b5-8745-4ca102ff652a"
]
}
],
"StartDate": "2026-10-20T12:15:35.6103176+00:00",
"DueDate": "2026-10-20T12:15:35.6103176+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"af389f7b-50bc-49fc-95c3-11be4b93c220": "b9dfafa2-7aa6-4b15-8613-7edd325705a6",
"8ec035fc-0542-4d4f-880d-2468dcf9e892": "5a27890d-ad31-4c0a-9f7d-f521720274b2"
},
"HasUpdates": true,
"Modified": "2026-10-20T12:15:35.6103176+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-10-20T12:15:35.6103176+00:00"
},
"LastComment": "2026-10-20T12:15:35.6103176+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8c5d98ce-e30d-411e-bed1-9189ce9f7a81",
"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": "7bdf1e18-614b-49bf-a837-91b7fee482c3",
"id": "1038c8d9-433d-40ee-a9d3-f0e36fb893dc",
"ConfigId": "1d8d5106-4fb0-45ad-b393-6941e833bf43"
}