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": "a009de3f-f348-44f3-aaa9-7be0d4cb8a0c",
"ParentTaskId": "3a1a9757-fb12-4641-97ca-6107e20c4a52",
"Integration": {
"IntegrationId": "d8051af1-d116-4479-88ae-d4d1e04649f0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"477718de-649b-42c8-bbbf-46ef120d1061": 2.0,
"237393cc-ff9e-441e-ab12-980b634f2074": 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": "9da87db1-bc7d-44a4-b837-edaa1b8aae17",
"Name": "sample string 1",
"Created": "2026-10-24T20:53:14.3770478+00:00",
"Modified": "2026-10-24T20:53:14.3770478+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"82da967e-8295-480c-b72e-a37f83806d9e",
"c97f0063-f44c-4851-a435-2a2a5b3f258f"
],
"NonLaborAssignments": [
{
"Id": "cbcbdc02-b45c-432d-b80d-2e22e976ef41",
"ResourceId": "31bf9e99-6325-42be-8a6f-9c8d759c48a0",
"Quantity": 3.0
},
{
"Id": "cbcbdc02-b45c-432d-b80d-2e22e976ef41",
"ResourceId": "31bf9e99-6325-42be-8a6f-9c8d759c48a0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e5541271-f1be-49a9-b543-733048588f8b",
"Type": 0,
"ResourceId": "9060b71c-2807-4ce8-a604-4ef38bf08b7d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "aab8c554-b909-4f15-b7f1-6335b6edbe87",
"Start": "2026-10-24T20:53:14.3770478+00:00",
"Due": "2026-10-24T20:53:14.3770478+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "aab8c554-b909-4f15-b7f1-6335b6edbe87",
"Start": "2026-10-24T20:53:14.3770478+00:00",
"Due": "2026-10-24T20:53:14.3770478+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "e5541271-f1be-49a9-b543-733048588f8b",
"Type": 0,
"ResourceId": "9060b71c-2807-4ce8-a604-4ef38bf08b7d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "aab8c554-b909-4f15-b7f1-6335b6edbe87",
"Start": "2026-10-24T20:53:14.3770478+00:00",
"Due": "2026-10-24T20:53:14.3770478+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "aab8c554-b909-4f15-b7f1-6335b6edbe87",
"Start": "2026-10-24T20:53:14.3770478+00:00",
"Due": "2026-10-24T20:53:14.3770478+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "79422d35-da4c-4d13-bb4c-05dc5600954a",
"WorkTypeParentId": "75de548b-f765-4f9d-a0c8-ab058dec7171",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a9d0fb34-712d-4fe4-8720-b819e04f957e",
"UPN": "279d4170-c185-4a43-90c6-5d064062717e",
"PostDate": "2026-10-24T20:53:14.3770478+00:00",
"Comment": "sample string 4",
"CC": [
"3e3a75dc-23ed-474d-8f2e-a8e29239a99c",
"1d3b5c07-bf7a-4a62-94f7-60846a600f8a"
],
"Users": [
"1b0b1e1e-1665-4046-b8ca-cfcec89dbd89",
"a60a051c-578d-411d-bc6e-f1100f1fa649"
]
},
{
"Id": "a9d0fb34-712d-4fe4-8720-b819e04f957e",
"UPN": "279d4170-c185-4a43-90c6-5d064062717e",
"PostDate": "2026-10-24T20:53:14.3770478+00:00",
"Comment": "sample string 4",
"CC": [
"3e3a75dc-23ed-474d-8f2e-a8e29239a99c",
"1d3b5c07-bf7a-4a62-94f7-60846a600f8a"
],
"Users": [
"1b0b1e1e-1665-4046-b8ca-cfcec89dbd89",
"a60a051c-578d-411d-bc6e-f1100f1fa649"
]
}
],
"StartDate": "2026-10-24T20:53:14.3770478+00:00",
"DueDate": "2026-10-24T20:53:14.3770478+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"c0e2f266-3eed-4049-83f1-2336e1717b7b": "8eef98f8-38ad-4428-bc07-0f857f9e601d",
"e799118a-1131-4e8c-9de9-95a8da4cfa7d": "2a706380-acad-47d6-b57c-f58c0272471d"
},
"HasUpdates": true,
"Modified": "2026-10-24T20:53:14.3770478+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-10-24T20:53:14.3770478+00:00"
},
"LastComment": "2026-10-24T20:53:14.3770478+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b97120a7-c847-4c73-baf9-f4919407c30e",
"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": "3434bb32-40db-469a-ad05-aa66621369cb",
"id": "126eb225-4d86-46f0-a9d0-0b3b607dc58f",
"ConfigId": "d90a0eec-c2d1-4b6e-bb76-95cba4919df4"
}