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": "01c74c1f-00b3-475b-beb0-a2aead048cc0",
"ParentTaskId": "f7e7099d-e941-4b07-b702-854c8e0ca5fc",
"Integration": {
"IntegrationId": "19003fed-b6de-410b-b188-4d0af9620ca7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"51d463b9-c38d-448c-8e81-bfdaf04958a8": 2.0,
"2aa3aee2-db00-4538-9cc2-7b2db149c51a": 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": "11a59aab-3632-4285-b2e7-f82f2cc28f09",
"Name": "sample string 1",
"Created": "2026-05-08T08:40:30.567187+00:00",
"Modified": "2026-05-08T08:40:30.567187+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"310b41e4-78c5-4dc5-8fbc-4b3effff6583",
"d58b0a94-f307-404d-932f-415ce9c74aab"
],
"NonLaborAssignments": [
{
"Id": "20c3bce7-93af-4a1c-a169-7a9db7e0d1cc",
"ResourceId": "a7f5828a-125d-4bb7-8de5-9fab46cb0a9b",
"Quantity": 3.0
},
{
"Id": "20c3bce7-93af-4a1c-a169-7a9db7e0d1cc",
"ResourceId": "a7f5828a-125d-4bb7-8de5-9fab46cb0a9b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1cb27bc1-11b3-4e95-8931-4a38034aadfb",
"Type": 0,
"ResourceId": "8d8e5d5c-a4e9-4d4e-bb34-dc7b40590630",
"Units": 3.0
},
{
"Id": "1cb27bc1-11b3-4e95-8931-4a38034aadfb",
"Type": 0,
"ResourceId": "8d8e5d5c-a4e9-4d4e-bb34-dc7b40590630",
"Units": 3.0
}
],
"ParentId": "9de696ca-b35c-43ba-a65d-2501f3b8f767",
"WorkTypeParentId": "45af3e83-38b4-4fa3-8844-daae296eb0ea",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a7d22eb9-2a08-46c3-acb5-9097e6989bcf",
"UPN": "cc24dca8-07c2-45fe-ad68-761e7a38e212",
"PostDate": "2026-05-08T08:40:30.567187+00:00",
"Comment": "sample string 4",
"CC": [
"356b703a-1e92-4842-949b-2c5069be2676",
"0338c000-8675-48ad-a47c-8cee172d1b1b"
],
"Users": [
"d00c6b2b-13e5-455c-9859-24623e3d4255",
"8d6e8f71-e7b5-41a6-8368-b52ca9560653"
]
},
{
"Id": "a7d22eb9-2a08-46c3-acb5-9097e6989bcf",
"UPN": "cc24dca8-07c2-45fe-ad68-761e7a38e212",
"PostDate": "2026-05-08T08:40:30.567187+00:00",
"Comment": "sample string 4",
"CC": [
"356b703a-1e92-4842-949b-2c5069be2676",
"0338c000-8675-48ad-a47c-8cee172d1b1b"
],
"Users": [
"d00c6b2b-13e5-455c-9859-24623e3d4255",
"8d6e8f71-e7b5-41a6-8368-b52ca9560653"
]
}
],
"StartDate": "2026-05-08T08:40:30.567187+00:00",
"DueDate": "2026-05-08T08:40:30.567187+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"556250e0-6ab8-406c-91c1-9622a639a663": "399991f5-4af0-46f3-90c9-ed1c84ec5668",
"f0661096-5e1a-4a1f-bd7d-3b1810757ffc": "e41a6f57-ef61-4cc0-b8b6-969853421a51"
},
"HasUpdates": true,
"Modified": "2026-05-08T08:40:30.567187+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-05-08T08:40:30.567187+00:00"
},
"LastComment": "2026-05-08T08:40:30.567187+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d12cdd2d-65a5-428c-a5f3-5375e9fa6f2f",
"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": "f5ff291b-2366-46b0-92a7-e8f58b910003",
"id": "1dd4bae1-ea17-41b1-9b8b-5b23e1b2c91a",
"ConfigId": "834872f3-4c4d-4cea-b53e-e6278d970188"
}