Custom table record links
Create a custom table record link associated with a feature
Resources that can be linked to records from a custom table (called custom objects in the API) can be manipulated in a bulk ID-list format. To use custom table record links you must first add a many-to-many custom field definition to the resource. When you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.
Examples of linking custom objects to resources with a many-to-many customer field:
- Products
- Releases
- Features
- Ideas
- Initiatives
- Goals
- Organizations
Custom tables are an Enterprise+ exclusive feature.
put/features/{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
{
"requirement": {
"custom_object_links": {
"customers": [
"640362830"
]
}
}
}Response
Successful operation
Example response
{
"feature": {
"id": "1007868956",
"name": "Feature 1",
"reference_num": "PRJ1-1",
"initiative_reference_num": "PRJ1-S-1",
"release_reference_num": "PRJ1-R-1",
"epic_reference_num": "PRJ1-E-1",
"position": 1,
"score": 3,
"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",
"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_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": "793547626",
"body": "Body of note 1",
"notable_id": "1007868956",
"notable_type": "Feature",
"editor_version": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": [
{
"id": "630489833",
"download_url": "https://company.aha.io/attachments/630489833/token/aaabbbccc7.download?size=original",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"original_file_size": 123,
"content_type": "application/excel",
"file_name": "spreadsheet_file.xlsx",
"file_size": 123
},
{
"id": "724655692",
"download_url": "https://company.aha.io/attachments/724655692/token/aaabbbccc7.download?size=original",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"original_file_size": 123,
"content_type": "text/plain",
"file_name": "uploaded_file_name.txt",
"file_size": 123
}
]
},
"attachments": [],
"integration_fields": [
{
"id": "92040219",
"name": "url",
"value": "https://bigaha.atlassian.net/issues/JRA-123",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "728894778",
"name": "key",
"value": "JRA-123",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "846945422",
"name": "id",
"value": "435",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"url": "https://company.aha.io/features/PRJ1-1",
"resource": "https://company.aha.io/api/v1/features/PRJ1-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"
}
},
"master_feature": {
"id": "999605892",
"name": "Epic 1",
"reference_num": "PRJ1-E-1",
"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"
},
"epic": {
"id": "999605892",
"name": "Epic 1",
"reference_num": "PRJ1-E-1",
"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"
},
"belongs_to_release_phase": {
"id": "20526005",
"name": "Alpha",
"start_on": "2019-01-01",
"end_on": "2019-01-01",
"type": "phase",
"release_id": 278327321,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"progress": null,
"progress_source": "progress_manual",
"duration_source": "duration_manual",
"description": {
"id": "243384959",
"body": "Description of release phase 1",
"notable_id": "20526005",
"notable_type": "ReleasePhase",
"editor_version": 1,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"integration_fields": [],
"custom_fields": []
},
"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": [
{
"id": "96915428",
"name": "Body of requirement 2",
"reference_num": "PRJ1-1-2",
"position": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"release_id": 278327321,
"start_date": null,
"end_date": null,
"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": "1025247908",
"name": "Shipped",
"position": 5,
"complete": true,
"color": "#ecdd8f",
"workflow_status_category": {
"id": "51383845",
"name": "Shipped"
}
},
"url": "https://company.aha.io/requirements/PRJ1-1-2",
"resource": "https://company.aha.io/api/v1/requirements/PRJ1-1-2",
"description": null,
"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": [],
"integration_fields": [],
"comments_count": 0
},
{
"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": null,
"end_date": null,
"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
},
{
"id": "851574643",
"name": "Body of requirement 3",
"reference_num": "PRJ1-1-3",
"position": 3,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"release_id": 278327321,
"start_date": null,
"end_date": null,
"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": "922838743",
"name": "Not started",
"position": 8,
"complete": false,
"color": "#dce790",
"workflow_status_category": {
"id": "573605243",
"name": "Not started"
}
},
"url": "https://company.aha.io/requirements/PRJ1-1-3",
"resource": "https://company.aha.io/api/v1/requirements/PRJ1-1-3",
"description": null,
"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": [],
"integration_fields": [],
"comments_count": 0
}
],
"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": [
{
"id": "631791848",
"name": "KR 1",
"reference_num": "DEMOENT-G-1-KR-1",
"url": "https://company.aha.io/key_results/DEMOENT-G-1-KR-1",
"position": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"progress": null,
"target_metric": "100%",
"starting_metric": "5%",
"current_metric": "20%"
}
],
"comments_count": 1,
"score_facts": [
{
"id": "728895917",
"value": 1,
"name": "Effort"
},
{
"id": "846938137",
"value": 2,
"name": "Benefit"
}
],
"tags": [
"Engineering",
"Infrastructure"
],
"full_tags": [
{
"id": 3412727,
"name": "Engineering",
"color": "#e09052"
},
{
"id": 775582684,
"name": "Infrastructure",
"color": "#7552e0"
}
],
"custom_fields": [
{
"id": 1051489895,
"key": "equation_specs_field",
"name": "Equation specs field",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "equation_sheet",
"value": {
"values": {
"123": {
"value": 10,
"name": "a",
"display_value": "10.0",
"raw_display_value": "10.0"
},
"456": {
"value": "Foobar",
"name": "b",
"display_value": "Foobar",
"raw_display_value": "Foobar"
},
"789": {
"value": null,
"name": "789",
"display_value": null,
"raw_display_value": null
}
}
}
},
{
"id": 621325984,
"key": "expected_completion_date",
"name": "Expected completion date",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "date",
"value": "2019-01-01"
},
{
"id": 694694494,
"key": "negative_scorecard",
"name": "Negative custom scorecard",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "scorecard",
"value": 31,
"score_facts": [
{
"id": "462102328",
"value": 6,
"name": "Negative default value"
}
]
},
{
"id": 736691743,
"key": "upload",
"name": "Upload",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "attachment",
"attachments": [
{
"id": "471688235",
"download_url": "https://company.aha.io/attachments/471688235/token/aaabbbccc7.download?size=original",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"original_file_size": 123,
"content_type": "text/plain",
"file_name": "uploaded_file_name.txt",
"file_size": 123
}
]
}
],
"feature_links": [
{
"link_type": "Depends on",
"link_type_id": 20,
"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": "622562724",
"name": "Another Feature",
"reference_num": "PRJ1-2",
"created_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"url": "https://company.aha.io/features/PRJ1-2",
"resource": "https://company.aha.io/api/v1/features/PRJ1-2"
}
}
],
"feature_only_original_estimate": null,
"feature_only_remaining_estimate": null,
"feature_only_work_done": null
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.