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": "b6a7ad37-4387-45b5-9894-c2c9c9236652",
"ParentTaskId": "ebea7079-84b6-40b4-a5a9-aa4bc43bfcf9",
"Integration": {
"IntegrationId": "53e07223-f986-4af7-be3e-1b65f22a9f62",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e8b51d28-904b-415e-b3f8-9b209b18c1a0": 2.0,
"00b69334-9379-4912-be94-c5259fb9f942": 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": "10c7646f-887f-444e-8afd-b759b610f944",
"Name": "sample string 1",
"Created": "2026-07-31T16:28:55.6104527+00:00",
"Modified": "2026-07-31T16:28:55.6104527+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2fcd682a-73a5-479d-90e5-aceae1f82257",
"6f89d2be-d9bd-46fa-a597-d2e08464ad54"
],
"NonLaborAssignments": [
{
"Id": "54ba61a1-c4ac-45c2-b871-5a726a213070",
"ResourceId": "b6612ad3-f7d7-4044-b1c7-72afabc388d4",
"Quantity": 3.0
},
{
"Id": "54ba61a1-c4ac-45c2-b871-5a726a213070",
"ResourceId": "b6612ad3-f7d7-4044-b1c7-72afabc388d4",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c125c65a-6c52-449c-a599-75bc63f615db",
"Type": 0,
"ResourceId": "49fd38a0-11f8-4fc3-9205-b888a7458199",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "c125c65a-6c52-449c-a599-75bc63f615db",
"Type": 0,
"ResourceId": "49fd38a0-11f8-4fc3-9205-b888a7458199",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "33482ee7-b55c-4dd7-afba-ac475136d2d2",
"WorkTypeParentId": "b7cba90a-7d37-4e25-81c3-b12d61016d23",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e685203b-8853-40e9-84d5-2604c800f964",
"UPN": "9be8d109-4447-45f1-9771-96f1e63fefe4",
"PostDate": "2026-07-31T16:28:55.6104527+00:00",
"Comment": "sample string 4",
"CC": [
"639a4762-4800-48c1-9e4f-8575d17167c6",
"9f1d6af6-d862-4b83-bab0-2eb0f512030d"
],
"Users": [
"647bc2f2-e081-4353-b669-b83ceb88666a",
"ca2ed454-038c-4a3a-bea2-395c7acee3d0"
]
},
{
"Id": "e685203b-8853-40e9-84d5-2604c800f964",
"UPN": "9be8d109-4447-45f1-9771-96f1e63fefe4",
"PostDate": "2026-07-31T16:28:55.6104527+00:00",
"Comment": "sample string 4",
"CC": [
"639a4762-4800-48c1-9e4f-8575d17167c6",
"9f1d6af6-d862-4b83-bab0-2eb0f512030d"
],
"Users": [
"647bc2f2-e081-4353-b669-b83ceb88666a",
"ca2ed454-038c-4a3a-bea2-395c7acee3d0"
]
}
],
"StartDate": "2026-07-31T16:28:55.6104527+00:00",
"DueDate": "2026-07-31T16:28:55.6104527+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0ad7b238-aa97-4a3f-b49c-ef2e1daf3785": "33d8a788-5497-4d6a-9d8e-e26b614679b8",
"b28b6623-f631-4d38-83c3-7d0e098098a3": "38a34029-072b-4194-8c61-eac4bc0f809b"
},
"HasUpdates": true,
"Modified": "2026-07-31T16:28:55.6104527+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-31T16:28:55.6104527+00:00"
},
"LastComment": "2026-07-31T16:28:55.6104527+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "19bab3b7-2b15-400c-8c1c-73430ba25fa8",
"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": "af7194df-de31-4903-bf2c-1d9ff268bc55",
"id": "e4857465-5670-4abf-a9c3-a5bbb8cd8ce0",
"ConfigId": "7b53f358-4cdc-4b92-84c2-d606db9e8d25"
}