Requirements

Get a specific requirement

get/requirements/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Response

Successful operation

Example response

{
  "requirement": {
    "id": "483368544",
    "name": "Body of requirement 1",
    "reference_num": "PRJ1-1-1",
    "position": 1,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "release_id": 278327321,
    "start_date": "2019-01-01",
    "end_date": "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
    },
    "url": "https://company.aha.io/requirements/PRJ1-1-1",
    "resource": "https://company.aha.io/api/v1/requirements/PRJ1-1-1",
    "description": {
      "id": "910541534",
      "body": "Body of requirement 1",
      "notable_id": "483368544",
      "notable_type": "Requirement",
      "editor_version": 1,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "feature": {
      "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"
    },
    "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"
    },
    "attachments": [],
    "tags": [],
    "full_tags": [],
    "custom_fields": [
      {
        "id": 848810602,
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "date",
        "value": "2019-01-01"
      },
      {
        "id": 731808726,
        "key": "requested_by",
        "name": "Requested By",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "string",
        "value": "TK"
      }
    ],
    "integration_fields": [
      {
        "id": "32487847",
        "name": "key",
        "value": "JRA-987",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "417785887",
        "name": "id",
        "value": "991",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "803330186",
        "name": "aha::remote_entity",
        "value": "issue_10100",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "comments_count": 1
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.