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": "2f0f38e7-d60c-4f75-b344-702000be35f6",
"ParentTaskId": "c23c01fd-6dae-453b-9f80-f44c3a00c549",
"Integration": {
"IntegrationId": "beb9f067-357d-4497-9ce0-52ac434bc8dd",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"09c83d5e-3c5d-4ac5-82cb-ab7208beae6a": 2.0,
"1ea22b99-b736-42c3-9e37-18280a3ba2a5": 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": "575cfae0-ca03-4e51-9642-f1941959239c",
"Name": "sample string 1",
"Created": "2026-06-19T01:33:34.8931541+00:00",
"Modified": "2026-06-19T01:33:34.8931541+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ba70dd1c-de29-4a47-95cf-93027a8894b9",
"648b68b2-9e68-4669-88ba-342bec239d9b"
],
"NonLaborAssignments": [
{
"Id": "9cb35162-45d3-4cdf-b3f2-68eea5c32df4",
"ResourceId": "79f2bd0e-e357-42b3-93a1-5be3718a9def",
"Quantity": 3.0
},
{
"Id": "9cb35162-45d3-4cdf-b3f2-68eea5c32df4",
"ResourceId": "79f2bd0e-e357-42b3-93a1-5be3718a9def",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f8acbcb4-ebb3-4d2a-a9f1-a90900429b29",
"Type": 0,
"ResourceId": "092f8b31-7f2b-4b31-8faf-c2a7fd33b36e",
"Units": 3.0
},
{
"Id": "f8acbcb4-ebb3-4d2a-a9f1-a90900429b29",
"Type": 0,
"ResourceId": "092f8b31-7f2b-4b31-8faf-c2a7fd33b36e",
"Units": 3.0
}
],
"ParentId": "3d9625be-0c00-4a24-919f-a67a70ac4cdd",
"WorkTypeParentId": "f9cf993e-5683-42b2-a443-58b26777366e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "819e082a-8109-435d-a768-f5c8cab9e050",
"UPN": "652622e8-e13a-4da3-9bfe-17a0bd59e42c",
"PostDate": "2026-06-19T01:33:34.8931541+00:00",
"Comment": "sample string 4",
"CC": [
"90fc87cb-99b8-4f2a-a386-06dc366ce632",
"385c482b-d93c-4355-b30a-684558375045"
],
"Users": [
"982fed18-4b60-4910-8b08-6201d33bd6c3",
"98ea5a6f-8446-4a8a-81d2-ece562da7b4c"
]
},
{
"Id": "819e082a-8109-435d-a768-f5c8cab9e050",
"UPN": "652622e8-e13a-4da3-9bfe-17a0bd59e42c",
"PostDate": "2026-06-19T01:33:34.8931541+00:00",
"Comment": "sample string 4",
"CC": [
"90fc87cb-99b8-4f2a-a386-06dc366ce632",
"385c482b-d93c-4355-b30a-684558375045"
],
"Users": [
"982fed18-4b60-4910-8b08-6201d33bd6c3",
"98ea5a6f-8446-4a8a-81d2-ece562da7b4c"
]
}
],
"StartDate": "2026-06-19T01:33:34.8931541+00:00",
"DueDate": "2026-06-19T01:33:34.8931541+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d7c66c05-8753-4220-860c-64d9a2bd4fd5": "9f6b9386-2871-4d16-bc11-433054207228",
"c7c78d23-5450-4222-ba45-c824a7ac6d74": "3dc5ba20-1b0f-4ca6-bb39-0ca1cb062d42"
},
"HasUpdates": true,
"Modified": "2026-06-19T01:33:34.8931541+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-06-19T01:33:34.8931541+00:00"
},
"LastComment": "2026-06-19T01:33:34.8931541+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6c8b0823-a62b-43dd-87fb-d96ff651e3b8",
"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": "75efc93e-5807-4796-90f9-15a789377052",
"id": "cf2c7723-34f3-4468-9f18-44987d9a1862",
"ConfigId": "abec7c07-85f7-437b-a57b-c9e6e8b8097a"
}