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": "d45b74c3-ccd5-49f9-8243-bb1af5ce8833",
"ParentTaskId": "f7032672-e001-41b8-8756-d7e16eaec11f",
"Integration": {
"IntegrationId": "9f125252-af54-48b4-9df7-2efb6c7b179b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d833a20f-d271-44fa-869e-f8773022547b": 2.0,
"be0d805a-ec96-4841-b640-ed1974050114": 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": "d40e9e98-9a01-42e2-8d76-07c0be57ceeb",
"Name": "sample string 1",
"Created": "2026-05-09T07:52:03.4646359+00:00",
"Modified": "2026-05-09T07:52:03.4646359+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e35b252d-6ee4-416b-b034-acd9f052d771",
"0f46c917-e775-49d7-b104-216685614961"
],
"NonLaborAssignments": [
{
"Id": "f278bd11-88ae-40d7-bc6d-86990644b343",
"ResourceId": "c8d616ca-1576-4cf1-8228-971e9105e565",
"Quantity": 3.0
},
{
"Id": "f278bd11-88ae-40d7-bc6d-86990644b343",
"ResourceId": "c8d616ca-1576-4cf1-8228-971e9105e565",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "2e2705aa-2677-48c5-8989-1c2766c75a7f",
"Type": 0,
"ResourceId": "37c8a98d-bdee-4d13-88dd-1676c532ca40",
"Units": 3.0
},
{
"Id": "2e2705aa-2677-48c5-8989-1c2766c75a7f",
"Type": 0,
"ResourceId": "37c8a98d-bdee-4d13-88dd-1676c532ca40",
"Units": 3.0
}
],
"ParentId": "e0957e2e-4716-4aaa-b388-00cf9a9686de",
"WorkTypeParentId": "7eaefe4f-88a8-45ce-8d72-cb42e30fad6b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bd06cd78-577f-4fe9-847c-ace678c2e618",
"UPN": "cbebce90-b5c2-4754-89f4-495896cce6aa",
"PostDate": "2026-05-09T07:52:03.4646359+00:00",
"Comment": "sample string 4",
"CC": [
"6813be11-42d3-4a81-b775-b2ba5e4c2075",
"1d203110-9163-4632-916e-bac0eb797006"
],
"Users": [
"dab1e540-a4d5-47c2-a2dd-4899fd7b0174",
"b8a45034-0984-471d-83d7-669c8b79074d"
]
},
{
"Id": "bd06cd78-577f-4fe9-847c-ace678c2e618",
"UPN": "cbebce90-b5c2-4754-89f4-495896cce6aa",
"PostDate": "2026-05-09T07:52:03.4646359+00:00",
"Comment": "sample string 4",
"CC": [
"6813be11-42d3-4a81-b775-b2ba5e4c2075",
"1d203110-9163-4632-916e-bac0eb797006"
],
"Users": [
"dab1e540-a4d5-47c2-a2dd-4899fd7b0174",
"b8a45034-0984-471d-83d7-669c8b79074d"
]
}
],
"StartDate": "2026-05-09T07:52:03.4646359+00:00",
"DueDate": "2026-05-09T07:52:03.4646359+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b7ab654d-14a6-414f-90a5-55bb36933933": "c1700fb8-f577-459c-b8c1-886b8c907bec",
"a807558d-99e2-4399-844f-294a261752c4": "9ed17d9b-b1dd-48f2-b134-a156a0214c33"
},
"HasUpdates": true,
"Modified": "2026-05-09T07:52:03.4646359+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-09T07:52:03.4646359+00:00"
},
"LastComment": "2026-05-09T07:52:03.4646359+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "70a5da6c-ed20-4b4e-a3bf-6ef52b9d4493",
"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": "07810829-79bd-48d4-88f7-b95e279396d5",
"id": "63a01f75-fe93-4297-98c8-e8481566daff",
"ConfigId": "8caa3b14-e251-4ca5-b901-3574e716e82a"
}