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": "a8689677-3c6a-493c-87e4-f26cb3696a0f",
"ParentTaskId": "e88e9611-d342-465d-9769-9e215ab11a0d",
"Integration": {
"IntegrationId": "6f233cda-e2aa-449a-aa75-6616b7a6dadd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d62e2b41-d3c2-4138-899e-d7071e71ae70": 2.0,
"600e99b0-e00f-429d-9de8-6a2cbec9a9f6": 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": "a63cb7d4-1430-44ab-8b24-1989a69d432a",
"Name": "sample string 1",
"Created": "2026-05-23T04:14:50.3623008+00:00",
"Modified": "2026-05-23T04:14:50.3623008+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c65360c6-d9ac-4854-91aa-52146178753b",
"ee974cc8-a29d-4e89-ae2e-b3d1d0bbba87"
],
"NonLaborAssignments": [
{
"Id": "37961da7-64d0-43ca-a5d5-563006642305",
"ResourceId": "1faf0db4-82b8-494a-9a33-4c9f95049189",
"Quantity": 3.0
},
{
"Id": "37961da7-64d0-43ca-a5d5-563006642305",
"ResourceId": "1faf0db4-82b8-494a-9a33-4c9f95049189",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "611f5299-15ea-4ca5-8c30-07e85a105a35",
"Type": 0,
"ResourceId": "79753da6-8496-40e8-b023-6f44137b55a1",
"Units": 3.0
},
{
"Id": "611f5299-15ea-4ca5-8c30-07e85a105a35",
"Type": 0,
"ResourceId": "79753da6-8496-40e8-b023-6f44137b55a1",
"Units": 3.0
}
],
"ParentId": "dbf20827-fc75-4571-bbc4-622d56a07234",
"WorkTypeParentId": "57fc4d4d-fbdd-41bb-8e6f-a0441963b0d4",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "59c80319-9e2b-4d4e-88b5-198bc140531e",
"UPN": "4b349dff-123c-4d16-95a9-7ad9391ae3b4",
"PostDate": "2026-05-23T04:14:50.3623008+00:00",
"Comment": "sample string 4",
"CC": [
"5bbd93ea-6c0e-4012-b139-e19fe832eb39",
"a922a7a2-3466-4ce7-aa21-c687ef62b2f3"
],
"Users": [
"b43c3c1e-8d18-448a-b499-61e8a1cf93b6",
"15b8c1f1-71ab-4f8b-880c-2146599b70eb"
]
},
{
"Id": "59c80319-9e2b-4d4e-88b5-198bc140531e",
"UPN": "4b349dff-123c-4d16-95a9-7ad9391ae3b4",
"PostDate": "2026-05-23T04:14:50.3623008+00:00",
"Comment": "sample string 4",
"CC": [
"5bbd93ea-6c0e-4012-b139-e19fe832eb39",
"a922a7a2-3466-4ce7-aa21-c687ef62b2f3"
],
"Users": [
"b43c3c1e-8d18-448a-b499-61e8a1cf93b6",
"15b8c1f1-71ab-4f8b-880c-2146599b70eb"
]
}
],
"StartDate": "2026-05-23T04:14:50.3623008+00:00",
"DueDate": "2026-05-23T04:14:50.3623008+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"641f8776-999a-4cbf-8798-0a98968b7dba": "999a3c5b-a897-4827-ac2a-d8f447954a61",
"1397e4ba-f0ed-44cb-a107-bc046364ce04": "562a9200-dca6-45dd-bcba-d8efbe8717f2"
},
"HasUpdates": true,
"Modified": "2026-05-23T04:14:50.3623008+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-23T04:14:50.3623008+00:00"
},
"LastComment": "2026-05-23T04:14:50.3623008+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b45a482b-8d5a-4f81-b988-85d67929d8f6",
"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": "c4e47677-d9ba-4966-8d9a-f6c99250956a",
"id": "d22bc339-13e5-4cb3-a6af-d627a10c980f",
"ConfigId": "3cbe4135-6ad4-4392-beaa-3a0bfe94d0cb"
}