Custom table record links

Create a custom table record link associated with a release

Changed on

Custom Tables are an Enterprise+ exclusive feature.

put/releases/{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

Request body

Example request

{
  "requirement": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Successful operation

Example response

{
  "release": {
    "id": "278327321",
    "product_id": "131414752",
    "reference_num": "PRJ1-R-1",
    "name": "Release 1",
    "start_date": "2019-01-01",
    "end_date": null,
    "development_started_on": "2019-01-01",
    "release_date": "2019-01-01",
    "external_release_date": "2019-01-01",
    "external_release_date_description": "Oct 13, 2026",
    "external_date_resolution": "exact",
    "released": false,
    "parking_lot": false,
    "master_release": false,
    "released_on": null,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "position": null,
    "progress": null,
    "progress_source": "progress_manual",
    "duration_source": "duration_manual",
    "status_changed_on": null,
    "theme": {
      "id": "522610666",
      "body": "Theme of the release",
      "notable_id": "278327321",
      "notable_type": "Release",
      "editor_version": 1,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "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"
      }
    ],
    "custom_fields": [
      {
        "id": "432637490",
        "key": "note",
        "name": "Note",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "note",
        "value": "<p>sample text</p>",
        "body": "<p>sample text</p>",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      {
        "id": "6776881149483941173",
        "key": "release_budget",
        "name": "Release budget",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "equation_sheet",
        "value": {
          "values": {
            "6651670327076753738": {
              "value": 123,
              "name": "Revenue",
              "display_value": "$123.00",
              "raw_display_value": "$123.00"
            },
            "6651670393424268679": {
              "value": null,
              "error_message": "Missing input value",
              "error_position": null,
              "name": "Profit",
              "display_value": null,
              "raw_display_value": null
            }
          }
        }
      },
      {
        "id": 424324947,
        "key": "text_field",
        "name": "TextField",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "string",
        "value": "Acme Corp"
      }
    ],
    "comments_count": 1,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6",
      "workflow_status_category": null
    },
    "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"
    },
    "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": [],
    "initiatives": [
      {
        "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"
          }
        ]
      }
    ],
    "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"
    },
    "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"
    }
  }
}

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status