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": "8ce44d25-47bb-4fa6-aef4-97996091dbf3",
"ParentTaskId": "4cabf43c-4eae-4d70-ac2f-a2f3e45f22ec",
"Integration": {
"IntegrationId": "479374b2-7975-4ae6-aec1-a04fd048bca4",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0ac6c459-1fbe-4793-a66a-602509edd32a": 2.0,
"27635246-ce4b-47a3-af79-faef738c76f4": 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": "34ebe256-ed47-461c-abc6-e0bb9f60c65c",
"Name": "sample string 1",
"Created": "2026-11-07T01:23:12.2889401+00:00",
"Modified": "2026-11-07T01:23:12.2889401+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"c6d5d2b3-4820-42be-a184-7e8d67c493c2",
"4ec04276-a663-4e1c-ab2f-ed9470811776"
],
"NonLaborAssignments": [
{
"Id": "dc869696-1bc1-4789-85fb-571930a8fb1b",
"ResourceId": "b50b90ec-484a-4ffd-99a9-821cd9c30d39",
"Quantity": 3.0
},
{
"Id": "dc869696-1bc1-4789-85fb-571930a8fb1b",
"ResourceId": "b50b90ec-484a-4ffd-99a9-821cd9c30d39",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "6971b437-17c0-449a-911b-4f40c80b859f",
"Type": 0,
"ResourceId": "8b475d81-bfc0-4c51-8018-f86a878a4b53",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f57f2cc8-45ac-4452-a162-ef6abf8175be",
"Start": "2026-11-07T01:23:12.2889401+00:00",
"Due": "2026-11-07T01:23:12.2889401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f57f2cc8-45ac-4452-a162-ef6abf8175be",
"Start": "2026-11-07T01:23:12.2889401+00:00",
"Due": "2026-11-07T01:23:12.2889401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "6971b437-17c0-449a-911b-4f40c80b859f",
"Type": 0,
"ResourceId": "8b475d81-bfc0-4c51-8018-f86a878a4b53",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "f57f2cc8-45ac-4452-a162-ef6abf8175be",
"Start": "2026-11-07T01:23:12.2889401+00:00",
"Due": "2026-11-07T01:23:12.2889401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "f57f2cc8-45ac-4452-a162-ef6abf8175be",
"Start": "2026-11-07T01:23:12.2889401+00:00",
"Due": "2026-11-07T01:23:12.2889401+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "0b8d4219-7225-451f-88b4-faaa17699234",
"WorkTypeParentId": "bcfe647d-74cd-47dd-9b03-cd91bf28b160",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "5d58d3d3-9955-4bab-9426-33a6e8ad4181",
"UPN": "20f903dc-9b95-46d9-8de5-04ce2bb89bce",
"PostDate": "2026-11-07T01:23:12.2889401+00:00",
"Comment": "sample string 4",
"CC": [
"8923f78b-008d-44d9-b74b-e7b4f2ba4fbb",
"cec62892-d21a-49cb-8038-e3a596820b6c"
],
"Users": [
"7bd7c12b-74c2-44b2-ad51-df7dd00c34e2",
"61a78047-834e-4176-9afb-209528d4fdc1"
]
},
{
"Id": "5d58d3d3-9955-4bab-9426-33a6e8ad4181",
"UPN": "20f903dc-9b95-46d9-8de5-04ce2bb89bce",
"PostDate": "2026-11-07T01:23:12.2889401+00:00",
"Comment": "sample string 4",
"CC": [
"8923f78b-008d-44d9-b74b-e7b4f2ba4fbb",
"cec62892-d21a-49cb-8038-e3a596820b6c"
],
"Users": [
"7bd7c12b-74c2-44b2-ad51-df7dd00c34e2",
"61a78047-834e-4176-9afb-209528d4fdc1"
]
}
],
"StartDate": "2026-11-07T01:23:12.2889401+00:00",
"DueDate": "2026-11-07T01:23:12.2889401+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7f83e9fc-7c59-47b3-8e18-b277fc0ef173": "e24a0ac7-1b6d-4aad-aec8-a34566f13b56",
"8302d340-96f9-4838-9ca7-5d29b9243aea": "0146629b-7bac-490d-8895-33537d30a629"
},
"HasUpdates": true,
"Modified": "2026-11-07T01:23:12.2889401+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-11-07T01:23:12.2889401+00:00"
},
"LastComment": "2026-11-07T01:23:12.2889401+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "9fb70fd4-e168-4eb4-b1e0-b216b3632167",
"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": "05352f89-e900-410d-befd-ea1b84e4257a",
"id": "25eb3d10-3d3b-47ca-8a50-10ddbdf3df2d",
"ConfigId": "efe73eaa-7711-4616-a2e1-c2a3b455293a"
}