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": "ced0221c-8113-4e04-9ad6-452ebec17423",
"ParentTaskId": "6aa8a4e6-9378-4c2d-bac0-9e11da1b68b4",
"Integration": {
"IntegrationId": "694be4d4-9807-4c21-9db5-819373748cfe",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f70c70d1-4099-422d-8644-92fc47266a63": 2.0,
"d8067f8a-696a-45f5-88de-92e657f51348": 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": "2c9fbe62-ad2b-47d6-acef-8c63e3b2ab7b",
"Name": "sample string 1",
"Created": "2026-07-07T14:00:02.7665117+00:00",
"Modified": "2026-07-07T14:00:02.7665117+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"884d7a9f-d794-4946-9bfb-4928e1f91947",
"8359cb2c-baea-48ac-8c4d-4ab253a03ae6"
],
"NonLaborAssignments": [
{
"Id": "239410aa-9e94-463e-8ea0-de86713dd9b3",
"ResourceId": "1f1b922c-7118-4ca9-8cf1-3cd1a2d44fc1",
"Quantity": 3.0
},
{
"Id": "239410aa-9e94-463e-8ea0-de86713dd9b3",
"ResourceId": "1f1b922c-7118-4ca9-8cf1-3cd1a2d44fc1",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "11ab102a-89f6-4f8a-8085-d82b041d9e00",
"Type": 0,
"ResourceId": "896aaa33-5ec4-489b-9172-f57fdc852fbb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "11ab102a-89f6-4f8a-8085-d82b041d9e00",
"Type": 0,
"ResourceId": "896aaa33-5ec4-489b-9172-f57fdc852fbb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "e6dd6d31-36b1-4624-935a-a0820ac87896",
"WorkTypeParentId": "276b7cea-abb8-4a7d-ae93-707844ddc54f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b64e6f72-f7b7-42ce-b1bc-a57e6c037ef6",
"UPN": "a2bed32a-a2a9-47fb-a35a-895920de01f9",
"PostDate": "2026-07-07T14:00:02.7665117+00:00",
"Comment": "sample string 4",
"CC": [
"e65e45aa-eb4e-43b2-9d5a-ea48677a3b61",
"5fccecb1-e5d4-40be-86a0-491285691a8d"
],
"Users": [
"e6b1cc64-1677-4456-8c76-d156ec888dc8",
"588a37de-2a05-459b-a077-f869f0c22f54"
]
},
{
"Id": "b64e6f72-f7b7-42ce-b1bc-a57e6c037ef6",
"UPN": "a2bed32a-a2a9-47fb-a35a-895920de01f9",
"PostDate": "2026-07-07T14:00:02.7665117+00:00",
"Comment": "sample string 4",
"CC": [
"e65e45aa-eb4e-43b2-9d5a-ea48677a3b61",
"5fccecb1-e5d4-40be-86a0-491285691a8d"
],
"Users": [
"e6b1cc64-1677-4456-8c76-d156ec888dc8",
"588a37de-2a05-459b-a077-f869f0c22f54"
]
}
],
"StartDate": "2026-07-07T14:00:02.7665117+00:00",
"DueDate": "2026-07-07T14:00:02.7665117+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3581decd-87fd-47e0-87a5-d0a1570de50d": "ac6621d4-d543-4153-9fb9-14f5bccd8a72",
"3f9ca188-e8fb-455a-9d65-5d6f228f0fe8": "e4367309-3860-487f-9edd-03212a2dda9b"
},
"HasUpdates": true,
"Modified": "2026-07-07T14:00:02.7665117+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-07T14:00:02.7665117+00:00"
},
"LastComment": "2026-07-07T14:00:02.7665117+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "fd516c9c-941d-4c1d-922b-21a2e472ac36",
"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": "58a88af2-4a50-41ef-b92f-1aec33483be1",
"id": "1120743a-5fed-4944-b365-b5f412831e3e",
"ConfigId": "3d02af35-5f44-4057-92f6-077bf9a9df6e"
}