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": "42fec3bb-354f-47b9-8829-f4e9532b4022",
"ParentTaskId": "d378e616-a742-44ba-b4c4-81b756b90a4e",
"Integration": {
"IntegrationId": "7618b9d1-b124-466b-b78d-f27a68e94377",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"91ecc747-80eb-45a3-9e41-49dc5ec4b73a": 2.0,
"b0d060a5-685f-483a-b30e-2b53e1221326": 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": "8eae83c6-f3b7-460a-bb8d-ed652f45726d",
"Name": "sample string 1",
"Created": "2026-09-17T14:09:26.6775775+00:00",
"Modified": "2026-09-17T14:09:26.6775775+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"9c567563-e580-438e-a837-f306a1da31a4",
"511ba9b7-2296-4087-8ddf-a24e535c54b8"
],
"NonLaborAssignments": [
{
"Id": "bb365089-ff79-4a22-aa30-748932cf70b9",
"ResourceId": "68040ab4-b67e-4b5e-8d6e-7c94143b6be8",
"Quantity": 3.0
},
{
"Id": "bb365089-ff79-4a22-aa30-748932cf70b9",
"ResourceId": "68040ab4-b67e-4b5e-8d6e-7c94143b6be8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "36122005-1b5c-4720-9d14-5374732010ac",
"Type": 0,
"ResourceId": "3b750081-e365-4bb7-8501-8070aaba32df",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "111e2d74-17d6-4d42-93ca-55708b1a145e",
"Start": "2026-09-17T14:09:26.6775775+00:00",
"Due": "2026-09-17T14:09:26.6775775+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "111e2d74-17d6-4d42-93ca-55708b1a145e",
"Start": "2026-09-17T14:09:26.6775775+00:00",
"Due": "2026-09-17T14:09:26.6775775+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "36122005-1b5c-4720-9d14-5374732010ac",
"Type": 0,
"ResourceId": "3b750081-e365-4bb7-8501-8070aaba32df",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "111e2d74-17d6-4d42-93ca-55708b1a145e",
"Start": "2026-09-17T14:09:26.6775775+00:00",
"Due": "2026-09-17T14:09:26.6775775+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "111e2d74-17d6-4d42-93ca-55708b1a145e",
"Start": "2026-09-17T14:09:26.6775775+00:00",
"Due": "2026-09-17T14:09:26.6775775+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "c8bf71cb-ee98-4874-9987-ac7e869ccbe8",
"WorkTypeParentId": "2b3d9c5e-d229-4c20-992e-ffa75899b3fa",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bfec2d41-2fc2-4f4b-ae46-e81ab6c03ead",
"UPN": "ee0f44e5-155c-46ba-962d-aa0243eb4c87",
"PostDate": "2026-09-17T14:09:26.6775775+00:00",
"Comment": "sample string 4",
"CC": [
"bfc6273f-6e9d-4fa5-910e-8167cb847fd2",
"03c0a4ab-ee3e-4950-a1c9-e9721fb93c0c"
],
"Users": [
"fad0ddbd-c7fd-4cf4-8da7-dec783ae108d",
"3089af1e-f152-407e-bc8b-9a26fe541364"
]
},
{
"Id": "bfec2d41-2fc2-4f4b-ae46-e81ab6c03ead",
"UPN": "ee0f44e5-155c-46ba-962d-aa0243eb4c87",
"PostDate": "2026-09-17T14:09:26.6775775+00:00",
"Comment": "sample string 4",
"CC": [
"bfc6273f-6e9d-4fa5-910e-8167cb847fd2",
"03c0a4ab-ee3e-4950-a1c9-e9721fb93c0c"
],
"Users": [
"fad0ddbd-c7fd-4cf4-8da7-dec783ae108d",
"3089af1e-f152-407e-bc8b-9a26fe541364"
]
}
],
"StartDate": "2026-09-17T14:09:26.6775775+00:00",
"DueDate": "2026-09-17T14:09:26.6775775+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cf544517-206b-414b-8a68-54a847de8129": "c26d2433-6f8c-4680-aa9f-2d8ce583c6c7",
"af7bf82a-609e-449e-9699-a8a80a1ae9e9": "186723d5-7c5f-4617-b23a-90e96852468d"
},
"HasUpdates": true,
"Modified": "2026-09-17T14:09:26.6775775+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-17T14:09:26.6775775+00:00"
},
"LastComment": "2026-09-17T14:09:26.6775775+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c9689170-a4e0-4411-af82-40d81715d939",
"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": "8d63bb91-58e7-487d-a05c-90a299d0a0c7",
"id": "06cf38ef-92a6-4f60-95a9-a366926e7ccc",
"ConfigId": "a653a0ad-87c3-430d-8f94-18a558ade14e"
}