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": "60a82928-9109-4acc-a4ae-e4a8a455b7f9",
"ParentTaskId": "d438da23-9001-4aba-a094-a7b57593d963",
"Integration": {
"IntegrationId": "24c5a09f-5f6f-44dd-b998-634a5fce5f05",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"7434510b-afc6-4bd1-b877-1363c751d57f": 2.0,
"b310566c-b34b-49c7-9dc0-548d4cf34c4a": 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": "ea0a4522-b3fb-4911-b365-9d054207236a",
"Name": "sample string 1",
"Created": "2026-10-23T04:22:40.259601+00:00",
"Modified": "2026-10-23T04:22:40.259601+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"eab1aacf-841b-4625-a92b-d8a19c386e5b",
"cd0f0492-d40e-4151-a5fa-31fe78bbfb5a"
],
"NonLaborAssignments": [
{
"Id": "734c162a-760c-48ff-b1e1-970e9c2cd245",
"ResourceId": "994cc711-71db-45bf-93de-fefcf2b8eca7",
"Quantity": 3.0
},
{
"Id": "734c162a-760c-48ff-b1e1-970e9c2cd245",
"ResourceId": "994cc711-71db-45bf-93de-fefcf2b8eca7",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a52496a0-2fbc-4a13-aefb-14bac401d520",
"Type": 0,
"ResourceId": "131717ed-2fa0-441a-a0e5-7006543359b3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "ab8c4c48-b5e6-4e21-891c-8325d54335f7",
"Start": "2026-10-23T04:22:40.259601+00:00",
"Due": "2026-10-23T04:22:40.259601+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "ab8c4c48-b5e6-4e21-891c-8325d54335f7",
"Start": "2026-10-23T04:22:40.259601+00:00",
"Due": "2026-10-23T04:22:40.259601+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "a52496a0-2fbc-4a13-aefb-14bac401d520",
"Type": 0,
"ResourceId": "131717ed-2fa0-441a-a0e5-7006543359b3",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "ab8c4c48-b5e6-4e21-891c-8325d54335f7",
"Start": "2026-10-23T04:22:40.259601+00:00",
"Due": "2026-10-23T04:22:40.259601+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "ab8c4c48-b5e6-4e21-891c-8325d54335f7",
"Start": "2026-10-23T04:22:40.259601+00:00",
"Due": "2026-10-23T04:22:40.259601+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "ade3d836-ee71-4c87-8af9-0c7dc3e908c1",
"WorkTypeParentId": "5d6d9d02-33c8-482f-977f-86f1ce6522fa",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "97bb2de4-e524-4e81-9c8b-5d9f186a204b",
"UPN": "23d87c0f-2c33-458f-a911-fd6caac14c25",
"PostDate": "2026-10-23T04:22:40.259601+00:00",
"Comment": "sample string 4",
"CC": [
"ded087bf-dd84-4668-bdd3-749061b82653",
"77a944f5-751b-4e19-852f-50376a45308d"
],
"Users": [
"8f54e7f4-4616-4112-b902-370cc8ec2fba",
"bee540e1-1516-4aef-8cb1-ab00ee276d70"
]
},
{
"Id": "97bb2de4-e524-4e81-9c8b-5d9f186a204b",
"UPN": "23d87c0f-2c33-458f-a911-fd6caac14c25",
"PostDate": "2026-10-23T04:22:40.259601+00:00",
"Comment": "sample string 4",
"CC": [
"ded087bf-dd84-4668-bdd3-749061b82653",
"77a944f5-751b-4e19-852f-50376a45308d"
],
"Users": [
"8f54e7f4-4616-4112-b902-370cc8ec2fba",
"bee540e1-1516-4aef-8cb1-ab00ee276d70"
]
}
],
"StartDate": "2026-10-23T04:22:40.259601+00:00",
"DueDate": "2026-10-23T04:22:40.259601+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e9aac510-5582-4099-b190-16235aace3c3": "d9946323-2f59-46d7-a3f5-2ace28a0328c",
"6f05e337-0a7d-4a8f-b698-f34f182ac50c": "1410882a-0220-415f-ae74-ee538cc029dd"
},
"HasUpdates": true,
"Modified": "2026-10-23T04:22:40.259601+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-23T04:22:40.259601+00:00"
},
"LastComment": "2026-10-23T04:22:40.259601+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "825b24bd-edec-4daf-b761-7cd3a7841040",
"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": "b0635ef9-380f-498f-81b1-e767e284420e",
"id": "5dca6cd0-6696-488e-8e21-ef6f1d95bc64",
"ConfigId": "c4deb601-3954-41aa-bc0a-c424d35d6a36"
}