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": "ff16d0d8-708a-4981-be00-8f60ed34a331",
"ParentTaskId": "07609af1-0ee7-45e8-9475-0036f06c3c74",
"Integration": {
"IntegrationId": "90928f30-5717-47cd-a3a7-0039c51f3b3f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"bcd06cce-ddd6-4653-83d3-e61d3e6d5953": 2.0,
"8c6bcad2-bf27-4a92-b8b7-6a39d206ecd1": 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": "02cf10ad-3464-4418-8166-b6eba099ecba",
"Name": "sample string 1",
"Created": "2026-06-27T07:43:09.0681455+00:00",
"Modified": "2026-06-27T07:43:09.0681455+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8039d03b-6cbc-4bda-83a8-33e62a9dbdf4",
"df768e89-98f1-440b-b9a0-82044d2b8b8b"
],
"NonLaborAssignments": [
{
"Id": "8012a743-c2db-423c-b2c8-33facdb16e27",
"ResourceId": "9923ff4c-7057-454f-b48f-4cbd9a4f3e60",
"Quantity": 3.0
},
{
"Id": "8012a743-c2db-423c-b2c8-33facdb16e27",
"ResourceId": "9923ff4c-7057-454f-b48f-4cbd9a4f3e60",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3f7f8ee9-8d36-4b97-a954-c29a127e6d8e",
"Type": 0,
"ResourceId": "49a407a6-6801-440b-af71-fa6918cc2190",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "3f7f8ee9-8d36-4b97-a954-c29a127e6d8e",
"Type": 0,
"ResourceId": "49a407a6-6801-440b-af71-fa6918cc2190",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "d4d5e119-a018-4d26-a3c4-989972ad21d4",
"WorkTypeParentId": "936b8759-9f50-48f0-83b4-45a87941864c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9de5e02f-4f10-4a4c-873b-1eccd5e65834",
"UPN": "df745122-0bde-483d-9c9e-ec876b82e570",
"PostDate": "2026-06-27T07:43:09.0681455+00:00",
"Comment": "sample string 4",
"CC": [
"fe8a015d-217d-4476-b95f-e7554b93f6c7",
"1522c1b3-732c-463b-9cc9-35f64ab202ae"
],
"Users": [
"888baf21-2f2f-4d10-964a-62cf1c9c5d54",
"58cc5f61-e0f3-401d-b4b0-8cec1eee4e28"
]
},
{
"Id": "9de5e02f-4f10-4a4c-873b-1eccd5e65834",
"UPN": "df745122-0bde-483d-9c9e-ec876b82e570",
"PostDate": "2026-06-27T07:43:09.0681455+00:00",
"Comment": "sample string 4",
"CC": [
"fe8a015d-217d-4476-b95f-e7554b93f6c7",
"1522c1b3-732c-463b-9cc9-35f64ab202ae"
],
"Users": [
"888baf21-2f2f-4d10-964a-62cf1c9c5d54",
"58cc5f61-e0f3-401d-b4b0-8cec1eee4e28"
]
}
],
"StartDate": "2026-06-27T07:43:09.0681455+00:00",
"DueDate": "2026-06-27T07:43:09.0681455+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bce913f8-daf2-4fb7-8c8d-7252ce101aad": "a164e66f-63ee-45fe-aa78-95e5a789d006",
"a8c4c3bf-434d-428e-a4dc-d4062d5c441e": "fcc31102-bce3-4122-af4e-0fcf8bc3a893"
},
"HasUpdates": true,
"Modified": "2026-06-27T07:43:09.0681455+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-06-27T07:43:09.0681455+00:00"
},
"LastComment": "2026-06-27T07:43:09.0681455+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c4702039-655d-4612-8181-34dba230f9b5",
"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": "2ed013a6-2eae-4970-b505-aa87930f7a06",
"id": "39ba6802-495f-49d4-a210-f1fa6f2aa277",
"ConfigId": "174c11e9-c0a6-4c2c-aba2-22359540dade"
}