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": "a6366b8a-f3cd-4ee1-a255-824120d4c9bd",
"ParentTaskId": "8f0f8064-e91a-4c2b-881a-915a4282c7a9",
"Integration": {
"IntegrationId": "8ceac66c-0c22-40e8-8db9-8aee30b7deac",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"67e3b3ec-86a0-4d70-a56f-206374d5242e": 2.0,
"a4fa8ee9-ce74-46ed-b1aa-ed2f57eeae16": 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": "85381450-8d51-49c6-a8b8-a469a46602cb",
"Name": "sample string 1",
"Created": "2026-05-22T07:34:40.5934113+00:00",
"Modified": "2026-05-22T07:34:40.5934113+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0e53cbe9-59f6-417f-b51a-7cd6c5a05417",
"97b85a3e-97f1-4c26-b47c-358c176d5224"
],
"NonLaborAssignments": [
{
"Id": "ba8881d2-7328-4e49-8123-0fd0bbbaeda6",
"ResourceId": "2cde3239-9bea-46e8-ba56-9ff4314ffbc9",
"Quantity": 3.0
},
{
"Id": "ba8881d2-7328-4e49-8123-0fd0bbbaeda6",
"ResourceId": "2cde3239-9bea-46e8-ba56-9ff4314ffbc9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "61714909-6ea7-434c-8115-f8f2a3857f4a",
"Type": 0,
"ResourceId": "53dd106d-c793-4df9-a376-139757595ca3",
"Units": 3.0
},
{
"Id": "61714909-6ea7-434c-8115-f8f2a3857f4a",
"Type": 0,
"ResourceId": "53dd106d-c793-4df9-a376-139757595ca3",
"Units": 3.0
}
],
"ParentId": "a4e565fb-74c2-492d-b70e-72a60c3927b0",
"WorkTypeParentId": "785eba0a-fa96-4e38-aae9-d0db26052bdd",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b4cb2cab-8296-46a8-96c8-9ba1ebeee30e",
"UPN": "76f8a65d-0495-4776-99f9-6d88eb5ef05d",
"PostDate": "2026-05-22T07:34:40.5934113+00:00",
"Comment": "sample string 4",
"CC": [
"0c842ef9-c6b6-49ac-b5da-9f4bc05ea165",
"d91f00eb-8fd8-4ddb-b532-fec5bfb4ee94"
],
"Users": [
"6d2db3be-98f8-4146-baf8-ec147652a653",
"c809f8b6-4ad0-4ebb-a408-7136f70d5a91"
]
},
{
"Id": "b4cb2cab-8296-46a8-96c8-9ba1ebeee30e",
"UPN": "76f8a65d-0495-4776-99f9-6d88eb5ef05d",
"PostDate": "2026-05-22T07:34:40.5934113+00:00",
"Comment": "sample string 4",
"CC": [
"0c842ef9-c6b6-49ac-b5da-9f4bc05ea165",
"d91f00eb-8fd8-4ddb-b532-fec5bfb4ee94"
],
"Users": [
"6d2db3be-98f8-4146-baf8-ec147652a653",
"c809f8b6-4ad0-4ebb-a408-7136f70d5a91"
]
}
],
"StartDate": "2026-05-22T07:34:40.5934113+00:00",
"DueDate": "2026-05-22T07:34:40.5934113+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"a9c3f599-3bd7-430a-97e1-0dee737321c6": "8363549f-9800-4405-a60d-cb363c009d11",
"d75f94c2-6f69-4d97-9d63-a1b22f11dd09": "7345ea65-24ee-489b-9b41-124eafd4aafa"
},
"HasUpdates": true,
"Modified": "2026-05-22T07:34:40.5934113+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-22T07:34:40.5934113+00:00"
},
"LastComment": "2026-05-22T07:34:40.5934113+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3279150d-c5b0-4c2e-a5ba-e60a7c8ef521",
"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": "cd57bbb0-d88a-42f6-aead-615c5cc590d8",
"id": "0f708a6a-b74b-494e-b512-797a5a46f886",
"ConfigId": "1cea7192-5fd3-4399-ae35-d7b2dc28c59a"
}