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": "a0be1ee4-d246-4e07-8eb6-09ab3d3e6cd7",
"ParentTaskId": "8c48a771-552d-4770-a1b1-11caa45e31b6",
"Integration": {
"IntegrationId": "8f488261-2949-4dec-85f2-16201bccfa0b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"9fd51684-1f97-4fc1-9f82-c88ee764e88f": 2.0,
"e3b658ed-e71c-459d-832b-86d2a5ade6a7": 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": "bfe2416e-ecaf-4330-b9a2-63bf9696d751",
"Name": "sample string 1",
"Created": "2026-10-21T01:00:31.4544235+00:00",
"Modified": "2026-10-21T01:00:31.4544235+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f1d9f9c3-0c06-4b5e-8378-e96f7fd1524d",
"ea735b8b-42bb-4796-93b8-cc317962acb1"
],
"NonLaborAssignments": [
{
"Id": "c3e07194-1029-4165-a1d2-6078b620acac",
"ResourceId": "ecd68951-ef02-4787-8928-465561cd9840",
"Quantity": 3.0
},
{
"Id": "c3e07194-1029-4165-a1d2-6078b620acac",
"ResourceId": "ecd68951-ef02-4787-8928-465561cd9840",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "414000a2-5411-47f1-8c3b-c3140691a23e",
"Type": 0,
"ResourceId": "bf0d2194-b67c-4265-b4a5-70b3a0b9eafe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6ccb3435-fd88-427c-92ee-713d52889173",
"Start": "2026-10-21T01:00:31.4544235+00:00",
"Due": "2026-10-21T01:00:31.4544235+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6ccb3435-fd88-427c-92ee-713d52889173",
"Start": "2026-10-21T01:00:31.4544235+00:00",
"Due": "2026-10-21T01:00:31.4544235+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "414000a2-5411-47f1-8c3b-c3140691a23e",
"Type": 0,
"ResourceId": "bf0d2194-b67c-4265-b4a5-70b3a0b9eafe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6ccb3435-fd88-427c-92ee-713d52889173",
"Start": "2026-10-21T01:00:31.4544235+00:00",
"Due": "2026-10-21T01:00:31.4544235+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6ccb3435-fd88-427c-92ee-713d52889173",
"Start": "2026-10-21T01:00:31.4544235+00:00",
"Due": "2026-10-21T01:00:31.4544235+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "a59be695-5ef4-403f-a7c3-dc2f2cdaf4e1",
"WorkTypeParentId": "27df56f6-fdaa-4416-abc2-13e2de1e3fd1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "43332e63-81c9-4a47-acc2-c786c8b7e088",
"UPN": "f3f8a0d4-0076-47d2-a649-5405373d1775",
"PostDate": "2026-10-21T01:00:31.4544235+00:00",
"Comment": "sample string 4",
"CC": [
"a21bf405-6dc8-4659-aceb-1957c533a8db",
"b5d7c811-c68b-489d-b772-81fb14e120ad"
],
"Users": [
"35f0bff5-b059-478c-b0ee-ebb79d98323a",
"3dfad3f5-24b0-46a1-8a89-80140c859d9a"
]
},
{
"Id": "43332e63-81c9-4a47-acc2-c786c8b7e088",
"UPN": "f3f8a0d4-0076-47d2-a649-5405373d1775",
"PostDate": "2026-10-21T01:00:31.4544235+00:00",
"Comment": "sample string 4",
"CC": [
"a21bf405-6dc8-4659-aceb-1957c533a8db",
"b5d7c811-c68b-489d-b772-81fb14e120ad"
],
"Users": [
"35f0bff5-b059-478c-b0ee-ebb79d98323a",
"3dfad3f5-24b0-46a1-8a89-80140c859d9a"
]
}
],
"StartDate": "2026-10-21T01:00:31.4544235+00:00",
"DueDate": "2026-10-21T01:00:31.4544235+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cc2c2567-17f2-471c-99b8-0d3868b02edf": "ced7e156-8eba-4ff6-a3d8-86de3de30aae",
"4434b286-c069-4f6b-b4a9-85417ad8be00": "edd6d619-d234-412c-abf1-5f562b42537d"
},
"HasUpdates": true,
"Modified": "2026-10-21T01:00:31.4544235+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-21T01:00:31.4544235+00:00"
},
"LastComment": "2026-10-21T01:00:31.4544235+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7de31b5e-ae00-4ada-b81f-a79b877d3f12",
"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": "c3efa383-5e7d-40d7-a559-63a9bdcaa823",
"id": "84a84b46-11f3-4b04-a601-97425854425f",
"ConfigId": "edb3d3d1-cb2c-48f5-9236-ea1bd7685734"
}