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": "af570663-f73b-41f1-afd9-ea245ca865e5",
"ParentTaskId": "68502ad0-1e61-4f02-85ef-4f6ab1936a4c",
"Integration": {
"IntegrationId": "b05bfe5d-94dc-4759-b283-d5318de10266",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"500b1b73-0e92-4c17-b32f-069d71523de9": 2.0,
"eeb3537e-9b4d-4c90-b08a-65ea0e84b2f9": 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": "be40660a-1aa0-4001-976b-b9e3c522790a",
"Name": "sample string 1",
"Created": "2026-09-12T22:04:14.2082207+00:00",
"Modified": "2026-09-12T22:04:14.2082207+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"94eb2a99-3958-4458-9944-dd67df12a5fa",
"75247a3f-2587-4aa0-91c9-70d35c2b5148"
],
"NonLaborAssignments": [
{
"Id": "8a676f04-39b4-4055-914f-7eb8b421578f",
"ResourceId": "f22444ed-02ef-4664-9f47-3d09234b3846",
"Quantity": 3.0
},
{
"Id": "8a676f04-39b4-4055-914f-7eb8b421578f",
"ResourceId": "f22444ed-02ef-4664-9f47-3d09234b3846",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "7f39f650-4ef1-419b-a524-b1ea4d0d31e6",
"Type": 0,
"ResourceId": "6a33c0c6-faa0-452e-9ed2-159cc93269f1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6590f913-f735-4d2c-a341-400a91d384ba",
"Start": "2026-09-12T22:04:14.2238458+00:00",
"Due": "2026-09-12T22:04:14.2238458+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6590f913-f735-4d2c-a341-400a91d384ba",
"Start": "2026-09-12T22:04:14.2238458+00:00",
"Due": "2026-09-12T22:04:14.2238458+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "7f39f650-4ef1-419b-a524-b1ea4d0d31e6",
"Type": 0,
"ResourceId": "6a33c0c6-faa0-452e-9ed2-159cc93269f1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6590f913-f735-4d2c-a341-400a91d384ba",
"Start": "2026-09-12T22:04:14.2238458+00:00",
"Due": "2026-09-12T22:04:14.2238458+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6590f913-f735-4d2c-a341-400a91d384ba",
"Start": "2026-09-12T22:04:14.2238458+00:00",
"Due": "2026-09-12T22:04:14.2238458+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "076798e2-7b86-464e-8511-d088cfb91393",
"WorkTypeParentId": "9c8093a6-3097-4319-9f0a-ea9ed36f8f86",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9b50add7-df35-4130-96f2-ebe60bce0262",
"UPN": "f80dc8ab-101b-4149-b80c-6c309796d070",
"PostDate": "2026-09-12T22:04:14.2238458+00:00",
"Comment": "sample string 4",
"CC": [
"a0740d9a-ecd1-422e-8374-6b37be86ae3d",
"458cbc93-975a-4c51-b16d-2f74ee96ef34"
],
"Users": [
"4afcb13f-8da1-418a-952d-32a1306ccb4e",
"80c70a4b-e0f0-45ab-9895-4a170529640c"
]
},
{
"Id": "9b50add7-df35-4130-96f2-ebe60bce0262",
"UPN": "f80dc8ab-101b-4149-b80c-6c309796d070",
"PostDate": "2026-09-12T22:04:14.2238458+00:00",
"Comment": "sample string 4",
"CC": [
"a0740d9a-ecd1-422e-8374-6b37be86ae3d",
"458cbc93-975a-4c51-b16d-2f74ee96ef34"
],
"Users": [
"4afcb13f-8da1-418a-952d-32a1306ccb4e",
"80c70a4b-e0f0-45ab-9895-4a170529640c"
]
}
],
"StartDate": "2026-09-12T22:04:14.2238458+00:00",
"DueDate": "2026-09-12T22:04:14.2238458+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"c156bc7b-872b-48d6-bb2a-14bb5ec42201": "a4cf950d-2ed5-4248-8910-8715ada8164b",
"d236d40e-3a56-417a-a5cd-b5f7a9f23bec": "b63157c9-f18b-4766-a5f4-65ea59975e1d"
},
"HasUpdates": true,
"Modified": "2026-09-12T22:04:14.2238458+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-12T22:04:14.2238458+00:00"
},
"LastComment": "2026-09-12T22:04:14.2238458+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "827b582b-4d4e-4727-a758-79b0b9f0f4d9",
"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": "add673eb-4a28-4b1e-9c51-41e7050cac06",
"id": "eec72216-768e-480f-8406-4a22f1414948",
"ConfigId": "4b34440f-c21b-4cd4-be05-6bf92dd8e241"
}