Requirements

Create a requirement

Changed on
post/features/{feature_id}/requirements

Request

Path parameters

feature_idstring required

FeatureId identifier

Request body

Example request

{
  "requirement": {
    "name": "New name",
    "start_date": "2019-01-01",
    "end_date": "2019-01-01",
    "workflow_status": {
      "name": "Designed"
    },
    "description": "<p>This is the description</p>",
    "assigned_to_user": {
      "email": "no-reply@aha.io"
    }
  }
}

Response

Successful operation

Example response

{
  "feature": {
    "id": "6776881149487717549",
    "name": "Body of requirement 1",
    "reference_num": "PRJ1-251",
    "initiative_reference_num": null,
    "release_reference_num": "PRJ1-R-1",
    "epic_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",
    "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_kind": {
      "id": "98484309",
      "name": "New"
    },
    "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": "910541534",
      "body": "Body of requirement 1",
      "notable_id": "6776881149487717549",
      "notable_type": "Feature",
      "editor_version": 1,
      "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/features/PRJ1-251",
    "resource": "https://company.aha.io/api/v1/features/PRJ1-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": 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"
    },
    "requirements": [],
    "goals": [],
    "comments_count": 1,
    "score_facts": [],
    "tags": [],
    "full_tags": [],
    "custom_fields": [
      {
        "id": "6776881149495350529",
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "date",
        "value": "2019-01-01"
      }
    ],
    "feature_links": [
      {
        "link_type": "Relates to",
        "link_type_id": 10,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "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"
        },
        "child_record": {
          "id": "6776881149487717549",
          "name": "Body of requirement 1",
          "reference_num": "PRJ1-251",
          "created_at": "2019-01-01T00:00:00.000Z",
          "product_id": "131414752",
          "url": "https://company.aha.io/features/PRJ1-251",
          "resource": "https://company.aha.io/api/v1/features/PRJ1-251"
        }
      }
    ],
    "workflow_status_times": [
      {
        "status_id": "934242751",
        "status_name": "New",
        "started_at": "2019-01-01T00:00:00.000Z",
        "ended_at": null
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

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

    • info

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