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": "b349dc01-a410-4eb6-85ab-d99c3004745f",
"ParentTaskId": "02278e1a-b3e1-47fb-828c-f46770aa703b",
"Integration": {
"IntegrationId": "3862777a-3c97-434f-a10a-cc294f3f69b2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c887200a-2237-4230-a9bf-30c4a37365cc": 2.0,
"ca1f6bd4-a4cf-4a2f-bb3c-69a928ea9e96": 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": "163bfc6a-1226-4719-9c4e-84e8bfda113a",
"Name": "sample string 1",
"Created": "2026-09-02T08:11:33.9867724+00:00",
"Modified": "2026-09-02T08:11:33.9867724+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"6d3f0b19-0e21-496d-9c0f-caacc31fa721",
"98966eef-a5e4-4ded-9f79-8f47652186de"
],
"NonLaborAssignments": [
{
"Id": "2b974522-f5be-4481-bcab-316aab52c43a",
"ResourceId": "647b4ada-03f3-4846-8764-da6561b80cfa",
"Quantity": 3.0
},
{
"Id": "2b974522-f5be-4481-bcab-316aab52c43a",
"ResourceId": "647b4ada-03f3-4846-8764-da6561b80cfa",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4ddd7e97-f4e0-4fbc-b71a-aa3a974616f5",
"Type": 0,
"ResourceId": "f95df06e-f71d-4ec1-94fd-d1bf7d94a60f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "652ed804-be6c-4f59-b748-d728a036b099",
"Start": "2026-09-02T08:11:33.9867724+00:00",
"Due": "2026-09-02T08:11:33.9867724+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "652ed804-be6c-4f59-b748-d728a036b099",
"Start": "2026-09-02T08:11:33.9867724+00:00",
"Due": "2026-09-02T08:11:33.9867724+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "4ddd7e97-f4e0-4fbc-b71a-aa3a974616f5",
"Type": 0,
"ResourceId": "f95df06e-f71d-4ec1-94fd-d1bf7d94a60f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "652ed804-be6c-4f59-b748-d728a036b099",
"Start": "2026-09-02T08:11:33.9867724+00:00",
"Due": "2026-09-02T08:11:33.9867724+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "652ed804-be6c-4f59-b748-d728a036b099",
"Start": "2026-09-02T08:11:33.9867724+00:00",
"Due": "2026-09-02T08:11:33.9867724+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "fbdf28aa-e6aa-4fe3-956f-01ce410b6cd1",
"WorkTypeParentId": "36b44afc-d25a-4b06-b419-3ae08d98f14c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "44dc0dd9-005e-4f69-912f-43c91502177d",
"UPN": "f620936f-f9fa-464d-a0d0-253d34b30456",
"PostDate": "2026-09-02T08:11:33.9867724+00:00",
"Comment": "sample string 4",
"CC": [
"eb0ddf18-c3ff-47a1-a952-5fbdfdbc4026",
"0b449c6b-ef89-471e-aedf-6c4fd5b6bd3c"
],
"Users": [
"9bacf74b-97e8-4d50-b058-baa9518df1f1",
"f4d6bc04-24e1-4584-8ccf-394f46592b9d"
]
},
{
"Id": "44dc0dd9-005e-4f69-912f-43c91502177d",
"UPN": "f620936f-f9fa-464d-a0d0-253d34b30456",
"PostDate": "2026-09-02T08:11:33.9867724+00:00",
"Comment": "sample string 4",
"CC": [
"eb0ddf18-c3ff-47a1-a952-5fbdfdbc4026",
"0b449c6b-ef89-471e-aedf-6c4fd5b6bd3c"
],
"Users": [
"9bacf74b-97e8-4d50-b058-baa9518df1f1",
"f4d6bc04-24e1-4584-8ccf-394f46592b9d"
]
}
],
"StartDate": "2026-09-02T08:11:33.9867724+00:00",
"DueDate": "2026-09-02T08:11:33.9867724+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fee64525-5469-4925-9566-738e0c41ea1a": "bc757853-2f49-4993-8f4e-16ae7a9eb0e4",
"7c6359d4-b6cf-4ec5-9d70-74f7fe98a529": "afaa7000-0590-41e4-8cf1-264edb86d346"
},
"HasUpdates": true,
"Modified": "2026-09-02T08:11:33.9867724+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-02T08:11:33.9867724+00:00"
},
"LastComment": "2026-09-02T08:11:33.9867724+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b98a6203-625e-4109-820f-cd88a0ba6a36",
"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": "d3cc48f0-6b40-4725-b3a4-29eb6b3b7013",
"id": "6553bfcb-0fa5-467c-85da-4ff1fdea6aa4",
"ConfigId": "66e3924f-a676-4c49-ba71-be3555ae01cb"
}