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": "dba02a3f-b407-4e6c-b116-4294f81f0b36",
"ParentTaskId": "8f5ef774-fc90-46cb-9007-b668062fef04",
"Integration": {
"IntegrationId": "1894c4de-1e17-4760-8e2b-1fb4271dae9f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a7df79ac-b630-4c43-b31b-155bfc2a8a65": 2.0,
"b5b2506c-52e4-40fb-9f28-39a0cfcf3927": 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": "63d73307-5e2f-4d12-89d5-e588ba5778ba",
"Name": "sample string 1",
"Created": "2026-09-02T20:41:45.6423424+00:00",
"Modified": "2026-09-02T20:41:45.6423424+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ef72e29d-8022-4e62-9aca-93d872de5549",
"f603cc33-0c5d-4584-a9ea-d1a2c14a59c8"
],
"NonLaborAssignments": [
{
"Id": "0244aa66-6d4f-4e4b-bc00-1f9e502f6913",
"ResourceId": "dee36acc-fa7b-43b6-a930-c2261d22da0f",
"Quantity": 3.0
},
{
"Id": "0244aa66-6d4f-4e4b-bc00-1f9e502f6913",
"ResourceId": "dee36acc-fa7b-43b6-a930-c2261d22da0f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "91b49405-4df2-436a-8653-a2b9abb8b495",
"Type": 0,
"ResourceId": "7fd30946-df00-4d11-8ba5-04c9be65bb64",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3dd38994-4dbe-4660-9a9a-03640e55d5c9",
"Start": "2026-09-02T20:41:45.6579737+00:00",
"Due": "2026-09-02T20:41:45.6579737+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3dd38994-4dbe-4660-9a9a-03640e55d5c9",
"Start": "2026-09-02T20:41:45.6579737+00:00",
"Due": "2026-09-02T20:41:45.6579737+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "91b49405-4df2-436a-8653-a2b9abb8b495",
"Type": 0,
"ResourceId": "7fd30946-df00-4d11-8ba5-04c9be65bb64",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "3dd38994-4dbe-4660-9a9a-03640e55d5c9",
"Start": "2026-09-02T20:41:45.6579737+00:00",
"Due": "2026-09-02T20:41:45.6579737+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "3dd38994-4dbe-4660-9a9a-03640e55d5c9",
"Start": "2026-09-02T20:41:45.6579737+00:00",
"Due": "2026-09-02T20:41:45.6579737+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "dfcfc05e-0939-40d4-86a2-6fdc1599abff",
"WorkTypeParentId": "892e2837-3898-45fd-8383-1cc61853a074",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bbe8599a-9ca5-4d32-a42a-5cd61db9a353",
"UPN": "e633ba68-2aea-4c6c-8629-389bc4744eec",
"PostDate": "2026-09-02T20:41:45.6579737+00:00",
"Comment": "sample string 4",
"CC": [
"bf9932d7-36e6-447d-b5ce-5ae37db4f0fa",
"38e90c80-5754-4b54-bbeb-a9519577b66b"
],
"Users": [
"83a4d182-c639-4742-b15b-bbaca6918d00",
"bb3615c1-d9a0-40fe-80ba-d77fad844dac"
]
},
{
"Id": "bbe8599a-9ca5-4d32-a42a-5cd61db9a353",
"UPN": "e633ba68-2aea-4c6c-8629-389bc4744eec",
"PostDate": "2026-09-02T20:41:45.6579737+00:00",
"Comment": "sample string 4",
"CC": [
"bf9932d7-36e6-447d-b5ce-5ae37db4f0fa",
"38e90c80-5754-4b54-bbeb-a9519577b66b"
],
"Users": [
"83a4d182-c639-4742-b15b-bbaca6918d00",
"bb3615c1-d9a0-40fe-80ba-d77fad844dac"
]
}
],
"StartDate": "2026-09-02T20:41:45.6579737+00:00",
"DueDate": "2026-09-02T20:41:45.6579737+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"01bd8bc7-e1fe-4e99-a4fa-9d2943acc954": "680f39fe-3999-43a8-bac9-7c00e2560b5e",
"3d9051b2-3864-4dfb-9a2f-c13631a01912": "602185e8-829b-4fbc-bce6-022eb1d13669"
},
"HasUpdates": true,
"Modified": "2026-09-02T20:41:45.6579737+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-02T20:41:45.6579737+00:00"
},
"LastComment": "2026-09-02T20:41:45.6579737+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e17b4e6c-39e2-465e-951a-62fcf0415c87",
"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": "cf580a12-361d-4060-839d-769ba055fb58",
"id": "9075f5b9-5b2b-410a-a2ac-3e845edf07a4",
"ConfigId": "a6cb6163-f25e-4ec7-8609-ec2721734a59"
}