sample text
editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] value:sample text
type: note - id: 424324947 key: text_field name: TextField updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string custom_object_links: - key: customers name: Customers record_type: CustomObjectRecord record_ids: - 640362830 comments_count: 1 workflow_status: id: '738862546' name: New position: 1 complete: false color: '#dce7c6' 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: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] initiatives: - id: '423077122' reference_num: PRJ1-S-1 name: Initiative 1 url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: '2019-01-01T00:00:00.000Z' description: id: '673273729' body: Description of initiative 1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 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' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: release: custom_object_links: customers: - '640362830' /api/v1/features/{id}: put: summary: Create a custom table record link associated with a feature description: '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](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product) - [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release) - [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature) - [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea) - [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative) - [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal) **[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**' tags: - Custom table record links parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/FeaturesPutResponse' example: 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: 25 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' project: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 description: id: '793547626' body: Body of note 1 editor_version: 1 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: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 release: id: '278327321' 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' product_id: '131414752' integration_fields: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-1 resource: http://company.aha.io/api/v1/releases/PRJ1-R-1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 master_feature: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] epic: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-2 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-2 description: id: '6776881149484139005' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 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' url: http://company.aha.io/requirements/PRJ1-1-3 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-3 description: id: '6776881149490636026' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: [] integration_fields: [] comments_count: 0 initiative: id: '423077122' reference_num: PRJ1-S-1 name: Initiative 1 url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: '2019-01-01T00:00:00.000Z' description: id: '673273729' body: Description of initiative 1 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: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 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: http://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' value: values: '123': value: 10 name: a display_value: '10.0' '456': value: Foobar name: b display_value: Foobar '789': value: null name: '789' display_value: null type: equation_sheet - id: 621325984 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 694694494 key: negative_scorecard name: Negative custom scorecard updatedAt: '2019-01-01T00:00:00Z' value: 31 type: scorecard score_facts: - id: '462102328' value: 6 name: Negative default value - id: 736691743 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' 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 type: attachment feature_links: - link_type: Depends on link_type_id: 20 created_at: '2019-01-01T00:00:00.000Z' parent_record: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' child_record: id: '622562724' reference_num: PRJ1-2 name: Another Feature created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-2 resource: http://company.aha.io/api/v1/features/PRJ1-2 product_id: '131414752' feature_only_original_estimate: null feature_only_remaining_estimate: null feature_only_work_done: null security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: feature: custom_object_links: customers: - '640362830' /api/v1/requirements/{id}: put: summary: Create a custom table record link associated with a requirement description: '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](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product) - [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release) - [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature) - [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea) - [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative) - [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal) **[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**' tags: - Custom table record links parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/RequirementsPutResponse' example: 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: '6776881149484105050' key: priority name: Priority updatedAt: '2019-01-01T00:00:00Z' value: P3 type: string - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: requirement: custom_object_links: customers: - '640362830' /api/v1/ideas/{id}: put: summary: Create a custom table record link associated with an idea description: '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](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product) - [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release) - [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature) - [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea) - [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative) - [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal) **[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**' tags: - Custom table record links parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/IdeasPutResponse' example: idea: id: '849214356' name: Idea 1 project 2 reference_num: PRJ2-I-1 score: 15 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' product_id: '131414752' votes: 0 initial_votes: 0 status_changed_at: null workflow_status: id: '3259216' name: New position: 1 complete: false color: '#dce7c6' description: id: '5445688' body: Description of idea 1 project2 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] visibility: Visible to all ideas portal users url: http://company.aha.io/ideas/ideas/PRJ2-I-1 resource: http://company.aha.io/api/v1/ideas/PRJ2-I-1 product: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 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' assigned_to_user: null endorsements_count: 1 comments_count: 0 score_facts: [] tags: [] full_tags: [] categories: [] custom_fields: - id: 549257455 key: text_field1 name: TextField1 updatedAt: '2019-01-01T00:00:00Z' value: Marrakech type: string - id: 968118615 key: text_field2 name: TextField2 updatedAt: '2019-01-01T00:00:00Z' value: Lyon type: string submitted_idea_portal_record_url: https://ideas999999.example.com:8338/ideas/PRJ2-I-1 integration_fields: [] security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: idea: custom_object_links: customers: - '640362830' /api/v1/initiatives/{id}: put: summary: Create a custom table record link associated with an initiative description: '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](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product) - [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release) - [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature) - [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea) - [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative) - [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal) **[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**' tags: - Custom table record links parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/CustomtablerecordlinksPutResponse' example: initiative: id: '423077122' name: Initiative 1 reference_num: PRJ1-S-1 status: not_started effort: 30 value: 50 presented: true color: '#bada55' start_date: null end_date: null position: 1 score: 4 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' product_id: '131414752' progress: null progress_source: progress_manual duration_source: duration_manual url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 project: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 workflow_status: id: '53968949' name: Not Started position: 1 complete: false color: '#dce7c6' description: id: '673273729' body: Description of initiative 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] attachments: [] assigned_to_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' default_assignee: false comments_count: 1 goals: - id: '602095703' name: Goal 1 url: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] score_facts: [] features: - id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' master_features: - id: '269219656' reference_num: PRJ3-E-3 name: A different project epic created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ3-E-3 resource: http://company.aha.io/api/v1/epics/PRJ3-E-3 - id: '362457003' reference_num: PRJ1-E-3 name: And a third created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-3 resource: http://company.aha.io/api/v1/epics/PRJ1-E-3 - id: '580753216' reference_num: PRJ1-E-2 name: Here's another epic created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-2 resource: http://company.aha.io/api/v1/epics/PRJ1-E-2 - id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 epic: - id: '269219656' reference_num: PRJ3-E-3 name: A different project epic created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ3-E-3 resource: http://company.aha.io/api/v1/epics/PRJ3-E-3 - id: '362457003' reference_num: PRJ1-E-3 name: And a third created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-3 resource: http://company.aha.io/api/v1/epics/PRJ1-E-3 - id: '580753216' reference_num: PRJ1-E-2 name: Here's another epic created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-2 resource: http://company.aha.io/api/v1/epics/PRJ1-E-2 - id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 releases: - id: '161456549' reference_num: PRJ1-R-2 name: Release 2 start_date: '2019-01-01' release_date: '2019-01-01' parking_lot: false created_at: '2019-01-01T00:00:00.000Z' product_id: '131414752' integration_fields: [] url: http://company.aha.io/releases/PRJ1-R-2 resource: http://company.aha.io/api/v1/releases/PRJ1-R-2 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 - id: '278327321' 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' product_id: '131414752' integration_fields: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-1 resource: http://company.aha.io/api/v1/releases/PRJ1-R-1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 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' custom_fields: - id: 973371762 key: initiative_custom_date name: Initiative custom date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 1073063442 key: initiative_priority name: Initiative priority updatedAt: '2019-01-01T00:00:00Z' value: P2 type: string custom_object_links: - key: customers name: Customers record_type: CustomObjectRecord record_ids: - 640362830 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' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: initiative: custom_object_links: customers: - '640362830' /api/v1/goals/{id}: put: summary: Create a custom table record link associated with a goal description: '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](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product) - [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release) - [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature) - [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea) - [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative) - [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal) **[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**' tags: - Custom table record links parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/CustomtablerecordlinksPutResponse' example: goal: id: '602095703' name: Goal 1 reference_num: DEMOENT-G-1 effort: 10 value: 70 color: '#bada55' position: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' product_id: '131414752' progress: null progress_source: progress_manual url: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 description: id: '166463080' body: Description of goal 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] success_metric: name: Metric 1 description: id: '546284368' body: Description of goal 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] workflow_status: id: '396368932' name: On Track position: 2 complete: false color: '#ecdd8f' project: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 initiatives: - id: '423077122' reference_num: PRJ1-S-1 name: Initiative 1 url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: '2019-01-01T00:00:00.000Z' description: id: '673273729' body: Description of initiative 1 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' comments_count: 1 features: - id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' releases: - id: '278327321' 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' product_id: '131414752' integration_fields: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-1 resource: http://company.aha.io/api/v1/releases/PRJ1-R-1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 custom_fields: [] custom_object_links: - key: customers name: Customers record_type: CustomObjectRecord record_ids: - 640362830 security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: goal: custom_object_links: customers: - '640362830' /api/v1/custom_object_records/{id}: put: summary: Link custom table records to another custom table record description: '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](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product) - [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release) - [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature) - [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea) - [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative) - [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal) **[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**' tags: - Custom table record links parameters: - name: id in: path required: true schema: type: string description: Id identifier responses: '200': description: Successful operation headers: Content-Type: description: application/json; charset=utf-8 schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/CustomtablerecordsPutResponse' example: custom_object_record: id: '640362830' product_id: '131414752' key: customers created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme parent corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acmeparent.com type: url custom_object_links: [] linked_records: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 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' security: - OAuth2: [] - ApiKeyAuth: [] - CookieAuth: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomtablerecordlinksPostRequest' example: custom_object_record: custom_object_links: custom_table_name_submitters: - 136661093 components: schemas: CustomtablerecordlinksPostRequest: type: object properties: custom_object_record: type: object properties: custom_object_links: type: object properties: custom_table_name_submitters: type: array items: type: integer example: 136661093 example: - 136661093 example: custom_table_name_submitters: - 136661093 example: custom_object_links: custom_table_name_submitters: - 136661093 example: custom_object_record: custom_object_links: custom_table_name_submitters: - 136661093 CustomtablerecordsPutResponse: type: object properties: custom_object_record: type: object properties: id: type: string example: '640362830' product_id: type: string example: '131414752' key: type: string example: customers created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme parent corp type: string example: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme parent corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acmeparent.com type: url custom_object_links: type: array items: {} linked_records: type: array items: type: object properties: key: type: string name: type: string record_type: type: string record_id: type: string example: key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 example: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 created_by_user: type: object properties: id: type: string example: '1020675218' name: type: string example: Mary Humpty email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' example: 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' example: id: '640362830' product_id: '131414752' key: customers created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme parent corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acmeparent.com type: url custom_object_links: [] linked_records: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 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' example: custom_object_record: id: '640362830' product_id: '131414752' key: customers created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme parent corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acmeparent.com type: url custom_object_links: [] linked_records: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 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' IdeasPutResponse: type: object properties: idea: type: object properties: id: type: string example: '58056975' name: type: string example: Idea 1 reference_num: type: string example: PRJ1-I-1 score: type: integer example: 15 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' product_id: type: string example: '131414752' votes: type: integer example: 1 initial_votes: type: integer example: 0 status_changed_at: type: string example: '2019-01-01T00:00:00.000Z' workflow_status: type: object properties: id: type: string example: '1009437757' name: type: string example: In progress position: type: integer example: 2 complete: type: boolean example: false color: type: string example: '#ecdd8f' example: id: '1009437757' name: In progress position: 2 complete: false color: '#ecdd8f' description: type: object properties: id: type: string example: '103757394' body: type: string example: Description of idea 1 editor_version: type: integer example: 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' attachments: type: array items: {} example: id: '103757394' body: Description of idea 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] visibility: type: string example: Visible to all ideas portal users url: type: string example: http://company.aha.io/ideas/ideas/PRJ1-I-1 resource: type: string example: http://company.aha.io/api/v1/ideas/PRJ1-I-1 product: type: object properties: id: type: string example: '131414752' reference_prefix: type: string example: PRJ1 name: type: string example: Project 1 product_line: type: boolean example: false created_at: type: string example: '2019-01-01T00:00:00.000Z' workspace_type: type: string example: product_workspace url: type: string example: http://company.aha.io/projects/PRJ1 example: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 created_by_user: type: object properties: id: type: string example: '1020675218' name: type: string example: Mary Humpty email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' example: 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' assigned_to_user: type: 'null' feature: type: object properties: id: type: string example: '6776881149492554846' reference_num: type: string example: PRJ1-251 name: type: string example: Idea 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' url: type: string example: http://company.aha.io/features/PRJ1-251 resource: type: string example: http://company.aha.io/api/v1/features/PRJ1-251 product_id: type: string example: '131414752' example: id: '6776881149492554846' reference_num: PRJ1-251 name: Idea 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-251 resource: http://company.aha.io/api/v1/features/PRJ1-251 product_id: '131414752' endorsements_count: type: integer example: 1 comments_count: type: integer example: 0 score_facts: type: array items: type: object properties: id: type: string value: type: string name: type: string example: id: '244026645' value: 10 name: Effort example: - id: '244026645' value: 10 name: Effort - id: '394452137' value: 5 name: Benefit tags: type: array items: type: string example: Infrastructure example: - Infrastructure full_tags: type: array items: type: object properties: id: type: string name: type: string color: type: string example: id: 775582684 name: Infrastructure color: '#7552e0' example: - id: 775582684 name: Infrastructure color: '#7552e0' categories: type: array items: type: object properties: id: type: string name: type: string parent_id: type: string project_id: type: string created_at: type: string example: id: '972845454' name: Hard disk drive parent_id: 552935478 project_id: 131414752 created_at: '2019-01-01T00:00:00.000Z' example: - id: '972845454' name: Hard disk drive parent_id: 552935478 project_id: 131414752 created_at: '2019-01-01T00:00:00.000Z' custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 585340588 key: component name: Component updatedAt: '2019-01-01T00:00:00Z' value: - web type: array example: - id: 585340588 key: component name: Component updatedAt: '2019-01-01T00:00:00Z' value: - web type: array - id: 267687015 key: custom_scorecard_definition name: Some custom scorecard definition updatedAt: '2019-01-01T00:00:00Z' value: 11 type: scorecard score_facts: [] - id: 193641455 key: text_field1 name: TextField1 updatedAt: '2019-01-01T00:00:00Z' value: Cairo type: string - id: 310635095 key: text_field2 name: TextField2 updatedAt: '2019-01-01T00:00:00Z' value: Rennes type: string - id: 800380718 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' attachments: [] type: attachment custom_object_links: type: array items: type: object properties: key: type: string name: type: string record_type: type: string record_ids: type: string example: key: revenue name: Revenue record_type: CustomObjectRecord record_ids: - 640362830 example: - key: revenue name: Revenue record_type: CustomObjectRecord record_ids: - 640362830 - key: submitters name: Submitters record_type: CustomObjectRecord record_ids: - 640362830 workflow_status_times: type: array items: type: object properties: status_id: type: string status_name: type: string started_at: type: string ended_at: type: 'null' example: status_id: '1009437757' status_name: In progress started_at: '2019-01-01T00:00:00.000Z' ended_at: null example: - status_id: '1009437757' status_name: In progress started_at: '2019-01-01T00:00:00.000Z' ended_at: null submitted_idea_portal_record_url: type: string example: https://ideas.example.com:8338/ideas/PRJ1-I-1 integration_fields: type: array items: {} example: id: '58056975' name: Idea 1 reference_num: PRJ1-I-1 score: 15 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' product_id: '131414752' votes: 1 initial_votes: 0 status_changed_at: '2019-01-01T00:00:00.000Z' workflow_status: id: '1009437757' name: In progress position: 2 complete: false color: '#ecdd8f' description: id: '103757394' body: Description of idea 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] visibility: Visible to all ideas portal users url: http://company.aha.io/ideas/ideas/PRJ1-I-1 resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1 product: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 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' assigned_to_user: null feature: id: '6776881149492554846' reference_num: PRJ1-251 name: Idea 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-251 resource: http://company.aha.io/api/v1/features/PRJ1-251 product_id: '131414752' endorsements_count: 1 comments_count: 0 score_facts: - id: '244026645' value: 10 name: Effort - id: '394452137' value: 5 name: Benefit tags: - Infrastructure full_tags: - id: 775582684 name: Infrastructure color: '#7552e0' categories: - id: '972845454' name: Hard disk drive parent_id: 552935478 project_id: 131414752 created_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 585340588 key: component name: Component updatedAt: '2019-01-01T00:00:00Z' value: - web type: array - id: 267687015 key: custom_scorecard_definition name: Some custom scorecard definition updatedAt: '2019-01-01T00:00:00Z' value: 11 type: scorecard score_facts: [] - id: 193641455 key: text_field1 name: TextField1 updatedAt: '2019-01-01T00:00:00Z' value: Cairo type: string - id: 310635095 key: text_field2 name: TextField2 updatedAt: '2019-01-01T00:00:00Z' value: Rennes type: string - id: 800380718 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' attachments: [] type: attachment custom_object_links: - key: revenue name: Revenue record_type: CustomObjectRecord record_ids: - 640362830 - key: submitters name: Submitters record_type: CustomObjectRecord record_ids: - 640362830 workflow_status_times: - status_id: '1009437757' status_name: In progress started_at: '2019-01-01T00:00:00.000Z' ended_at: null submitted_idea_portal_record_url: https://ideas.example.com:8338/ideas/PRJ1-I-1 integration_fields: [] example: idea: id: '58056975' name: Idea 1 reference_num: PRJ1-I-1 score: 15 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' product_id: '131414752' votes: 1 initial_votes: 0 status_changed_at: '2019-01-01T00:00:00.000Z' workflow_status: id: '1009437757' name: In progress position: 2 complete: false color: '#ecdd8f' description: id: '103757394' body: Description of idea 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] visibility: Visible to all ideas portal users url: http://company.aha.io/ideas/ideas/PRJ1-I-1 resource: http://company.aha.io/api/v1/ideas/PRJ1-I-1 product: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 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' assigned_to_user: null feature: id: '6776881149492554846' reference_num: PRJ1-251 name: Idea 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-251 resource: http://company.aha.io/api/v1/features/PRJ1-251 product_id: '131414752' endorsements_count: 1 comments_count: 0 score_facts: - id: '244026645' value: 10 name: Effort - id: '394452137' value: 5 name: Benefit tags: - Infrastructure full_tags: - id: 775582684 name: Infrastructure color: '#7552e0' categories: - id: '972845454' name: Hard disk drive parent_id: 552935478 project_id: 131414752 created_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 585340588 key: component name: Component updatedAt: '2019-01-01T00:00:00Z' value: - web type: array - id: 267687015 key: custom_scorecard_definition name: Some custom scorecard definition updatedAt: '2019-01-01T00:00:00Z' value: 11 type: scorecard score_facts: [] - id: 193641455 key: text_field1 name: TextField1 updatedAt: '2019-01-01T00:00:00Z' value: Cairo type: string - id: 310635095 key: text_field2 name: TextField2 updatedAt: '2019-01-01T00:00:00Z' value: Rennes type: string - id: 800380718 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' attachments: [] type: attachment custom_object_links: - key: revenue name: Revenue record_type: CustomObjectRecord record_ids: - 640362830 - key: submitters name: Submitters record_type: CustomObjectRecord record_ids: - 640362830 workflow_status_times: - status_id: '1009437757' status_name: In progress started_at: '2019-01-01T00:00:00.000Z' ended_at: null submitted_idea_portal_record_url: https://ideas.example.com:8338/ideas/PRJ1-I-1 integration_fields: [] ProductsPutResponse: type: object properties: product: type: object properties: id: type: string example: '131414752' reference_prefix: type: string example: PRJ1 name: type: string example: Two Products product_line: type: boolean example: false product_line_type: type: 'null' created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' description: type: object properties: id: type: string example: '21164619' body: type: string example: '' editor_version: type: integer example: 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' attachments: type: array items: {} example: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: type: string example: http://company.aha.io/projects/PRJ1 resource: type: string example: http://company.aha.io/projects/PRJ1 children: type: array items: {} custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet example: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: type: object properties: Approval: type: integer example: 475481209 Competitor: type: integer example: 826556567 Epic: type: integer example: 908690576 Feature: type: integer example: 19837977 Ideas::Idea: type: integer example: 405267877 Ideas::IdeaPortal: type: integer example: 790680888 Initiative: type: integer example: 838774462 Page: type: integer example: 26499634 Project: type: integer example: 524951996 Release: type: integer example: 647403809 Requirement: type: integer example: 687341318 StrategicImperative: type: integer example: 117022249 example: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: type: array items: type: object properties: id: type: string screenable_type: type: string name: type: string custom_field_definitions: type: string example: id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false example: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: type: boolean example: true has_master_features: type: boolean example: false has_epics: type: boolean example: false release_workflow: type: object properties: id: type: integer example: 717623509 name: type: string example: Account product release workflow statusable_type: type: string example: Release workflow_type: type: string example: release example: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: type: object properties: id: type: integer example: 499195972 name: type: string example: Account product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: requirement example: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: type: object properties: id: type: integer example: 499195972 name: type: string example: Account product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: feature example: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: type: object properties: id: type: integer example: 61191651 name: type: string example: Account initiative workflow statusable_type: type: string example: Initiative workflow_type: type: string example: initiative example: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: type: object properties: id: type: integer example: 499195972 name: type: string example: Account product feature workflow statusable_type: type: string example: Feature workflow_type: type: string example: epic example: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: type: object properties: id: type: integer example: 80245244 name: type: string example: Account product idea workflow statusable_type: type: string example: Idea workflow_type: type: string example: idea example: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: type: object properties: id: type: integer example: 883066232 name: type: string example: Account goal workflow statusable_type: type: string example: StrategicImperative workflow_type: type: string example: strategic_imperative example: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: type: object properties: id: type: integer example: 934299270 name: type: string example: Account document workflow statusable_type: type: string example: Page workflow_type: type: string example: page example: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: type: object properties: id: type: integer example: 1024772447 name: type: string example: Account product key result workflow statusable_type: type: string example: KeyResult workflow_type: type: string example: key_result example: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: type: boolean example: false default_capacity_units: type: integer example: 10 enhanced_capacity_planning_enabled: type: boolean example: false workspace_type: type: string example: product_workspace example: id: '131414752' reference_prefix: PRJ1 name: Two Products product_line: false product_line_type: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/PRJ1 resource: http://company.aha.io/projects/PRJ1 children: [] custom_fields: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: true has_master_features: false has_epics: false release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace example: product: id: '131414752' reference_prefix: PRJ1 name: Two Products product_line: false product_line_type: null created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' description: id: '21164619' body: '' editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] url: http://company.aha.io/projects/PRJ1 resource: http://company.aha.io/projects/PRJ1 children: [] custom_fields: - id: 33687638 key: release_count name: Release count updatedAt: '2019-01-01T00:00:00Z' value: values: '6809377296730243716': value: 6.0 name: Release count display_value: '6.0' type: equation_sheet screen_definition_ids: Approval: 475481209 Competitor: 826556567 Epic: 908690576 Feature: 19837977 Ideas::Idea: 405267877 Ideas::IdeaPortal: 790680888 Initiative: 838774462 Page: 26499634 Project: 524951996 Release: 647403809 Requirement: 687341318 StrategicImperative: 117022249 screen_definitions: - id: 19837977 screenable_type: Feature name: Screen Definition 6 custom_field_definitions: - id: 839883647 key: custom_scorecard_definition position: 3 name: Some custom scorecard definition type: CustomFieldDefinitions::ScorecardField api_type: scorecard required: false - id: 182007396 key: custom_table position: 7 name: Custom Table type: CustomFieldDefinitions::LinkMasterDetail api_type: array required: false - id: 20549131 key: customer position: 2 name: Customer type: CustomFieldDefinitions::SelectEditable api_type: string configuration_display: null required: false options: - id: 106870231 label: cust1 - id: 525853807 label: cust2 - id: 676386040 label: cust3 - id: 141558949 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 384804762 key: product_managers position: 7 name: Product Managers type: CustomFieldDefinitions::Records::UsersField api_type: array required: false - id: 26499634 screenable_type: Page name: Screen Definition 7 custom_field_definitions: - id: 529933329 key: review_date position: 1 name: Review date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 117022249 screenable_type: StrategicImperative name: Screen Definition 13 custom_field_definitions: [] - id: 405267877 screenable_type: Ideas::Idea name: Screen Definition 5 custom_field_definitions: - id: 711072024 key: customers_table position: 1 name: Customers for custom table type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 475481209 screenable_type: Task name: Approvals custom layout custom_field_definitions: [] - id: 524951996 screenable_type: Project name: Screen Definition 1 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 221120583 key: website position: 2 name: Website type: CustomFieldDefinitions::UrlField api_type: url required: false - id: 647403809 screenable_type: Release name: Screen Definition 8 custom_field_definitions: - id: 3228193 key: release_custom_date position: 1 name: Release custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 687341318 screenable_type: Requirement name: Screen Definition 11 custom_field_definitions: - id: 85990596 key: priority position: 3 name: Priority type: CustomFieldDefinitions::SelectConstant api_type: string configuration_display: null required: false options: - id: 135354995 label: P4 - id: 376819668 label: P3 - id: 561184585 label: P2 - id: 947629821 label: P1 - id: 1058433764 label: P5 - id: 867049992 key: requested_by position: 2 name: Requested By type: CustomFieldDefinitions::TextField api_type: string required: false - id: 790680888 screenable_type: Ideas::IdeaPortal name: Screen Definition 4 custom_field_definitions: - id: 807801664 key: name position: 1 name: Name type: CustomFieldDefinitions::TextField api_type: string required: false - id: 826556567 screenable_type: Competitor name: Screen Definition 3 custom_field_definitions: [] - id: 838774462 screenable_type: Initiative name: Screen Definition 12 custom_field_definitions: - id: 250383571 key: customers position: 1 name: Customers type: CustomFieldDefinitions::LinkMany api_type: array required: false - id: 688549069 key: initiative_custom_date position: 3 name: Initiative custom date type: CustomFieldDefinitions::DateField api_type: date required: false - id: 908690576 screenable_type: Epic name: Screen Definition 7 custom_field_definitions: - id: 919440521 key: epic_custom_date position: 1 name: Epic custom date type: CustomFieldDefinitions::DateField api_type: date required: false has_ideas: true has_master_features: false has_epics: false release_workflow: id: 717623509 name: Account product release workflow statusable_type: Release workflow_type: release requirement_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: requirement feature_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: feature initiative_workflow: id: 61191651 name: Account initiative workflow statusable_type: Initiative workflow_type: initiative epic_workflow: id: 499195972 name: Account product feature workflow statusable_type: Feature workflow_type: epic idea_workflow: id: 80245244 name: Account product idea workflow statusable_type: Idea workflow_type: idea strategic_imperative_workflow: id: 883066232 name: Account goal workflow statusable_type: StrategicImperative workflow_type: strategic_imperative page_workflow: id: 934299270 name: Account document workflow statusable_type: Page workflow_type: page key_result_workflow: id: 1024772447 name: Account product key result workflow statusable_type: KeyResult workflow_type: key_result capacity_planning_enabled: false default_capacity_units: 10 enhanced_capacity_planning_enabled: false workspace_type: product_workspace FeaturesPutResponse: type: object properties: feature: type: object properties: id: type: string example: '1007868956' name: type: string example: Feature 1 reference_num: type: string example: PRJ1-1 initiative_reference_num: type: string example: PRJ1-S-1 release_reference_num: type: string example: PRJ1-R-1 epic_reference_num: type: string example: PRJ1-E-1 position: type: integer example: 1 score: type: integer example: 3 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' start_date: type: string example: '2019-01-01' due_date: type: string example: '2019-01-01' product_id: type: string example: '131414752' progress: type: integer example: 25 progress_source: type: string example: progress_manual status_changed_on: type: 'null' created_by_user: type: object properties: id: type: string example: '16338845' name: type: string example: John Smith email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' example: 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: type: object properties: id: type: string example: '98484309' name: type: string example: New example: id: '98484309' name: New workflow_status: type: object properties: id: type: string example: '934242751' name: type: string example: New position: type: integer example: 1 complete: type: boolean example: false color: type: string example: '#dce7c6' example: id: '934242751' name: New position: 1 complete: false color: '#dce7c6' project: type: object properties: id: type: string example: '131414752' reference_prefix: type: string example: PRJ1 name: type: string example: Project 1 product_line: type: boolean example: false created_at: type: string example: '2019-01-01T00:00:00.000Z' workspace_type: type: string example: product_workspace url: type: string example: http://company.aha.io/projects/PRJ1 example: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 description: type: object properties: id: type: string example: '793547626' body: type: string example: Body of note 1 editor_version: type: integer example: 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' attachments: type: array items: type: string example: - 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 example: id: '793547626' body: Body of note 1 editor_version: 1 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: type: array items: {} integration_fields: type: array items: type: object properties: id: type: string name: type: string value: type: string integration_id: type: string service_name: type: string created_at: type: string example: 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' example: - 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: type: string example: http://company.aha.io/features/PRJ1-1 resource: type: string example: http://company.aha.io/api/v1/features/PRJ1-1 release: type: object properties: id: type: string example: '278327321' reference_num: type: string example: PRJ1-R-1 name: type: string example: Release 1 start_date: type: string example: '2019-01-01' release_date: type: string example: '2019-01-01' parking_lot: type: boolean example: false created_at: type: string example: '2019-01-01T00:00:00.000Z' product_id: type: string example: '131414752' integration_fields: type: array items: type: string example: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: type: string example: http://company.aha.io/releases/PRJ1-R-1 resource: type: string example: http://company.aha.io/api/v1/releases/PRJ1-R-1 owner: type: object properties: id: type: string name: type: string email: type: string created_at: type: string updated_at: type: string example: 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: type: object properties: id: type: string reference_prefix: type: string name: type: string product_line: type: string created_at: type: string workspace_type: type: string url: type: string example: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 example: id: '278327321' 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' product_id: '131414752' integration_fields: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-1 resource: http://company.aha.io/api/v1/releases/PRJ1-R-1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 master_feature: type: object properties: id: type: string example: '999605892' reference_num: type: string example: PRJ1-E-1 name: type: string example: Epic 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' url: type: string example: http://company.aha.io/epics/PRJ1-E-1 resource: type: string example: http://company.aha.io/api/v1/epics/PRJ1-E-1 example: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 belongs_to_release_phase: type: object properties: id: type: string example: '20526005' name: type: string example: Alpha start_on: type: string example: '2019-01-01' end_on: type: string example: '2019-01-01' type: type: string example: phase release_id: type: integer example: 278327321 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' progress: type: 'null' progress_source: type: string example: progress_manual duration_source: type: string example: duration_manual description: type: object properties: id: type: string body: type: string editor_version: type: string created_at: type: string updated_at: type: string attachments: type: string example: id: '243384959' body: Description of release phase 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] example: 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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] epic: type: object properties: id: type: string example: '999605892' reference_num: type: string example: PRJ1-E-1 name: type: string example: Epic 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' url: type: string example: http://company.aha.io/epics/PRJ1-E-1 resource: type: string example: http://company.aha.io/api/v1/epics/PRJ1-E-1 example: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 assigned_to_user: type: object properties: id: type: string example: '16338845' name: type: string example: John Smith email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' default_assignee: type: boolean example: false example: 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' default_assignee: false requirements: type: array items: type: object properties: id: type: string name: type: string reference_num: type: string position: type: string created_at: type: string updated_at: type: string release_id: type: string created_by_user: type: string workflow_status: type: string url: type: string resource: type: string description: type: string feature: type: string assigned_to_user: type: string attachments: type: string tags: type: string full_tags: type: string custom_fields: type: string integration_fields: type: string comments_count: type: string example: 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 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' url: http://company.aha.io/requirements/PRJ1-1-2 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-2 description: id: '6776881149484139005' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: [] integration_fields: [] comments_count: 0 example: - 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 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' url: http://company.aha.io/requirements/PRJ1-1-2 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-2 description: id: '6776881149484139005' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 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' url: http://company.aha.io/requirements/PRJ1-1-3 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-3 description: id: '6776881149490636026' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: [] integration_fields: [] comments_count: 0 initiative: type: object properties: id: type: string example: '423077122' reference_num: type: string example: PRJ1-S-1 name: type: string example: Initiative 1 url: type: string example: http://company.aha.io/initiatives/PRJ1-S-1 resource: type: string example: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: type: string example: '2019-01-01T00:00:00.000Z' description: type: object properties: id: type: string body: type: string editor_version: type: string created_at: type: string updated_at: type: string attachments: type: string example: id: '673273729' body: Description of initiative 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] integration_fields: type: array items: type: string example: - 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' example: id: '423077122' reference_num: PRJ1-S-1 name: Initiative 1 url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: '2019-01-01T00:00:00.000Z' description: id: '673273729' body: Description of initiative 1 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: type: array items: type: object properties: id: type: string name: type: string url: type: string resource: type: string created_at: type: string description: type: string example: id: '602095703' name: Goal 1 url: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] example: - id: '602095703' name: Goal 1 url: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] key_results: type: array items: type: object properties: id: type: string name: type: string reference_num: type: string url: type: string position: type: string created_at: type: string updated_at: type: string progress: type: 'null' target_metric: type: string starting_metric: type: string current_metric: type: string example: id: '631791848' name: KR 1 reference_num: DEMOENT-G-1-KR-1 url: http://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% example: - id: '631791848' name: KR 1 reference_num: DEMOENT-G-1-KR-1 url: http://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: type: integer example: 1 score_facts: type: array items: type: object properties: id: type: string value: type: string name: type: string example: id: '728895917' value: 1 name: Effort example: - id: '728895917' value: 1 name: Effort - id: '846938137' value: 2 name: Benefit tags: type: array items: type: string example: Engineering example: - Engineering - Infrastructure full_tags: type: array items: type: object properties: id: type: string name: type: string color: type: string example: id: 3412727 name: Engineering color: '#e09052' example: - id: 3412727 name: Engineering color: '#e09052' - id: 775582684 name: Infrastructure color: '#7552e0' custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 1051489895 key: equation_specs_field name: Equation specs field updatedAt: '2019-01-01T00:00:00Z' value: values: '123': value: 10 name: a display_value: '10.0' '456': value: Foobar name: b display_value: Foobar '789': value: null name: '789' display_value: null type: equation_sheet example: - id: 1051489895 key: equation_specs_field name: Equation specs field updatedAt: '2019-01-01T00:00:00Z' value: values: '123': value: 10 name: a display_value: '10.0' '456': value: Foobar name: b display_value: Foobar '789': value: null name: '789' display_value: null type: equation_sheet - id: 621325984 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 694694494 key: negative_scorecard name: Negative custom scorecard updatedAt: '2019-01-01T00:00:00Z' value: 31 type: scorecard score_facts: - id: '462102328' value: 6 name: Negative default value - id: 736691743 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' 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 type: attachment feature_links: type: array items: type: object properties: link_type: type: string link_type_id: type: string created_at: type: string parent_record: type: string child_record: type: string example: link_type: Depends on link_type_id: 20 created_at: '2019-01-01T00:00:00.000Z' parent_record: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' child_record: id: '622562724' reference_num: PRJ1-2 name: Another Feature created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-2 resource: http://company.aha.io/api/v1/features/PRJ1-2 product_id: '131414752' example: - link_type: Depends on link_type_id: 20 created_at: '2019-01-01T00:00:00.000Z' parent_record: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' child_record: id: '622562724' reference_num: PRJ1-2 name: Another Feature created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-2 resource: http://company.aha.io/api/v1/features/PRJ1-2 product_id: '131414752' feature_only_original_estimate: type: 'null' feature_only_remaining_estimate: type: 'null' feature_only_work_done: type: 'null' example: 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: 25 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' project: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 description: id: '793547626' body: Body of note 1 editor_version: 1 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: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 release: id: '278327321' 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' product_id: '131414752' integration_fields: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-1 resource: http://company.aha.io/api/v1/releases/PRJ1-R-1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 master_feature: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] epic: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-2 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-2 description: id: '6776881149484139005' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 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' url: http://company.aha.io/requirements/PRJ1-1-3 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-3 description: id: '6776881149490636026' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: [] integration_fields: [] comments_count: 0 initiative: id: '423077122' reference_num: PRJ1-S-1 name: Initiative 1 url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: '2019-01-01T00:00:00.000Z' description: id: '673273729' body: Description of initiative 1 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: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 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: http://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' value: values: '123': value: 10 name: a display_value: '10.0' '456': value: Foobar name: b display_value: Foobar '789': value: null name: '789' display_value: null type: equation_sheet - id: 621325984 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 694694494 key: negative_scorecard name: Negative custom scorecard updatedAt: '2019-01-01T00:00:00Z' value: 31 type: scorecard score_facts: - id: '462102328' value: 6 name: Negative default value - id: 736691743 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' 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 type: attachment feature_links: - link_type: Depends on link_type_id: 20 created_at: '2019-01-01T00:00:00.000Z' parent_record: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' child_record: id: '622562724' reference_num: PRJ1-2 name: Another Feature created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-2 resource: http://company.aha.io/api/v1/features/PRJ1-2 product_id: '131414752' feature_only_original_estimate: null feature_only_remaining_estimate: null feature_only_work_done: null example: 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: 25 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' project: id: '131414752' reference_prefix: PRJ1 name: Project 1 product_line: false created_at: '2019-01-01T00:00:00.000Z' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 description: id: '793547626' body: Body of note 1 editor_version: 1 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: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 release: id: '278327321' 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' product_id: '131414752' integration_fields: - id: '68217473' name: id value: '777' integration_id: 204584239 service_name: jira created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/releases/PRJ1-R-1 resource: http://company.aha.io/api/v1/releases/PRJ1-R-1 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' workspace_type: product_workspace url: http://company.aha.io/projects/PRJ1 master_feature: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://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 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] epic: id: '999605892' reference_num: PRJ1-E-1 name: Epic 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/epics/PRJ1-E-1 resource: http://company.aha.io/api/v1/epics/PRJ1-E-1 assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-2 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-2 description: id: '6776881149484139005' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 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' url: http://company.aha.io/requirements/PRJ1-1-3 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-3 description: id: '6776881149490636026' body: '' editor_version: 2 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: [] integration_fields: [] comments_count: 0 initiative: id: '423077122' reference_num: PRJ1-S-1 name: Initiative 1 url: http://company.aha.io/initiatives/PRJ1-S-1 resource: http://company.aha.io/api/v1/initiatives/PRJ1-S-1 created_at: '2019-01-01T00:00:00.000Z' description: id: '673273729' body: Description of initiative 1 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: http://company.aha.io/strategic_imperatives/DEMOENT-G-1 resource: http://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 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: http://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' value: values: '123': value: 10 name: a display_value: '10.0' '456': value: Foobar name: b display_value: Foobar '789': value: null name: '789' display_value: null type: equation_sheet - id: 621325984 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: 694694494 key: negative_scorecard name: Negative custom scorecard updatedAt: '2019-01-01T00:00:00Z' value: 31 type: scorecard score_facts: - id: '462102328' value: 6 name: Negative default value - id: 736691743 key: upload name: Upload updatedAt: '2019-01-01T00:00:00Z' 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 type: attachment feature_links: - link_type: Depends on link_type_id: 20 created_at: '2019-01-01T00:00:00.000Z' parent_record: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' child_record: id: '622562724' reference_num: PRJ1-2 name: Another Feature created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-2 resource: http://company.aha.io/api/v1/features/PRJ1-2 product_id: '131414752' feature_only_original_estimate: null feature_only_remaining_estimate: null feature_only_work_done: null CustomtablerecordlinksPutResponse: type: object properties: custom_object_record: type: object properties: id: type: string example: '640362830' product_id: type: string example: '131414752' key: type: string example: customers created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string example: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acme.com type: url custom_object_links: type: array items: type: object properties: key: type: string name: type: string record_type: type: string record_ids: type: string example: key: custom_table_name_link_many name: Custom Table Linked Records record_type: CustomObjectRecord record_ids: - 1059223798 example: - key: custom_table_name_link_many name: Custom Table Linked Records record_type: CustomObjectRecord record_ids: - 1059223798 - key: custom_table_name_link_many_to_one name: Custom Table Many to One Field record_type: CustomObjectRecord record_ids: [] - key: custom_table_name_submitters name: Custom Table Linked Submitters record_type: CustomObjectRecord record_ids: - 136661093 linked_records: type: array items: type: object properties: key: type: string name: type: string record_type: type: string record_id: type: string example: key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 example: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 created_by_user: type: object properties: id: type: string example: '1020675218' name: type: string example: Mary Humpty email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' example: 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' example: id: '640362830' product_id: '131414752' key: customers created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acme.com type: url custom_object_links: - key: custom_table_name_link_many name: Custom Table Linked Records record_type: CustomObjectRecord record_ids: - 1059223798 - key: custom_table_name_link_many_to_one name: Custom Table Many to One Field record_type: CustomObjectRecord record_ids: [] - key: custom_table_name_submitters name: Custom Table Linked Submitters record_type: CustomObjectRecord record_ids: - 136661093 linked_records: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 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' example: custom_object_record: id: '640362830' product_id: '131414752' key: customers created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' custom_fields: - id: 262515157 key: name name: Name updatedAt: '2019-01-01T00:00:00Z' value: Acme Corp type: string - id: 883926222 key: website name: Website updatedAt: '2019-01-01T00:00:00Z' value: www.acme.com type: url custom_object_links: - key: custom_table_name_link_many name: Custom Table Linked Records record_type: CustomObjectRecord record_ids: - 1059223798 - key: custom_table_name_link_many_to_one name: Custom Table Many to One Field record_type: CustomObjectRecord record_ids: [] - key: custom_table_name_submitters name: Custom Table Linked Submitters record_type: CustomObjectRecord record_ids: - 136661093 linked_records: - key: customers name: Customers record_type: Ideas::Idea record_id: 162120796 - key: revenue name: Revenue record_type: Ideas::Idea record_id: 58056975 - key: submitters name: Submitters record_type: Ideas::Idea record_id: 58056975 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' RequirementsPutResponse: type: object properties: requirement: type: object properties: id: type: string example: '483368544' name: type: string example: Body of requirement 1 reference_num: type: string example: PRJ1-1-1 position: type: integer example: 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' release_id: type: integer example: 278327321 created_by_user: type: object properties: id: type: string example: '1020675218' name: type: string example: Mary Humpty email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' example: 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: type: object properties: id: type: string example: '934242751' name: type: string example: New position: type: integer example: 1 complete: type: boolean example: false color: type: string example: '#dce7c6' example: id: '934242751' name: New position: 1 complete: false color: '#dce7c6' url: type: string example: http://company.aha.io/requirements/PRJ1-1-1 resource: type: string example: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: type: object properties: id: type: string example: '910541534' body: type: string example: Body of requirement 1 editor_version: type: integer example: 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' attachments: type: array items: {} example: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: type: object properties: id: type: string example: '1007868956' reference_num: type: string example: PRJ1-1 name: type: string example: Feature 1 created_at: type: string example: '2019-01-01T00:00:00.000Z' url: type: string example: http://company.aha.io/features/PRJ1-1 resource: type: string example: http://company.aha.io/api/v1/features/PRJ1-1 product_id: type: string example: '131414752' example: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_user: type: object properties: id: type: string example: '16338845' name: type: string example: John Smith email: type: string example: no-reply@aha.io created_at: type: string example: '2019-01-01T00:00:00.000Z' updated_at: type: string example: '2019-01-01T00:00:00.000Z' default_assignee: type: boolean example: false example: 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' default_assignee: false attachments: type: array items: {} tags: type: array items: {} full_tags: type: array items: {} custom_fields: type: array items: type: object properties: id: type: string key: type: string name: type: string updatedAt: type: string value: type: string type: type: string example: id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date example: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: '6776881149484105050' key: priority name: Priority updatedAt: '2019-01-01T00:00:00Z' value: P3 type: string - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string integration_fields: type: array items: type: object properties: id: type: string name: type: string value: type: string integration_id: type: string service_name: type: string created_at: type: string example: id: '32487847' name: key value: JRA-987 integration_id: 342659513 service_name: jira created_at: '2019-01-01T00:00:00.000Z' example: - 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: type: integer example: 1 example: 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: '6776881149484105050' key: priority name: Priority updatedAt: '2019-01-01T00:00:00Z' value: P3 type: string - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 example: 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 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' url: http://company.aha.io/requirements/PRJ1-1-1 resource: http://company.aha.io/api/v1/requirements/PRJ1-1-1 description: id: '910541534' body: Body of requirement 1 editor_version: 1 created_at: '2019-01-01T00:00:00.000Z' updated_at: '2019-01-01T00:00:00.000Z' attachments: [] feature: id: '1007868956' reference_num: PRJ1-1 name: Feature 1 created_at: '2019-01-01T00:00:00.000Z' url: http://company.aha.io/features/PRJ1-1 resource: http://company.aha.io/api/v1/features/PRJ1-1 product_id: '131414752' assigned_to_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' default_assignee: false attachments: [] tags: [] full_tags: [] custom_fields: - id: 848810602 key: expected_completion_date name: Expected completion date updatedAt: '2019-01-01T00:00:00Z' value: '2019-01-01' type: date - id: '6776881149484105050' key: priority name: Priority updatedAt: '2019-01-01T00:00:00Z' value: P3 type: string - id: 731808726 key: requested_by name: Requested By updatedAt: '2019-01-01T00:00:00Z' value: TK type: string 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 securitySchemes: OAuth2: type: oauth2 description: OAuth2 authentication with bearer tokens flows: authorizationCode: authorizationUrl: https://{account-domain}.aha.io/oauth/authorize tokenUrl: https://{account-domain}.aha.io/oauth/token scopes: {} ApiKeyAuth: type: http scheme: bearer description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys CookieAuth: type: apiKey in: cookie name: session description: Cookie-based authentication for web browser integration