AHaha
Epics

Create an epic

Changed on

Epics 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.

post/releases/{release_id}/epics

Request

Path parameters

release_idstring required

ReleaseId identifier

Request body

Example request

{
  "epic": {
    "name": "New name",
    "description": "New description"
  }
}

Response

Successful operation

Example response

{
  "epic": {
    "id": "6776881149490664912",
    "name": "New epics",
    "reference_num": "PRJ1-E-251",
    "initiative_reference_num": null,
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": "131414752",
    "progress": 0,
    "progress_source": "progress_manual",
    "duration_source": "duration_manual",
    "status_changed_on": "2019-01-01",
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "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": "6776881149493505600",
      "body": "New description",
      "notable_id": "6776881149490664912",
      "notable_type": "Epic",
      "editor_version": 2,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "attachments": [],
    "integration_fields": [],
    "url": "https://company.aha.io/epics/PRJ1-E-251",
    "resource": "https://company.aha.io/api/v1/epics/PRJ1-E-251",
    "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": true,
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "features": [],
    "goals": [],
    "key_results": [],
    "comments_count": 0,
    "score_facts": [],
    "tags": [],
    "full_tags": [],
    "custom_fields": [],
    "workflow_status_times": [
      {
        "status_id": "934242751",
        "status_name": "New",
        "started_at": "2019-01-01T00:00:00.000Z",
        "ended_at": null
      }
    ],
    "epic_links": [],
    "master_feature_only_original_estimate": 58,
    "master_feature_only_remaining_estimate": 58,
    "master_feature_only_work_done": null,
    "epic_only_original_estimate": 58,
    "epic_only_remaining_estimate": 58,
    "epic_only_work_done": null,
    "watchers": [
      {
        "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"
      },
      {
        "id": "689956296",
        "name": "Henry Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      }
    ]
  }
}

Changes

  • bfbe6f6d74a1Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the // response's property type changed from object to null for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

  • 69bd8c9e8932Revision changes
    • info

      added the optional property // to the response with the status