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": "383ff6b0-0718-4f16-9e2d-f58e596c2a6b",
"ParentTaskId": "2f9f5385-b77d-4f0b-b400-2d3152860422",
"Integration": {
"IntegrationId": "8d15eeb6-61c3-40e2-bea5-f26b91af9cb3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c0a7da69-ae07-42bf-a712-499b73545805": 2.0,
"933538eb-0a67-412c-9d6c-89b49be90474": 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": "b325a42d-159c-42b4-b987-fd1d7a22a299",
"Name": "sample string 1",
"Created": "2026-07-10T12:02:42.6571052+00:00",
"Modified": "2026-07-10T12:02:42.6571052+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"55befa90-c823-4078-a74c-d24f3be7cf79",
"93fc854d-a3ac-41a6-9a9e-1de1da877b48"
],
"NonLaborAssignments": [
{
"Id": "de8b0ec4-f897-4b98-9ef9-569c65f4b173",
"ResourceId": "ce85b8e1-4c82-41e2-8294-2ac1fc0ab13b",
"Quantity": 3.0
},
{
"Id": "de8b0ec4-f897-4b98-9ef9-569c65f4b173",
"ResourceId": "ce85b8e1-4c82-41e2-8294-2ac1fc0ab13b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4a9314ff-e6d0-4329-8308-68ea5dba87fc",
"Type": 0,
"ResourceId": "1402cf8a-9765-4609-ad1a-5b94a7af579e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "4a9314ff-e6d0-4329-8308-68ea5dba87fc",
"Type": 0,
"ResourceId": "1402cf8a-9765-4609-ad1a-5b94a7af579e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "18f35e10-25e6-4f5e-95f9-debe8fba4b80",
"WorkTypeParentId": "14e51082-0fd4-47e9-accf-43660c7e128a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8f6ccaec-54a8-4f60-ad40-49a87d616388",
"UPN": "42d45164-aecf-4b56-aafd-315c250ff1ad",
"PostDate": "2026-07-10T12:02:42.6571052+00:00",
"Comment": "sample string 4",
"CC": [
"f9b27e7f-c858-43fa-8f1a-ee18dcc91e24",
"58773123-5b37-4b27-bc06-313182925657"
],
"Users": [
"9f967d10-6986-4715-a8cb-476c0332585a",
"3b9aa08f-5de0-4308-80b7-08b09bfd1c6b"
]
},
{
"Id": "8f6ccaec-54a8-4f60-ad40-49a87d616388",
"UPN": "42d45164-aecf-4b56-aafd-315c250ff1ad",
"PostDate": "2026-07-10T12:02:42.6571052+00:00",
"Comment": "sample string 4",
"CC": [
"f9b27e7f-c858-43fa-8f1a-ee18dcc91e24",
"58773123-5b37-4b27-bc06-313182925657"
],
"Users": [
"9f967d10-6986-4715-a8cb-476c0332585a",
"3b9aa08f-5de0-4308-80b7-08b09bfd1c6b"
]
}
],
"StartDate": "2026-07-10T12:02:42.6571052+00:00",
"DueDate": "2026-07-10T12:02:42.6571052+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"65660575-094e-4c33-b0d7-b90ea6b86da6": "c0c50a38-57da-46c0-a306-8efd62cb0f4f",
"8cf7317f-0c7f-4e7c-bdc3-4dee950bdb0d": "00501cf9-d99a-401f-b3bd-d2d6cc210d3b"
},
"HasUpdates": true,
"Modified": "2026-07-10T12:02:42.6571052+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-10T12:02:42.6571052+00:00"
},
"LastComment": "2026-07-10T12:02:42.6571052+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "066c07be-fc17-4582-ba5a-0ade78d39903",
"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": "780788db-c9d7-4ad0-85c4-b6f7cacadac9",
"id": "7df4b9c8-8cc5-48f5-bfe1-9250924ae96a",
"ConfigId": "fe60f8c2-529b-4a86-95df-13b0e5ec37eb"
}