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": "f554475c-ea61-42f6-b830-77e7616ce901",
"ParentTaskId": "f2e0c87b-6640-4287-acc4-15e1c08e80cf",
"Integration": {
"IntegrationId": "28565de2-11c9-431c-8a05-cf8f5f320ba6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f263ce69-544f-4a9d-be08-e74af18e55bd": 2.0,
"891af46e-346d-456d-8586-18b4c210e7cf": 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": "d77653c8-f3cd-4f05-8483-17e679679a62",
"Name": "sample string 1",
"Created": "2026-07-08T03:14:52.1620756+00:00",
"Modified": "2026-07-08T03:14:52.1620756+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cc282c63-1032-414d-8826-894b5569b892",
"e1d872c2-0f8d-4d65-8ce3-4afa3ad37781"
],
"NonLaborAssignments": [
{
"Id": "9c343aad-a18a-4f29-a529-865fae6163ba",
"ResourceId": "b57cae17-2153-4db4-8879-eebdb18a6f0a",
"Quantity": 3.0
},
{
"Id": "9c343aad-a18a-4f29-a529-865fae6163ba",
"ResourceId": "b57cae17-2153-4db4-8879-eebdb18a6f0a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a07fe8e8-0527-49bc-a2e4-db1e22718c60",
"Type": 0,
"ResourceId": "178f76ff-281c-4cae-9de1-e05ff76afa19",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "a07fe8e8-0527-49bc-a2e4-db1e22718c60",
"Type": 0,
"ResourceId": "178f76ff-281c-4cae-9de1-e05ff76afa19",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "fb4d98b2-e22f-46fa-9330-d5e054f359c1",
"WorkTypeParentId": "404d42cb-9b66-46ce-8e8b-6ef226935b75",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9d53dfb3-9165-4152-9d6c-624ab12b3012",
"UPN": "e39f3b1e-b05f-44f5-9549-9f86cf55ab5a",
"PostDate": "2026-07-08T03:14:52.1620756+00:00",
"Comment": "sample string 4",
"CC": [
"e7d53620-8471-4975-ab0f-1cbb6141a2ff",
"d9f23b77-851a-48a3-b3fa-6d97f24c8d71"
],
"Users": [
"d4f7f591-0c50-402b-89f6-0aafefd12d27",
"08f949cd-569c-4332-af23-5cd8ce7302d5"
]
},
{
"Id": "9d53dfb3-9165-4152-9d6c-624ab12b3012",
"UPN": "e39f3b1e-b05f-44f5-9549-9f86cf55ab5a",
"PostDate": "2026-07-08T03:14:52.1620756+00:00",
"Comment": "sample string 4",
"CC": [
"e7d53620-8471-4975-ab0f-1cbb6141a2ff",
"d9f23b77-851a-48a3-b3fa-6d97f24c8d71"
],
"Users": [
"d4f7f591-0c50-402b-89f6-0aafefd12d27",
"08f949cd-569c-4332-af23-5cd8ce7302d5"
]
}
],
"StartDate": "2026-07-08T03:14:52.1620756+00:00",
"DueDate": "2026-07-08T03:14:52.1620756+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7e919d01-9ef2-42b9-b560-48edf580fb5c": "66002176-2671-4694-8bf6-678418d9265e",
"ec2d064b-992c-40ad-a246-84922aaa799a": "b9d46889-d00e-4333-9c31-28210b97fd57"
},
"HasUpdates": true,
"Modified": "2026-07-08T03:14:52.1620756+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-07-08T03:14:52.1620756+00:00"
},
"LastComment": "2026-07-08T03:14:52.1620756+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f87f9d06-a858-48bf-8f74-94d078e0a6f1",
"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": "0a46af35-26c5-4664-bc19-3793d64b319c",
"id": "fd107d69-5ad4-4335-9d82-d61be66f638b",
"ConfigId": "74e3adad-53bc-4303-8604-c247fa449eb6"
}