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": "50503979-2b09-4afc-b7e5-79848e8e46f7",
"ParentTaskId": "3d825c2b-787c-45cd-becc-a144ba22ea40",
"Integration": {
"IntegrationId": "b96e1faf-36aa-4eff-8156-d360dde489ef",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0a6e4924-b5ec-42a6-b443-acfbdc5667ef": 2.0,
"891b5a3f-58bd-4f3c-9c56-6114bc9123ea": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "19fafc0a-63ac-419d-8364-71df698a3da8",
"Name": "sample string 1",
"Created": "2025-11-23T21:26:30.5569738+00:00",
"Modified": "2025-11-23T21:26:30.5569738+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"88ca45b2-799e-4e21-a054-a91700a10fea",
"8f4ed5d1-2eb5-4424-98c1-468c73a2f184"
],
"NonLaborAssignments": [
{
"Id": "d4565f75-609d-44a8-a962-87283b573c53",
"ResourceId": "0235c980-beea-484f-964e-1ffbc873e65b",
"Quantity": 3.0
},
{
"Id": "d4565f75-609d-44a8-a962-87283b573c53",
"ResourceId": "0235c980-beea-484f-964e-1ffbc873e65b",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "2d488cd6-3bf1-47d8-91d0-81bf19f0eafc",
"Type": 0,
"ResourceId": "5ebe5195-8c5c-4388-aa5b-c6aa70a25b67",
"Units": 3.0
},
{
"Id": "2d488cd6-3bf1-47d8-91d0-81bf19f0eafc",
"Type": 0,
"ResourceId": "5ebe5195-8c5c-4388-aa5b-c6aa70a25b67",
"Units": 3.0
}
],
"ParentId": "0ed71ba4-8bc0-445b-a4a7-a86a99b94f8a",
"WorkTypeParentId": "e04b4761-6113-4231-a020-1b33710bbde8",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c97388e1-c656-4ee6-aca8-97510bbf435d",
"UPN": "7720bc8e-9117-46d7-a148-1a1665dddfe2",
"PostDate": "2025-11-23T21:26:30.5569738+00:00",
"Comment": "sample string 4",
"CC": [
"c8378a53-743d-4cf8-af1e-cc05a930c447",
"25e2cdbb-34cc-4d8e-a020-ee7bc1e70d04"
],
"Users": [
"a249c2fa-73a1-464c-8cce-38549cbd3cf7",
"5ea7a73e-aed9-4d09-a934-ea2334ff3a60"
]
},
{
"Id": "c97388e1-c656-4ee6-aca8-97510bbf435d",
"UPN": "7720bc8e-9117-46d7-a148-1a1665dddfe2",
"PostDate": "2025-11-23T21:26:30.5569738+00:00",
"Comment": "sample string 4",
"CC": [
"c8378a53-743d-4cf8-af1e-cc05a930c447",
"25e2cdbb-34cc-4d8e-a020-ee7bc1e70d04"
],
"Users": [
"a249c2fa-73a1-464c-8cce-38549cbd3cf7",
"5ea7a73e-aed9-4d09-a934-ea2334ff3a60"
]
}
],
"StartDate": "2025-11-23T21:26:30.5569738+00:00",
"DueDate": "2025-11-23T21:26:30.5569738+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fe292361-94b2-4e51-b78d-66f8d0705266": "4c002bf1-10a3-495e-8ecb-9d1441ed938e",
"643c4b35-d0b2-4a71-b278-9d2911fd3e2a": "5c1bb60e-03a7-4b6c-b051-4c03de534cfc"
},
"HasUpdates": true,
"Modified": "2025-11-23T21:26:30.5569738+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": "2025-11-23T21:26:30.5569738+00:00"
},
"LastComment": "2025-11-23T21:26:30.5569738+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ad3fd1e1-f782-48ea-aa4a-7561d5730ef8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "28e0c553-923c-42fd-ae93-6c89d5d1a602",
"id": "fbfcbcde-99ef-4375-9d6a-077f3d3e8aae",
"ConfigId": "d5c84611-1d78-42af-afb8-59bc74bcfd19"
}