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": "00ae20a6-1662-4953-9b71-9b6d7ee29321",
"ParentTaskId": "39eafd3e-0019-46ba-9dd0-383220d4630b",
"Integration": {
"IntegrationId": "f151e79c-7bb5-42b2-8937-8a764b59c64d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"769f7f2f-ee5c-40c6-ace2-fccee78e3e60": 2.0,
"11eb1a4a-171b-4d3b-bc44-f0c023b46c1a": 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": "1af04aed-1b45-4c88-ad05-d5cf57b05b66",
"Name": "sample string 1",
"Created": "2026-11-01T12:50:24.6408399+00:00",
"Modified": "2026-11-01T12:50:24.6408399+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1c9efe5e-15e1-43b3-bcb7-b809afeb2661",
"2a798542-b3a5-4cb0-bbab-6c027a3e78ed"
],
"NonLaborAssignments": [
{
"Id": "d332177f-2502-4eeb-bea8-b68aa8178709",
"ResourceId": "db860844-a669-44f7-a470-e8849c59caf8",
"Quantity": 3.0
},
{
"Id": "d332177f-2502-4eeb-bea8-b68aa8178709",
"ResourceId": "db860844-a669-44f7-a470-e8849c59caf8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "df470b6a-3584-49e5-9074-629a4cd7c773",
"Type": 0,
"ResourceId": "75ab75c5-3459-4cce-8cc2-ca1c20e075f8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9e42577e-c944-4457-8333-871b388e5a34",
"Start": "2026-11-01T12:50:24.6408399+00:00",
"Due": "2026-11-01T12:50:24.6408399+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9e42577e-c944-4457-8333-871b388e5a34",
"Start": "2026-11-01T12:50:24.6408399+00:00",
"Due": "2026-11-01T12:50:24.6408399+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "df470b6a-3584-49e5-9074-629a4cd7c773",
"Type": 0,
"ResourceId": "75ab75c5-3459-4cce-8cc2-ca1c20e075f8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9e42577e-c944-4457-8333-871b388e5a34",
"Start": "2026-11-01T12:50:24.6408399+00:00",
"Due": "2026-11-01T12:50:24.6408399+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9e42577e-c944-4457-8333-871b388e5a34",
"Start": "2026-11-01T12:50:24.6408399+00:00",
"Due": "2026-11-01T12:50:24.6408399+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "090d271c-83a7-4f90-abc7-39862865c828",
"WorkTypeParentId": "091f7374-3dbc-48bb-ae8f-fa0a799ada40",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "cc6b9d41-41ff-4c9f-bb90-920c323b956e",
"UPN": "d154a6c5-1093-4255-babc-352f2d4d83e6",
"PostDate": "2026-11-01T12:50:24.6408399+00:00",
"Comment": "sample string 4",
"CC": [
"51b66059-163a-4486-905a-5bf00f936b4e",
"dba09ff4-63ff-4b35-8b03-b0ddd54c807c"
],
"Users": [
"a5aae0d5-6e01-4372-85aa-c6546070a5a6",
"bc1cafd3-04a3-48fe-941b-eea19c8c997a"
]
},
{
"Id": "cc6b9d41-41ff-4c9f-bb90-920c323b956e",
"UPN": "d154a6c5-1093-4255-babc-352f2d4d83e6",
"PostDate": "2026-11-01T12:50:24.6408399+00:00",
"Comment": "sample string 4",
"CC": [
"51b66059-163a-4486-905a-5bf00f936b4e",
"dba09ff4-63ff-4b35-8b03-b0ddd54c807c"
],
"Users": [
"a5aae0d5-6e01-4372-85aa-c6546070a5a6",
"bc1cafd3-04a3-48fe-941b-eea19c8c997a"
]
}
],
"StartDate": "2026-11-01T12:50:24.6408399+00:00",
"DueDate": "2026-11-01T12:50:24.6408399+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bea59c58-954d-418e-a22d-2a8514dc904f": "a1cfb2e6-a77d-49dc-b440-f12b7c3e6531",
"99526ae4-84f7-44b8-aead-315d0f8d7f29": "94013e80-ffbd-4526-b914-04f6f8a2254f"
},
"HasUpdates": true,
"Modified": "2026-11-01T12:50:24.6408399+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-11-01T12:50:24.6408399+00:00"
},
"LastComment": "2026-11-01T12:50:24.6408399+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "995598a3-676e-4d27-a542-f860236dbf39",
"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": "48d5ed84-0885-456b-bb52-539a9a344de6",
"id": "36dd7565-de86-4a48-9ae3-61a22f6b60b4",
"ConfigId": "d8b53901-72b2-430b-a744-bb8a7eb7fbb1"
}