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": "06fc7eb9-9063-4cbc-b640-75fe3eb259df",
"ParentTaskId": "e231a417-8553-413e-a8aa-9b7b022a9e49",
"Integration": {
"IntegrationId": "f415d5ca-605e-4f42-a78c-7ff5b9f0a716",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"38888281-d0d1-4018-93c1-ec7c7c89d8b2": 2.0,
"81cd4e31-01b3-4edf-b3c7-f9e797effd97": 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": "75e759d9-81be-46fc-888e-9e0fa5c3966d",
"Name": "sample string 1",
"Created": "2026-07-19T20:08:41.7389415+00:00",
"Modified": "2026-07-19T20:08:41.7389415+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4801be2f-73b1-4fa8-b971-25a1b0c1e90c",
"bcc345e5-970b-4390-92de-a71bcb3bb000"
],
"NonLaborAssignments": [
{
"Id": "d2bb8d10-7cf6-40fe-9cad-a1f836b13779",
"ResourceId": "0522aa0a-ef65-4ae0-ae49-2220baf4c8c9",
"Quantity": 3.0
},
{
"Id": "d2bb8d10-7cf6-40fe-9cad-a1f836b13779",
"ResourceId": "0522aa0a-ef65-4ae0-ae49-2220baf4c8c9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "32ee6263-2c40-4dd3-9c30-bc2cb7cef8f1",
"Type": 0,
"ResourceId": "dbcf1750-3e2a-470f-b94d-a1e73c6dbb69",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "32ee6263-2c40-4dd3-9c30-bc2cb7cef8f1",
"Type": 0,
"ResourceId": "dbcf1750-3e2a-470f-b94d-a1e73c6dbb69",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3ccecb0e-3b59-441b-a5bf-e54c8ee5635f",
"WorkTypeParentId": "d50f48a1-184d-4867-9704-6acb02cde98f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "afb0bec2-31db-419e-8cf7-06ca02c8b80a",
"UPN": "87c100c7-a438-4dd6-a827-7ecaa216544a",
"PostDate": "2026-07-19T20:08:41.7389415+00:00",
"Comment": "sample string 4",
"CC": [
"9f35acae-db5c-4672-b0e7-59425c6e62cc",
"e8d66b74-6152-4939-8c71-9c49d0b537fc"
],
"Users": [
"109a62fb-b0e0-44be-b6bb-c114875a2b31",
"a172dc74-5bd5-4ed2-a9ec-50389241b862"
]
},
{
"Id": "afb0bec2-31db-419e-8cf7-06ca02c8b80a",
"UPN": "87c100c7-a438-4dd6-a827-7ecaa216544a",
"PostDate": "2026-07-19T20:08:41.7389415+00:00",
"Comment": "sample string 4",
"CC": [
"9f35acae-db5c-4672-b0e7-59425c6e62cc",
"e8d66b74-6152-4939-8c71-9c49d0b537fc"
],
"Users": [
"109a62fb-b0e0-44be-b6bb-c114875a2b31",
"a172dc74-5bd5-4ed2-a9ec-50389241b862"
]
}
],
"StartDate": "2026-07-19T20:08:41.7389415+00:00",
"DueDate": "2026-07-19T20:08:41.7389415+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bd9d5ec5-8906-49ca-b619-24a6cc120a15": "e9a5ab15-8c95-4f2b-859d-6291be34bb30",
"3f35c98e-88e4-499f-a0a4-b9529d4656b5": "267aa201-af48-445d-9207-5ee510b5cd1b"
},
"HasUpdates": true,
"Modified": "2026-07-19T20:08:41.7389415+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-19T20:08:41.7389415+00:00"
},
"LastComment": "2026-07-19T20:08:41.7389415+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9d41f08e-5258-4c85-acd0-e8b1f256ca38",
"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": "3b3032c5-c58e-404e-8aa4-8286204fc81b",
"id": "185b753a-7e87-499d-8e19-ff6b4cc0c44f",
"ConfigId": "9476d321-f88c-420e-89bc-79294b8c5bb5"
}