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": "6335e62b-a89e-49fe-9d14-4059477707da",
"ParentTaskId": "f187e98b-e069-4e68-aa23-8bf4c2000c01",
"Integration": {
"IntegrationId": "b234f4ed-38e2-44b6-9010-c838e018b692",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a7693f2d-b8bd-46a6-bb84-6755ab7e2c62": 2.0,
"d4c7979d-2be6-4610-ae5e-4cf81dd88f84": 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": "5e4031ea-02b3-4903-9488-f4872ebe0561",
"Name": "sample string 1",
"Created": "2026-07-08T08:41:01.6611073+00:00",
"Modified": "2026-07-08T08:41:01.6611073+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ff9fa3e6-6fee-4056-b297-e605a93b5e94",
"2b9a0414-20c6-48e5-bb41-ce1e26d55309"
],
"NonLaborAssignments": [
{
"Id": "b1360623-0f61-4c47-93b7-19e95ad27d0e",
"ResourceId": "032d14ed-8144-451b-8daa-b2da5c989017",
"Quantity": 3.0
},
{
"Id": "b1360623-0f61-4c47-93b7-19e95ad27d0e",
"ResourceId": "032d14ed-8144-451b-8daa-b2da5c989017",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ee5210e6-a347-4bff-8e6c-04f117850450",
"Type": 0,
"ResourceId": "94d91a5d-93b4-4429-88f0-a20c617ec7aa",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "ee5210e6-a347-4bff-8e6c-04f117850450",
"Type": 0,
"ResourceId": "94d91a5d-93b4-4429-88f0-a20c617ec7aa",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "64ef62d2-9202-4b77-8cd6-ee9b41633463",
"WorkTypeParentId": "6853b696-eae7-4f6d-a8b8-675f519dd846",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a8dbfe1f-c054-4451-bcf3-3574260c0f03",
"UPN": "fc5b8568-2215-4531-8d36-5590fa9db24f",
"PostDate": "2026-07-08T08:41:01.6611073+00:00",
"Comment": "sample string 4",
"CC": [
"2945f232-4368-4b54-8d9d-b64fcc638e5e",
"45c0ae02-a123-435d-a906-d5b040641b94"
],
"Users": [
"f4a940e8-de19-474b-9842-d6500c6046c5",
"b077fd28-1a7e-44ac-bd6b-d184644ae25a"
]
},
{
"Id": "a8dbfe1f-c054-4451-bcf3-3574260c0f03",
"UPN": "fc5b8568-2215-4531-8d36-5590fa9db24f",
"PostDate": "2026-07-08T08:41:01.6611073+00:00",
"Comment": "sample string 4",
"CC": [
"2945f232-4368-4b54-8d9d-b64fcc638e5e",
"45c0ae02-a123-435d-a906-d5b040641b94"
],
"Users": [
"f4a940e8-de19-474b-9842-d6500c6046c5",
"b077fd28-1a7e-44ac-bd6b-d184644ae25a"
]
}
],
"StartDate": "2026-07-08T08:41:01.6611073+00:00",
"DueDate": "2026-07-08T08:41:01.6611073+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"529c6975-3579-4b56-a9c5-6248c3c729d9": "28dcb1cb-4870-41e9-867a-d3659c166096",
"dc370c8a-be8f-48c4-9f99-ef7f64d3761a": "5b2558b3-636f-4e64-b10c-53e855355fb5"
},
"HasUpdates": true,
"Modified": "2026-07-08T08:41:01.6611073+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-08T08:41:01.6611073+00:00"
},
"LastComment": "2026-07-08T08:41:01.6611073+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7f30f0c8-9e19-4f56-8403-fc7391080f34",
"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": "f0990e0c-ea98-4734-88c3-449a0db78b5f",
"id": "fbf3ce2b-fc26-4d05-a3bd-4e6ae6e7b6d3",
"ConfigId": "6b2ac6c4-c4f5-4874-a85f-f5cd9bf55f75"
}