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": "1cf0c6a6-94a8-4277-9ed7-e9c880ae2496",
"ParentTaskId": "8e834006-5b6a-4083-904a-db659c96c6c2",
"Integration": {
"IntegrationId": "5e1fcfff-317a-4a2e-8fb6-a6485883602f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9ed3f3e8-ff8c-4c87-b149-9ecbe390c4f7": 2.0,
"5c8838ab-9c1c-4e34-a993-c722a6c7fb05": 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": "aaf2ed6e-a0de-4ca5-a7ff-933dbb72a5ea",
"Name": "sample string 1",
"Created": "2026-05-26T08:43:41.7504331+00:00",
"Modified": "2026-05-26T08:43:41.7504331+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cb31fec1-4a5c-40b2-8285-9bcfad07ee09",
"0bdca9ad-4ff2-4dd3-988b-1fc4df20adf8"
],
"NonLaborAssignments": [
{
"Id": "0cf53bfe-a273-4b59-a944-78fc2fe8a5e5",
"ResourceId": "dbbb952e-d8c6-444a-b690-fc309548ab46",
"Quantity": 3.0
},
{
"Id": "0cf53bfe-a273-4b59-a944-78fc2fe8a5e5",
"ResourceId": "dbbb952e-d8c6-444a-b690-fc309548ab46",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "65cee662-2f80-4575-979a-32162333a152",
"Type": 0,
"ResourceId": "cdf0e905-a64c-47af-b3ee-2c9f7477018f",
"Units": 3.0
},
{
"Id": "65cee662-2f80-4575-979a-32162333a152",
"Type": 0,
"ResourceId": "cdf0e905-a64c-47af-b3ee-2c9f7477018f",
"Units": 3.0
}
],
"ParentId": "83414edd-6c25-4ac9-b996-4f49620892b5",
"WorkTypeParentId": "26a4bc63-388e-4b63-a3c9-1bdcfde91ab2",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4da9ad9c-3dd6-4b17-86a4-085d06bd2daa",
"UPN": "ee0ba898-2380-45b4-a128-1113705901fa",
"PostDate": "2026-05-26T08:43:41.7504331+00:00",
"Comment": "sample string 4",
"CC": [
"d539338f-8240-45fc-8493-a0ccd6519947",
"2a09c419-82ae-49f3-8e6a-cdbb26ee2269"
],
"Users": [
"46b0a102-ddac-48d3-a91b-b40e31ecc669",
"8dfb8aa1-e383-4ce0-aa10-f47fe66b95b0"
]
},
{
"Id": "4da9ad9c-3dd6-4b17-86a4-085d06bd2daa",
"UPN": "ee0ba898-2380-45b4-a128-1113705901fa",
"PostDate": "2026-05-26T08:43:41.7504331+00:00",
"Comment": "sample string 4",
"CC": [
"d539338f-8240-45fc-8493-a0ccd6519947",
"2a09c419-82ae-49f3-8e6a-cdbb26ee2269"
],
"Users": [
"46b0a102-ddac-48d3-a91b-b40e31ecc669",
"8dfb8aa1-e383-4ce0-aa10-f47fe66b95b0"
]
}
],
"StartDate": "2026-05-26T08:43:41.7504331+00:00",
"DueDate": "2026-05-26T08:43:41.7504331+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"c00ed5b8-03a1-48f5-8ecd-98ac8cf28db9": "6cd8f003-63b3-4d09-af68-abefe0b96f79",
"a768fc85-a670-419a-a85d-7b85574997af": "632aae73-ad3e-4e98-8d2d-78e2568c08c0"
},
"HasUpdates": true,
"Modified": "2026-05-26T08:43:41.7504331+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-26T08:43:41.7504331+00:00"
},
"LastComment": "2026-05-26T08:43:41.7504331+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ffe0821c-313a-43af-86aa-a56cd78b525d",
"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": "378d8322-78ef-4443-a46e-e1a00d469a83",
"id": "08c6362d-8dff-4793-bdd2-03491063f151",
"ConfigId": "bde48ef6-53d8-4237-9d38-e8b1f3e68a6b"
}