Epics
Update an epic
Changed onEpics belong to releases. This means that if you want to create one then you must scope it to a release.
You can list them all at once, or filter by release or product. All these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.
Once you have the id of a specific epic, you can inspect, modify, or delete them on the root epics resource.
put/epics/{id}
Request
- Base URLhttps://company.aha.io/api/v1
- Auth
- OAuth 2Authorization codehttps://{account-domain}.aha.io/oauth/authorizeToken URLhttps://{account-domain}.aha.io/oauth/token
- or HTTP bearer
- or API key in cookie session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Id identifier
Request body
Example request
{
"epic": {
"name": "New name",
"description": "New description"
}
}Response
Successful operation
Example response
{
"epic": {
"id": "999605892",
"name": "Epic 1",
"reference_num": "PRJ1-E-1",
"initiative_reference_num": "PRJ1-S-1",
"position": 1,
"score": 42,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"start_date": "2019-01-01",
"due_date": "2019-01-01",
"product_id": "131414752",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"status_changed_on": null,
"created_by_user": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"workflow_status": {
"id": "934242751",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"description": {
"id": "4321567",
"body": "Body of Epic Description",
"notable_id": "999605892",
"notable_type": "Epic",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"attachments": [],
"integration_fields": [
{
"id": "790422735",
"name": "id",
"value": "433333335",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "907392375",
"name": "key",
"value": "JRA-1222223",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"url": "https://company.aha.io/epics/PRJ1-E-1",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-1",
"release": {
"id": "278327321",
"product_id": "131414752",
"reference_num": "PRJ1-R-1",
"name": "Release 1",
"start_date": "2019-01-01",
"release_date": "2019-01-01",
"parking_lot": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/releases/PRJ1-R-1",
"resource": "https://company.aha.io/api/v1/releases/PRJ1-R-1",
"integration_fields": [
{
"id": "68217473",
"name": "id",
"value": "777",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"owner": {
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
}
},
"assigned_to_user": {
"default_assignee": false,
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
"features": [
{
"id": "1007868956",
"name": "Feature 1",
"reference_num": "PRJ1-1",
"created_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"url": "https://company.aha.io/features/PRJ1-1",
"resource": "https://company.aha.io/api/v1/features/PRJ1-1"
}
],
"initiative": {
"id": "423077122",
"name": "Initiative 1",
"reference_num": "PRJ1-S-1",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/initiatives/PRJ1-S-1",
"resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-1",
"description": {
"id": "673273729",
"body": "Description of initiative 1",
"notable_id": "423077122",
"notable_type": "Initiative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"integration_fields": [
{
"id": "546711007",
"name": "id",
"value": "9913333",
"integration_id": 186281709,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "966751335",
"name": "key",
"value": "JRA-987222",
"integration_id": 186281709,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
]
},
"goals": [
{
"id": "602095703",
"name": "Goal 1",
"url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-1",
"resource": "https://company.aha.io/api/v1/goals/DEMOENT-G-1",
"created_at": "2019-01-01T00:00:00.000Z",
"description": {
"id": "166463080",
"body": "Description of goal 1",
"notable_id": "602095703",
"notable_type": "StrategicImperative",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
}
}
],
"key_results": [],
"comments_count": 1,
"score_facts": [],
"tags": [
"Infrastructure"
],
"full_tags": [
{
"id": 775582684,
"name": "Infrastructure",
"color": "#7552e0"
}
],
"custom_fields": [
{
"id": 1001163083,
"key": "epic_custom_date",
"name": "Epic custom date",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "date",
"value": "2019-01-01"
},
{
"id": 1043080183,
"key": "priority",
"name": "Priority",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "string",
"value": "P2"
}
],
"epic_links": [
{
"link_type": "Depends on",
"link_type_id": 20,
"created_at": "2019-01-01T00:00:00.000Z",
"parent_record": {
"id": "999605892",
"name": "Epic 1",
"reference_num": "PRJ1-E-1",
"created_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"url": "https://company.aha.io/epics/PRJ1-E-1",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-1"
},
"child_record": {
"id": "580753216",
"name": "Here's another epic",
"reference_num": "PRJ1-E-2",
"created_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"url": "https://company.aha.io/epics/PRJ1-E-2",
"resource": "https://company.aha.io/api/v1/epics/PRJ1-E-2"
}
}
],
"master_feature_only_original_estimate": null,
"master_feature_only_remaining_estimate": null,
"master_feature_only_work_done": null,
"epic_only_original_estimate": null,
"epic_only_remaining_estimate": null,
"epic_only_work_done": null
}
}Changes
- breaking
the response property
//became nullable for the status - breaking
the
//response's property type changed fromobjecttonullfor status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status
- breaking
- info
added the optional property
//to the response with the status
- info