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": "2247ff55-e571-4306-9eb8-5870deb74cd5",
"ParentTaskId": "041510ab-c50c-4c30-983e-d53c10105b19",
"Integration": {
"IntegrationId": "98188087-d72e-4cbd-8511-b35a960a3478",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"94f26104-1861-43dd-9289-32d0b5811651": 2.0,
"8987d729-5860-4f4d-bb4d-84eec917dff9": 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": "fbfd8eba-b96d-44de-9751-9c348d956595",
"Name": "sample string 1",
"Created": "2026-07-17T04:13:51.3395184+00:00",
"Modified": "2026-07-17T04:13:51.3395184+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8394ce25-48c7-4d76-955b-7f556b7a9ae7",
"33ddd39f-553a-44a6-9438-7f1d45372997"
],
"NonLaborAssignments": [
{
"Id": "31a2b7be-11e5-4e95-97da-0f046dd94625",
"ResourceId": "320838da-6cbb-4b31-91ac-b2b359de5f96",
"Quantity": 3.0
},
{
"Id": "31a2b7be-11e5-4e95-97da-0f046dd94625",
"ResourceId": "320838da-6cbb-4b31-91ac-b2b359de5f96",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b64d43a1-bd60-4603-8edb-ba475935f647",
"Type": 0,
"ResourceId": "21ee5bab-bf5e-4742-9711-f52a936c8e28",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "b64d43a1-bd60-4603-8edb-ba475935f647",
"Type": 0,
"ResourceId": "21ee5bab-bf5e-4742-9711-f52a936c8e28",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "bfba73e5-8348-4063-b73f-6d2af25dd7f7",
"WorkTypeParentId": "2f4ea945-f7f8-4098-ba8f-f9adcaaae9a2",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d9f4647b-fe8d-468f-9709-32b610c967b5",
"UPN": "1e1704e4-512a-4e75-867c-df4fd2ae9236",
"PostDate": "2026-07-17T04:13:51.3395184+00:00",
"Comment": "sample string 4",
"CC": [
"39bc854c-732a-480d-99c9-de457a317154",
"cdc9e2fe-bb35-46e4-93e3-5c65cc2f64a8"
],
"Users": [
"44d69070-40fb-4dbd-9e61-4ec574308f81",
"5179f4b3-36a5-4792-b064-3247ca9ebc4a"
]
},
{
"Id": "d9f4647b-fe8d-468f-9709-32b610c967b5",
"UPN": "1e1704e4-512a-4e75-867c-df4fd2ae9236",
"PostDate": "2026-07-17T04:13:51.3395184+00:00",
"Comment": "sample string 4",
"CC": [
"39bc854c-732a-480d-99c9-de457a317154",
"cdc9e2fe-bb35-46e4-93e3-5c65cc2f64a8"
],
"Users": [
"44d69070-40fb-4dbd-9e61-4ec574308f81",
"5179f4b3-36a5-4792-b064-3247ca9ebc4a"
]
}
],
"StartDate": "2026-07-17T04:13:51.3395184+00:00",
"DueDate": "2026-07-17T04:13:51.3395184+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"17d6bb99-b5f5-4177-b653-6f8371dd22e6": "31a70406-4dc9-4d98-b6a0-aacfcdffc20b",
"443dc883-9b07-49dc-ab62-c00bd8db7d47": "926b4574-2977-4d8a-96f2-099b801550fd"
},
"HasUpdates": true,
"Modified": "2026-07-17T04:13:51.3395184+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-17T04:13:51.3395184+00:00"
},
"LastComment": "2026-07-17T04:13:51.3395184+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3a96c65b-6670-4f92-bef4-53d771d6dacf",
"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": "a78a7452-02f3-4526-8dc7-4aa15f8af450",
"id": "1621d276-6bbc-46e3-b5ad-012e58b29b04",
"ConfigId": "e3359131-c2c7-4da5-842b-d6d037f376db"
}