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": "9ee06d69-fc28-4715-93d6-b89dc67b6c30",
"ParentTaskId": "23b19645-cd92-435f-a9e7-2af8a0d65f35",
"Integration": {
"IntegrationId": "3670d213-1087-4157-b5f6-477e432eeafa",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"92a9c0d5-d530-41c5-9027-3666146d1762": 2.0,
"414190f8-5b03-4933-81d6-89c89065184a": 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": "e04d6688-3fe1-4017-8786-4c1d18f6abc1",
"Name": "sample string 1",
"Created": "2026-09-25T20:06:54.3385021+00:00",
"Modified": "2026-09-25T20:06:54.3385021+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2008b833-686d-4584-a72f-55acf8c88030",
"bcf31d6c-6d29-49d1-bb48-0cd78c008bfb"
],
"NonLaborAssignments": [
{
"Id": "0761b9c2-a7e0-43f3-a3c7-66c238c112cf",
"ResourceId": "ca8fd8ae-09fa-425d-8ab7-63cdb5deea1e",
"Quantity": 3.0
},
{
"Id": "0761b9c2-a7e0-43f3-a3c7-66c238c112cf",
"ResourceId": "ca8fd8ae-09fa-425d-8ab7-63cdb5deea1e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "03979f2d-fecb-4b6c-983b-dfaaf2127290",
"Type": 0,
"ResourceId": "8b4dcf09-7bb5-4a5b-9ef2-de43a086fb8a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a34081ac-2be7-4d0b-bf4a-8374029a18fd",
"Start": "2026-09-25T20:06:54.3385021+00:00",
"Due": "2026-09-25T20:06:54.3385021+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a34081ac-2be7-4d0b-bf4a-8374029a18fd",
"Start": "2026-09-25T20:06:54.3385021+00:00",
"Due": "2026-09-25T20:06:54.3385021+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "03979f2d-fecb-4b6c-983b-dfaaf2127290",
"Type": 0,
"ResourceId": "8b4dcf09-7bb5-4a5b-9ef2-de43a086fb8a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "a34081ac-2be7-4d0b-bf4a-8374029a18fd",
"Start": "2026-09-25T20:06:54.3385021+00:00",
"Due": "2026-09-25T20:06:54.3385021+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "a34081ac-2be7-4d0b-bf4a-8374029a18fd",
"Start": "2026-09-25T20:06:54.3385021+00:00",
"Due": "2026-09-25T20:06:54.3385021+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "821b0fa2-2e7b-4888-bd3e-df08001c1f80",
"WorkTypeParentId": "d2a6dbf8-2f86-4419-972f-4ace593215bb",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c439668f-8e35-4861-9b2f-f4d1af57783b",
"UPN": "ff707b1d-8e32-4493-8214-fd18fb06d141",
"PostDate": "2026-09-25T20:06:54.3385021+00:00",
"Comment": "sample string 4",
"CC": [
"3e2d1a80-3420-4842-9e89-0eb83fb79136",
"846e9af2-48fb-4f18-95e5-d1e601737fbb"
],
"Users": [
"0653b6a3-0ecb-4a40-a71d-b49d8d3910b4",
"8121de5d-42b4-4cc6-aa70-3f0b39edbbfd"
]
},
{
"Id": "c439668f-8e35-4861-9b2f-f4d1af57783b",
"UPN": "ff707b1d-8e32-4493-8214-fd18fb06d141",
"PostDate": "2026-09-25T20:06:54.3385021+00:00",
"Comment": "sample string 4",
"CC": [
"3e2d1a80-3420-4842-9e89-0eb83fb79136",
"846e9af2-48fb-4f18-95e5-d1e601737fbb"
],
"Users": [
"0653b6a3-0ecb-4a40-a71d-b49d8d3910b4",
"8121de5d-42b4-4cc6-aa70-3f0b39edbbfd"
]
}
],
"StartDate": "2026-09-25T20:06:54.3385021+00:00",
"DueDate": "2026-09-25T20:06:54.3385021+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f04d6475-d215-494d-a8b4-5934c8d567bd": "1af666f3-8cfc-44f3-97fd-65d9549b1f10",
"ec5bf4a8-9d90-4bbf-bf44-0c8467b7a05e": "3bb5c6f4-2007-45bf-a3ad-8416a2288127"
},
"HasUpdates": true,
"Modified": "2026-09-25T20:06:54.3385021+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-09-25T20:06:54.3385021+00:00"
},
"LastComment": "2026-09-25T20:06:54.3385021+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e47e3fb9-3d51-4baf-85fe-e99150180f7a",
"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": "8b7b03ae-b881-49bd-822a-6abeb7322fbb",
"id": "e6a5cb05-f2a0-437d-b298-1699073a2451",
"ConfigId": "ee9d0eab-5a8b-4cc2-a206-592df72811cf"
}