{ "openapi": "3.1.0", "info": { "title": "Aha! API", "version": "1.0.0", "description": "Complete API documentation for Aha! generated from actual test responses", "contact": { "name": "Aha! Support", "url": "https://www.aha.io/support" } }, "servers": [ { "url": "https://{account-domain}.aha.io/api/v1", "description": "Aha! API Server", "variables": { "account-domain": { "description": "Your Aha! account domain", "default": "company" } } } ], "components": { "schemas": { "AccountbackupsGetResponse": { "type": "object", "properties": { "account_backup": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149499462668" }, "status_code": { "type": "integer", "example": 3 }, "status_description": { "type": "string", "example": "Error" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "6776881149499462668", "status_code": 3, "status_description": "Error", "created_at": "2019-01-01T00:00:00.000Z" } } }, "example": { "account_backup": { "id": "6776881149499462668", "status_code": 3, "status_description": "Error", "created_at": "2019-01-01T00:00:00.000Z" } } }, "AccountbackupsPostResponse": { "type": "object", "properties": { "account_backup": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149498172525" }, "status_code": { "type": "integer", "example": 0 }, "status_description": { "type": "string", "example": "In Queue" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "6776881149498172525", "status_code": 0, "status_description": "In Queue", "created_at": "2019-01-01T00:00:00.000Z" } } }, "example": { "account_backup": { "id": "6776881149498172525", "status_code": 0, "status_description": "In Queue", "created_at": "2019-01-01T00:00:00.000Z" } } }, "AttachmentsPostResponse": { "type": "object", "properties": { "attachment": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149488245716" }, "download_url": { "type": "string", "example": "https://company.aha.io/attachments/6776881149488245716/token/5e0c5180003396dd.download?size=original" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "original_file_size": { "type": "integer", "example": 0 }, "content_type": { "type": "string", "example": "text/html" }, "file_name": { "type": "string", "example": "home_page.html" }, "file_size": { "type": "integer", "example": 0 } }, "example": { "id": "6776881149488245716", "download_url": "https://company.aha.io/attachments/6776881149488245716/token/5e0c5180003396dd.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } }, "example": { "attachment": { "id": "6776881149488245716", "download_url": "https://company.aha.io/attachments/6776881149488245716/token/5e0c5180003396dd.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } }, "AttachmentsPost412Response": { "type": "object", "properties": { "status": { "type": "string", "example": "duplicate" }, "success": { "type": "boolean", "example": false }, "attachmentId": { "type": "string", "example": "6776881149490765072" }, "attachmentUrl": { "type": "string", "example": "https://company.aha.io/attachments/6776881149490765072/token/5e0c518000ac2936?size=original" } }, "example": { "status": "duplicate", "success": false, "attachmentId": "6776881149490765072", "attachmentUrl": "https://company.aha.io/attachments/6776881149490765072/token/5e0c518000ac2936?size=original" } }, "AuditsGetResponse": { "type": "object", "properties": { "audits": { "type": "array", "items": { } }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 0 }, "total_pages": { "type": "integer", "example": 0 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "example": { "audits": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "HistoricalAuditsGetResponse": { "type": "object", "properties": { "historical_audits": { "type": "array", "items": { "type": "object", "properties": { "auditable_id": { "type": "integer", "example": 1007868956 }, "auditable_type": { "type": "string", "example": "Feature" }, "id": { "type": "string", "example": "1049303076" }, "name": { "type": "string", "example": "George Gently" }, "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" }, "dates_active": { "type": "array", "items": { "type": "string" }, "example": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] } }, "example": { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] } }, "example": [ { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] }, { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] }, { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 3 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "example": { "historical_audits": [ { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] }, { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] }, { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "HistoricalAuditsPostRequest": { "type": "object", "properties": { "search": { "type": "object", "properties": { "created_since": { "type": "string", "example": "2019-01-01T00:00:00Z" }, "created_before": { "type": "string", "example": "2019-01-01T00:00:00Z" }, "auditable_type": { "type": "string", "example": "Feature" }, "auditable_id": { "type": "integer", "example": 1007868956 } }, "example": { "created_since": "2019-01-01T00:00:00Z", "created_before": "2019-01-01T00:00:00Z", "auditable_type": "Feature", "auditable_id": 1007868956 } } }, "example": { "search": { "created_since": "2019-01-01T00:00:00Z", "created_before": "2019-01-01T00:00:00Z", "auditable_type": "Feature", "auditable_id": 1007868956 } } }, "HistoricalAuditsPostResponse": { "type": "object", "properties": { "search_id": { "type": "string", "example": "6776881149486782892" } }, "example": { "search_id": "6776881149486782892" } }, "CapacityinvestmentsPostRequest": { "type": "object", "properties": { "capacity_investment": { "type": "object", "properties": { "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "string", "example": "2019-01-01" }, "date_source": { "type": "string", "example": "manual_dates" }, "custom_fields": { "type": "object", "properties": { "priority": { "type": "string", "example": "P3" } }, "example": { "priority": "P3" } } }, "example": { "start_date": "2019-01-01", "end_date": "2019-01-01", "date_source": "manual_dates", "custom_fields": { "priority": "P3" } } } }, "example": { "capacity_investment": { "start_date": "2019-01-01", "end_date": "2019-01-01", "date_source": "manual_dates", "custom_fields": { "priority": "P3" } } } }, "CapacityinvestmentsPostResponse": { "type": "object", "properties": { "capacity_investment": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149497074336" }, "capacity_scenario_id": { "type": "string", "example": "997808419" }, "total": { "type": "null" }, "estimate_source": { "type": "string", "example": "manual_estimate" }, "date_source": { "type": "string", "example": "manual_dates" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "string", "example": "2019-01-01" }, "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" } }, "estimate_values": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149497074336", "capacity_scenario_id": "997808419", "total": null, "estimate_source": "manual_estimate", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "estimate_values": [ ], "custom_fields": [ ] } } }, "example": { "capacity_investment": { "id": "6776881149497074336", "capacity_scenario_id": "997808419", "total": null, "estimate_source": "manual_estimate", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "estimate_values": [ ], "custom_fields": [ ] } } }, "CapacityinvestmentsGetResponse": { "type": "object", "properties": { "capacity_investment": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149492244248" }, "capacity_scenario_id": { "type": "string", "example": "997808419" }, "total": { "type": "number", "example": 50.0 }, "estimate_source": { "type": "string", "example": "manual_estimate" }, "date_source": { "type": "string", "example": "capacity_plannable" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "string", "example": "2019-01-01" }, "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" } }, "estimate_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "team_id": { "type": "null" }, "team_membership_id": { "type": "null" }, "period_start": { "type": "string" }, "total": { "type": "string" }, "computed": { "type": "string" }, "ignored": { "type": "string" } }, "example": { "id": "6776881149484177228", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false } }, "example": [ { "id": "6776881149484177228", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149485556219", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149487389839", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149489538211", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149491485839", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149492682136", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149493180575", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149496397024", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149497562730", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149499233465", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false } ] }, "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": 424324947, "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "Acme Corp", "type": "string" } }, "example": [ { "id": 424324947, "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "Acme Corp", "type": "string" } ] } }, "example": { "id": "6776881149492244248", "capacity_scenario_id": "997808419", "total": 50.0, "estimate_source": "manual_estimate", "date_source": "capacity_plannable", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "estimate_values": [ { "id": "6776881149484177228", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149485556219", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149487389839", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149489538211", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149491485839", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149492682136", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149493180575", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149496397024", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149497562730", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149499233465", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false } ], "custom_fields": [ { "id": 424324947, "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "Acme Corp", "type": "string" } ] } } }, "example": { "capacity_investment": { "id": "6776881149492244248", "capacity_scenario_id": "997808419", "total": 50.0, "estimate_source": "manual_estimate", "date_source": "capacity_plannable", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "estimate_values": [ { "id": "6776881149484177228", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149485556219", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149487389839", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149489538211", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149491485839", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149492682136", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149493180575", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149496397024", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149497562730", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149499233465", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false } ], "custom_fields": [ { "id": 424324947, "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "Acme Corp", "type": "string" } ] } } }, "CapacityinvestmentsPutResponse": { "type": "object", "properties": { "capacity_investment": { "type": "object", "properties": { "id": { "type": "string", "example": "756888381" }, "capacity_scenario_id": { "type": "string", "example": "997808419" }, "total": { "type": "null" }, "estimate_source": { "type": "string", "example": "manual_estimate" }, "date_source": { "type": "string", "example": "manual_dates" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "string", "example": "2019-01-01" }, "initiative": { "type": "object", "properties": { "id": { "type": "string", "example": "423077122" }, "reference_num": { "type": "string", "example": "PRJ1-S-1" }, "name": { "type": "string", "example": "Initiative 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "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" } }, "example": { "id": "423077122", "reference_num": "PRJ1-S-1", "name": "Initiative 1", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" } }, "estimate_values": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "756888381", "capacity_scenario_id": "997808419", "total": null, "estimate_source": "manual_estimate", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "initiative": { "id": "423077122", "reference_num": "PRJ1-S-1", "name": "Initiative 1", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" }, "estimate_values": [ ], "custom_fields": [ ] } } }, "example": { "capacity_investment": { "id": "756888381", "capacity_scenario_id": "997808419", "total": null, "estimate_source": "manual_estimate", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "initiative": { "id": "423077122", "reference_num": "PRJ1-S-1", "name": "Initiative 1", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" }, "estimate_values": [ ], "custom_fields": [ ] } } }, "CapacityscenariosGetResponse": { "type": "object", "properties": { "capacity_scenario": { "type": "object", "properties": { "id": { "type": "integer", "example": 997808419 }, "name": { "type": "string", "example": "Default test scenario" }, "planning_interval": { "type": "string", "example": "month" }, "planning_start_date": { "type": "string", "example": "2019-01-01" }, "planning_end_date": { "type": "string", "example": "2019-01-01" }, "estimate_value_layout": { "type": "string", "example": "team_by_time" }, "data_entry_units": { "type": "string", "example": "headcount" }, "archived": { "type": "boolean", "example": false } }, "example": { "id": 997808419, "name": "Default test scenario", "planning_interval": "month", "planning_start_date": "2019-01-01", "planning_end_date": "2019-01-01", "estimate_value_layout": "team_by_time", "data_entry_units": "headcount", "archived": false } } }, "example": { "capacity_scenario": { "id": 997808419, "name": "Default test scenario", "planning_interval": "month", "planning_start_date": "2019-01-01", "planning_end_date": "2019-01-01", "estimate_value_layout": "team_by_time", "data_entry_units": "headcount", "archived": false } } }, "CommentsPostRequest": { "type": "object", "properties": { "comment": { "type": "object", "properties": { "body": { "type": "string", "example": "

Updated comment body.

" } }, "example": { "body": "

Updated comment body.

" } } }, "example": { "comment": { "body": "

Updated comment body.

" } } }, "CommentsPostResponse": { "type": "object", "properties": { "comment": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487788674" }, "body": { "type": "string", "example": "

This is the comment body for a to-do.

" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "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" } }, "attachments": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/comments/6776881149487788674" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/comments/6776881149487788674" }, "commentable": { "type": "object", "properties": { "type": { "type": "string", "example": "Task" }, "id": { "type": "string", "example": "748715293" }, "product_id": { "type": "string", "example": "131414752" }, "url": { "type": "string", "example": "http://company.aha.io/tasks/748715293" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/tasks/748715293" } }, "example": { "type": "Task", "id": "748715293", "product_id": "131414752", "url": "http://company.aha.io/tasks/748715293", "resource": "http://company.aha.io/api/v1/tasks/748715293" } } }, "example": { "id": "6776881149487788674", "body": "

This is the comment body for a to-do.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149487788674", "resource": "http://company.aha.io/api/v1/comments/6776881149487788674", "commentable": { "type": "Task", "id": "748715293", "product_id": "131414752", "url": "http://company.aha.io/tasks/748715293", "resource": "http://company.aha.io/api/v1/tasks/748715293" } } } }, "example": { "comment": { "id": "6776881149487788674", "body": "

This is the comment body for a to-do.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149487788674", "resource": "http://company.aha.io/api/v1/comments/6776881149487788674", "commentable": { "type": "Task", "id": "748715293", "product_id": "131414752", "url": "http://company.aha.io/tasks/748715293", "resource": "http://company.aha.io/api/v1/tasks/748715293" } } } }, "CommentsGetResponse": { "type": "object", "properties": { "comments": { "type": "array", "items": { } }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 0 }, "total_pages": { "type": "integer", "example": 0 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "example": { "comments": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "CommentsPutResponse": { "type": "object", "properties": { "comment": { "type": "object", "properties": { "id": { "type": "string", "example": "781701978" }, "body": { "type": "string", "example": "

Updated comment body.

" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "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" } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "download_url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "original_file_size": { "type": "string" }, "content_type": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "string" } }, "example": { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ] }, "url": { "type": "string", "example": "http://company.aha.io/comments/781701978" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/comments/781701978" }, "commentable": { "type": "object", "properties": { "type": { "type": "string", "example": "Feature" }, "id": { "type": "string", "example": "1007868956" }, "product_id": { "type": "string", "example": "131414752" }, "url": { "type": "string", "example": "http://company.aha.io/features/PRJ1-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/features/PRJ1-1" } }, "example": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } }, "example": { "id": "781701978", "body": "

Updated comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ], "url": "http://company.aha.io/comments/781701978", "resource": "http://company.aha.io/api/v1/comments/781701978", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } } }, "example": { "comment": { "id": "781701978", "body": "

Updated comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ], "url": "http://company.aha.io/comments/781701978", "resource": "http://company.aha.io/api/v1/comments/781701978", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } } }, "CompetitorsGetResponse": { "type": "object", "properties": { "competitor": { "type": "object", "properties": { "id": { "type": "string", "example": "892399625" }, "name": { "type": "string", "example": "360 Tracker" }, "color": { "type": "integer", "example": 29647 }, "subtitle": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/competitors/PROD-C-1" }, "resource": { "type": "string", "example": "http://company.aha.io/competitors/PROD-C-1" }, "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": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } }, "example": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ] }, "comments_count": { "type": "integer", "example": 1 } }, "example": { "id": "892399625", "name": "360 Tracker", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/competitors/PROD-C-1", "custom_fields": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ], "comments_count": 1 } } }, "example": { "competitor": { "id": "892399625", "name": "360 Tracker", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/competitors/PROD-C-1", "custom_fields": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ], "comments_count": 1 } } }, "CompetitorsPostRequest": { "type": "object", "properties": { "competitor": { "type": "object", "properties": { "name": { "type": "string", "example": "Plan-a-lot" } }, "example": { "name": "Plan-a-lot" } } }, "example": { "competitor": { "name": "Plan-a-lot" } } }, "CompetitorsPostResponse": { "type": "object", "properties": { "competitor": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490638099" }, "name": { "type": "string", "example": "Plan-a-lot" }, "color": { "type": "integer", "example": 29647 }, "subtitle": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/competitors/PRJ1-C-1" }, "resource": { "type": "string", "example": "http://company.aha.io/competitors/PRJ1-C-1" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "6776881149490638099", "name": "Plan-a-lot", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PRJ1-C-1", "resource": "http://company.aha.io/competitors/PRJ1-C-1", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "competitor": { "id": "6776881149490638099", "name": "Plan-a-lot", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PRJ1-C-1", "resource": "http://company.aha.io/competitors/PRJ1-C-1", "custom_fields": [ ], "comments_count": 0 } } }, "CompetitorsPutResponse": { "type": "object", "properties": { "competitor": { "type": "object", "properties": { "id": { "type": "string", "example": "892399625" }, "name": { "type": "string", "example": "Plan-a-lot" }, "color": { "type": "integer", "example": 29647 }, "subtitle": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/competitors/PROD-C-1" }, "resource": { "type": "string", "example": "http://company.aha.io/competitors/PROD-C-1" }, "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": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } }, "example": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ] }, "comments_count": { "type": "integer", "example": 1 } }, "example": { "id": "892399625", "name": "Plan-a-lot", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/competitors/PROD-C-1", "custom_fields": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ], "comments_count": 1 } } }, "example": { "competitor": { "id": "892399625", "name": "Plan-a-lot", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/competitors/PROD-C-1", "custom_fields": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ], "comments_count": 1 } } }, "CreativebriefsPostRequest": { "type": "object", "properties": { "creative_brief": { "type": "object", "properties": { "name": { "type": "string", "example": "December launch" } }, "example": { "name": "December launch" } } }, "example": { "creative_brief": { "name": "December launch" } } }, "CreativebriefsPostResponse": { "type": "object", "properties": { "creative_brief": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490547091" }, "name": { "type": "string", "example": "April launch" }, "color": { "type": "integer", "example": 13421772 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/creative_briefs/6776881149490547091" }, "resource": { "type": "string", "example": "http://company.aha.io/creative_briefs/6776881149490547091" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "6776881149490547091", "name": "April launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/6776881149490547091", "resource": "http://company.aha.io/creative_briefs/6776881149490547091", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "creative_brief": { "id": "6776881149490547091", "name": "April launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/6776881149490547091", "resource": "http://company.aha.io/creative_briefs/6776881149490547091", "custom_fields": [ ], "comments_count": 0 } } }, "CreativebriefsGetResponse": { "type": "object", "properties": { "creative_brief": { "type": "object", "properties": { "id": { "type": "string", "example": "476477971" }, "name": { "type": "string", "example": "April launch" }, "color": { "type": "integer", "example": 13421772 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/creative_briefs/476477971" }, "resource": { "type": "string", "example": "http://company.aha.io/creative_briefs/476477971" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "476477971", "name": "April launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/476477971", "resource": "http://company.aha.io/creative_briefs/476477971", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "creative_brief": { "id": "476477971", "name": "April launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/476477971", "resource": "http://company.aha.io/creative_briefs/476477971", "custom_fields": [ ], "comments_count": 0 } } }, "CreativebriefsPutResponse": { "type": "object", "properties": { "creative_brief": { "type": "object", "properties": { "id": { "type": "string", "example": "476477971" }, "name": { "type": "string", "example": "December launch" }, "color": { "type": "integer", "example": 13421772 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/creative_briefs/476477971" }, "resource": { "type": "string", "example": "http://company.aha.io/creative_briefs/476477971" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "476477971", "name": "December launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/476477971", "resource": "http://company.aha.io/creative_briefs/476477971", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "creative_brief": { "id": "476477971", "name": "December launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/476477971", "resource": "http://company.aha.io/creative_briefs/476477971", "custom_fields": [ ], "comments_count": 0 } } }, "CustomfieldsGetResponse": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "example": "P1" }, "value": { "type": "string", "example": "486420793" }, "meta": { "type": "object", "properties": { "color": { "type": "string" } }, "example": { "color": "#666666" } } }, "example": { "text": "P1", "value": "486420793", "meta": { "color": "#666666" } } }, "example": [ { "text": "P1", "value": "486420793", "meta": { "color": "#666666" } }, { "text": "P2", "value": "100098181", "meta": { "color": "#666666" } }, { "text": "P3", "value": "854609942", "meta": { "color": "#666666" } }, { "text": "P4", "value": "747947447", "meta": { "color": "#666666" } }, { "text": "P5", "value": "462681378", "meta": { "color": "#666666" } } ] } }, "example": { "options": [ { "text": "P1", "value": "486420793", "meta": { "color": "#666666" } }, { "text": "P2", "value": "100098181", "meta": { "color": "#666666" } }, { "text": "P3", "value": "854609942", "meta": { "color": "#666666" } }, { "text": "P4", "value": "747947447", "meta": { "color": "#666666" } }, { "text": "P5", "value": "462681378", "meta": { "color": "#666666" } } ] } }, "CustomfieldoptionsGetResponse": { "type": "object", "properties": { "custom_field_options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "100098181" }, "value": { "type": "string", "example": "P2" }, "color": { "type": "integer", "example": 6710886 }, "hidden": { "type": "boolean", "example": false } }, "example": { "id": "100098181", "value": "P2", "color": 6710886, "hidden": false } }, "example": [ { "id": "100098181", "value": "P2", "color": 6710886, "hidden": false }, { "id": "462681378", "value": "P5", "color": 6710886, "hidden": false }, { "id": "486420793", "value": "P1", "color": 6710886, "hidden": false }, { "id": "747947447", "value": "P4", "color": 6710886, "hidden": false }, { "id": "854609942", "value": "P3", "color": 6710886, "hidden": false } ] } }, "example": { "custom_field_options": [ { "id": "100098181", "value": "P2", "color": 6710886, "hidden": false }, { "id": "462681378", "value": "P5", "color": 6710886, "hidden": false }, { "id": "486420793", "value": "P1", "color": 6710886, "hidden": false }, { "id": "747947447", "value": "P4", "color": 6710886, "hidden": false }, { "id": "854609942", "value": "P3", "color": 6710886, "hidden": false } ] } }, "CustomfieldoptionsPostRequest": { "type": "object", "properties": { }, "example": { } }, "CustomfieldoptionsPostResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149485179355" }, "value": { "type": "string", "example": "New option" }, "color": { "type": "integer", "example": 6710886 }, "hidden": { "type": "boolean", "example": false } }, "example": { "id": "6776881149485179355", "value": "New option", "color": 6710886, "hidden": false } }, "CustomfieldoptionsPutResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "486420793" }, "value": { "type": "string", "example": "New option2" }, "color": { "type": "integer", "example": 6710886 }, "hidden": { "type": "boolean", "example": false } }, "example": { "id": "486420793", "value": "New option2", "color": 6710886, "hidden": false } }, "CustomfieldoptionsDeleteResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "486420793" }, "value": { "type": "string", "example": "P1" }, "color": { "type": "integer", "example": 6710886 }, "hidden": { "type": "boolean", "example": false } }, "example": { "id": "486420793", "value": "P1", "color": 6710886, "hidden": false } }, "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 ] } } } }, "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" } } } }, "CustomtablerecordsPostRequest": { "type": "object", "properties": { "custom_object_record": { "type": "object", "properties": { "custom_fields": { "type": "object", "properties": { "name": { "type": "string", "example": "Major conglomerate" }, "website": { "type": "string", "example": "www.conglom.com" } }, "example": { "name": "Major conglomerate", "website": "www.conglom.com" } } }, "example": { "custom_fields": { "name": "Major conglomerate", "website": "www.conglom.com" } } } }, "example": { "custom_object_record": { "custom_fields": { "name": "Major conglomerate", "website": "www.conglom.com" } } } }, "CustomtablerecordsPostResponse": { "type": "object", "properties": { "custom_object_record": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149486714349" }, "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": "6776881149493312138", "key": "name", "name": "Name", "updatedAt": "2019-01-01T00:00:00Z", "value": "Major conglomerate", "type": "string" } }, "example": [ { "id": "6776881149493312138", "key": "name", "name": "Name", "updatedAt": "2019-01-01T00:00:00Z", "value": "Major conglomerate", "type": "string" }, { "id": "6776881149489312610", "key": "website", "name": "Website", "updatedAt": "2019-01-01T00:00:00Z", "value": "www.conglom.com", "type": "url" } ] }, "custom_object_links": { "type": "array", "items": { } }, "linked_records": { "type": "array", "items": { } }, "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": "6776881149486714349", "product_id": "131414752", "key": "customers", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "custom_fields": [ { "id": "6776881149493312138", "key": "name", "name": "Name", "updatedAt": "2019-01-01T00:00:00Z", "value": "Major conglomerate", "type": "string" }, { "id": "6776881149489312610", "key": "website", "name": "Website", "updatedAt": "2019-01-01T00:00:00Z", "value": "www.conglom.com", "type": "url" } ], "custom_object_links": [ ], "linked_records": [ ], "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": "6776881149486714349", "product_id": "131414752", "key": "customers", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "custom_fields": [ { "id": "6776881149493312138", "key": "name", "name": "Name", "updatedAt": "2019-01-01T00:00:00Z", "value": "Major conglomerate", "type": "string" }, { "id": "6776881149489312610", "key": "website", "name": "Website", "updatedAt": "2019-01-01T00:00:00Z", "value": "www.conglom.com", "type": "url" } ], "custom_object_links": [ ], "linked_records": [ ], "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" } } } }, "CustomtablerecordsGetResponse": { "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": [ ] } ] }, "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": [ ] } ], "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": [ ] } ], "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" } } } }, "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" } } } }, "CustompivotsGetResponse": { "type": "object", "properties": { "top_level_columns": { "type": "array", "items": { "type": "integer", "example": 1 }, "example": [ 1, 2, 3 ] }, "columns": { "type": "object", "properties": { "1": { "type": "object", "properties": { "ref": { "type": "integer", "example": 1 }, "parent_ref": { "type": "null" }, "child_refs": { "type": "array", "items": { } }, "id": { "type": "integer", "example": 131414752 }, "plain_value": { "type": "string", "example": "Project 1" }, "html_value": { "type": "string", "example": "Project 1" }, "rich_value": { "type": "string", "example": "Project 1" }, "field_definition_ref": { "type": "integer", "example": 7 } }, "example": { "ref": 1, "parent_ref": null, "child_refs": [ ], "id": 131414752, "plain_value": "Project 1", "html_value": "Project 1", "rich_value": "Project 1", "field_definition_ref": 7 } }, "2": { "type": "object", "properties": { "ref": { "type": "integer", "example": 2 }, "parent_ref": { "type": "null" }, "child_refs": { "type": "array", "items": { } }, "id": { "type": "integer", "example": 517761884 }, "plain_value": { "type": "string", "example": "Project 2" }, "html_value": { "type": "string", "example": "Project 2" }, "rich_value": { "type": "string", "example": "Project 2" }, "field_definition_ref": { "type": "integer", "example": 7 } }, "example": { "ref": 2, "parent_ref": null, "child_refs": [ ], "id": 517761884, "plain_value": "Project 2", "html_value": "Project 2", "rich_value": "Project 2", "field_definition_ref": 7 } }, "3": { "type": "object", "properties": { "ref": { "type": "integer", "example": 3 }, "parent_ref": { "type": "null" }, "child_refs": { "type": "array", "items": { } }, "id": { "type": "integer", "example": 702241743 }, "plain_value": { "type": "string", "example": "Project 3" }, "html_value": { "type": "string", "example": "Project 3" }, "rich_value": { "type": "string", "example": "Project 3" }, "field_definition_ref": { "type": "integer", "example": 7 } }, "example": { "ref": 3, "parent_ref": null, "child_refs": [ ], "id": 702241743, "plain_value": "Project 3", "html_value": "Project 3", "rich_value": "Project 3", "field_definition_ref": 7 } } }, "example": { "1": { "ref": 1, "parent_ref": null, "child_refs": [ ], "id": 131414752, "plain_value": "Project 1", "html_value": "Project 1", "rich_value": "Project 1", "field_definition_ref": 7 }, "2": { "ref": 2, "parent_ref": null, "child_refs": [ ], "id": 517761884, "plain_value": "Project 2", "html_value": "Project 2", "rich_value": "Project 2", "field_definition_ref": 7 }, "3": { "ref": 3, "parent_ref": null, "child_refs": [ ], "id": 702241743, "plain_value": "Project 3", "html_value": "Project 3", "rich_value": "Project 3", "field_definition_ref": 7 } } }, "top_level_rows": { "type": "array", "items": { "type": "integer", "example": 4 }, "example": [ 4, 5, 6 ] }, "rows": { "type": "object", "properties": { "4": { "type": "object", "properties": { "ref": { "type": "integer", "example": 4 }, "parent_ref": { "type": "null" }, "child_refs": { "type": "array", "items": { } }, "id": { "type": "integer", "example": 278327321 }, "plain_value": { "type": "string", "example": "Release 1" }, "html_value": { "type": "string", "example": "Release 1" }, "rich_value": { "type": "string", "example": "Release 1" }, "field_definition_ref": { "type": "integer", "example": 8 } }, "example": { "ref": 4, "parent_ref": null, "child_refs": [ ], "id": 278327321, "plain_value": "Release 1", "html_value": "Release 1", "rich_value": "Release 1", "field_definition_ref": 8 } }, "5": { "type": "object", "properties": { "ref": { "type": "integer", "example": 5 }, "parent_ref": { "type": "null" }, "child_refs": { "type": "array", "items": { } }, "id": { "type": "integer", "example": 1000426269 }, "plain_value": { "type": "string", "example": "Release 2" }, "html_value": { "type": "string", "example": "Release 2" }, "rich_value": { "type": "string", "example": "Release 2" }, "field_definition_ref": { "type": "integer", "example": 8 } }, "example": { "ref": 5, "parent_ref": null, "child_refs": [ ], "id": 1000426269, "plain_value": "Release 2", "html_value": "Release 2", "rich_value": "Release 2", "field_definition_ref": 8 } }, "6": { "type": "object", "properties": { "ref": { "type": "integer", "example": 6 }, "parent_ref": { "type": "null" }, "child_refs": { "type": "array", "items": { } }, "id": { "type": "integer", "example": 342040612 }, "plain_value": { "type": "string", "example": "Release 3 Project 3" }, "html_value": { "type": "string", "example": "Release 3 Project 3" }, "rich_value": { "type": "string", "example": "Release 3 Project 3" }, "field_definition_ref": { "type": "integer", "example": 8 } }, "example": { "ref": 6, "parent_ref": null, "child_refs": [ ], "id": 342040612, "plain_value": "Release 3 Project 3", "html_value": "Release 3 Project 3", "rich_value": "Release 3 Project 3", "field_definition_ref": 8 } } }, "example": { "4": { "ref": 4, "parent_ref": null, "child_refs": [ ], "id": 278327321, "plain_value": "Release 1", "html_value": "Release 1", "rich_value": "Release 1", "field_definition_ref": 8 }, "5": { "ref": 5, "parent_ref": null, "child_refs": [ ], "id": 1000426269, "plain_value": "Release 2", "html_value": "Release 2", "rich_value": "Release 2", "field_definition_ref": 8 }, "6": { "ref": 6, "parent_ref": null, "child_refs": [ ], "id": 342040612, "plain_value": "Release 3 Project 3", "html_value": "Release 3 Project 3", "rich_value": "Release 3 Project 3", "field_definition_ref": 8 } } }, "cells": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "string" }, "example": [ [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 1055237874, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 444379319, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 622562724, "plain_value": "PRJ1-2", "html_value": "PRJ1-2", "rich_value": "PRJ1-2", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 622562724, "plain_value": "Another Feature", "html_value": "Another Feature", "rich_value": "Another Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 622562724, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 303873333, "plain_value": "PRJ1-3", "html_value": "PRJ1-3", "rich_value": "PRJ1-3", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 303873333, "plain_value": "Another Third Feature", "html_value": "Another Third Feature", "rich_value": "Another Third Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 303873333, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 209201304, "plain_value": "PRJ1-4", "html_value": "PRJ1-4", "rich_value": "PRJ1-4", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 209201304, "plain_value": "Another Fourth Feature", "html_value": "Another Fourth Feature", "rich_value": "Another Fourth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 209201304, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 998184963, "plain_value": "PRJ1-5", "html_value": "PRJ1-5", "rich_value": "PRJ1-5", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 998184963, "plain_value": "Another Fifth Feature", "html_value": "Another Fifth Feature", "rich_value": "Another Fifth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 998184963, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ] ] }, "example": [ [ [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 1055237874, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 444379319, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 622562724, "plain_value": "PRJ1-2", "html_value": "PRJ1-2", "rich_value": "PRJ1-2", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 622562724, "plain_value": "Another Feature", "html_value": "Another Feature", "rich_value": "Another Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 622562724, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 303873333, "plain_value": "PRJ1-3", "html_value": "PRJ1-3", "rich_value": "PRJ1-3", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 303873333, "plain_value": "Another Third Feature", "html_value": "Another Third Feature", "rich_value": "Another Third Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 303873333, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 209201304, "plain_value": "PRJ1-4", "html_value": "PRJ1-4", "rich_value": "PRJ1-4", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 209201304, "plain_value": "Another Fourth Feature", "html_value": "Another Fourth Feature", "rich_value": "Another Fourth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 209201304, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 998184963, "plain_value": "PRJ1-5", "html_value": "PRJ1-5", "rich_value": "PRJ1-5", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 998184963, "plain_value": "Another Fifth Feature", "html_value": "Another Fifth Feature", "rich_value": "Another Fifth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 998184963, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ] ], [ ], [ ] ] }, "example": [ [ [ [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 1055237874, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 444379319, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 622562724, "plain_value": "PRJ1-2", "html_value": "PRJ1-2", "rich_value": "PRJ1-2", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 622562724, "plain_value": "Another Feature", "html_value": "Another Feature", "rich_value": "Another Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 622562724, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 303873333, "plain_value": "PRJ1-3", "html_value": "PRJ1-3", "rich_value": "PRJ1-3", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 303873333, "plain_value": "Another Third Feature", "html_value": "Another Third Feature", "rich_value": "Another Third Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 303873333, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 209201304, "plain_value": "PRJ1-4", "html_value": "PRJ1-4", "rich_value": "PRJ1-4", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 209201304, "plain_value": "Another Fourth Feature", "html_value": "Another Fourth Feature", "rich_value": "Another Fourth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 209201304, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 998184963, "plain_value": "PRJ1-5", "html_value": "PRJ1-5", "rich_value": "PRJ1-5", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 998184963, "plain_value": "Another Fifth Feature", "html_value": "Another Fifth Feature", "rich_value": "Another Fifth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 998184963, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ] ], [ ], [ ] ], [ [ ], [ [ { "id": 101074039, "plain_value": "PRJ2-1", "html_value": "PRJ2-1", "rich_value": "PRJ2-1", "row_ref": 5, "column_ref": 2, "field_definition_ref": 9 }, { "id": 101074039, "plain_value": "A feature in project 2", "html_value": "A feature in project 2", "rich_value": "A feature in project 2", "row_ref": 5, "column_ref": 2, "field_definition_ref": 10 }, { "id": 101074039, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 5, "column_ref": 2, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 5, "column_ref": 2, "field_definition_ref": 12 } ] ], [ ] ], [ [ ], [ ], [ [ { "id": 229579240, "plain_value": "PRJ3-1", "html_value": "PRJ3-1", "rich_value": "PRJ3-1", "row_ref": 6, "column_ref": 3, "field_definition_ref": 9 }, { "id": 229579240, "plain_value": "Feature without Requirements", "html_value": "Feature without Requirements", "rich_value": "Feature without Requirements", "row_ref": 6, "column_ref": 3, "field_definition_ref": 10 }, { "id": 229579240, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 6, "column_ref": 3, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 6, "column_ref": 3, "field_definition_ref": 12 } ], [ { "id": 959120953, "plain_value": "PRJ3-2", "html_value": "PRJ3-2", "rich_value": "PRJ3-2", "row_ref": 6, "column_ref": 3, "field_definition_ref": 9 }, { "id": 959120953, "plain_value": "A third Feature", "html_value": "A third Feature", "rich_value": "A third Feature", "row_ref": 6, "column_ref": 3, "field_definition_ref": 10 }, { "id": 959120953, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 6, "column_ref": 3, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 6, "column_ref": 3, "field_definition_ref": 12 } ] ] ] ] }, "field_definitions": { "type": "object", "properties": { "7": { "type": "object", "properties": { "ref": { "type": "integer", "example": 7 }, "table": { "type": "string", "example": "projects" }, "field": { "type": "string", "example": "name" }, "title": { "type": "string", "example": "Workspace name" } }, "example": { "ref": 7, "table": "projects", "field": "name", "title": "Workspace name" } }, "8": { "type": "object", "properties": { "ref": { "type": "integer", "example": 8 }, "table": { "type": "string", "example": "releases" }, "field": { "type": "string", "example": "name" }, "title": { "type": "string", "example": "Release name" } }, "example": { "ref": 8, "table": "releases", "field": "name", "title": "Release name" } }, "9": { "type": "object", "properties": { "ref": { "type": "integer", "example": 9 }, "table": { "type": "string", "example": "features" }, "field": { "type": "string", "example": "reference_num" }, "title": { "type": "string", "example": "Feature reference #" } }, "example": { "ref": 9, "table": "features", "field": "reference_num", "title": "Feature reference #" } }, "10": { "type": "object", "properties": { "ref": { "type": "integer", "example": 10 }, "table": { "type": "string", "example": "features" }, "field": { "type": "string", "example": "name" }, "title": { "type": "string", "example": "Feature name" } }, "example": { "ref": 10, "table": "features", "field": "name", "title": "Feature name" } }, "11": { "type": "object", "properties": { "ref": { "type": "integer", "example": 11 }, "table": { "type": "string", "example": "features" }, "field": { "type": "string", "example": "status" }, "title": { "type": "string", "example": "Feature status" } }, "example": { "ref": 11, "table": "features", "field": "status", "title": "Feature status" } }, "12": { "type": "object", "properties": { "ref": { "type": "integer", "example": 12 }, "table": { "type": "string", "example": "ideas" }, "field": { "type": "string", "example": "created_by_user_id" }, "title": { "type": "string", "example": "Idea created by" } }, "example": { "ref": 12, "table": "ideas", "field": "created_by_user_id", "title": "Idea created by" } } }, "example": { "7": { "ref": 7, "table": "projects", "field": "name", "title": "Workspace name" }, "8": { "ref": 8, "table": "releases", "field": "name", "title": "Release name" }, "9": { "ref": 9, "table": "features", "field": "reference_num", "title": "Feature reference #" }, "10": { "ref": 10, "table": "features", "field": "name", "title": "Feature name" }, "11": { "ref": 11, "table": "features", "field": "status", "title": "Feature status" }, "12": { "ref": 12, "table": "ideas", "field": "created_by_user_id", "title": "Idea created by" } } } }, "example": { "top_level_columns": [ 1, 2, 3 ], "columns": { "1": { "ref": 1, "parent_ref": null, "child_refs": [ ], "id": 131414752, "plain_value": "Project 1", "html_value": "Project 1", "rich_value": "Project 1", "field_definition_ref": 7 }, "2": { "ref": 2, "parent_ref": null, "child_refs": [ ], "id": 517761884, "plain_value": "Project 2", "html_value": "Project 2", "rich_value": "Project 2", "field_definition_ref": 7 }, "3": { "ref": 3, "parent_ref": null, "child_refs": [ ], "id": 702241743, "plain_value": "Project 3", "html_value": "Project 3", "rich_value": "Project 3", "field_definition_ref": 7 } }, "top_level_rows": [ 4, 5, 6 ], "rows": { "4": { "ref": 4, "parent_ref": null, "child_refs": [ ], "id": 278327321, "plain_value": "Release 1", "html_value": "Release 1", "rich_value": "Release 1", "field_definition_ref": 8 }, "5": { "ref": 5, "parent_ref": null, "child_refs": [ ], "id": 1000426269, "plain_value": "Release 2", "html_value": "Release 2", "rich_value": "Release 2", "field_definition_ref": 8 }, "6": { "ref": 6, "parent_ref": null, "child_refs": [ ], "id": 342040612, "plain_value": "Release 3 Project 3", "html_value": "Release 3 Project 3", "rich_value": "Release 3 Project 3", "field_definition_ref": 8 } }, "cells": [ [ [ [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 1055237874, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 444379319, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 622562724, "plain_value": "PRJ1-2", "html_value": "PRJ1-2", "rich_value": "PRJ1-2", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 622562724, "plain_value": "Another Feature", "html_value": "Another Feature", "rich_value": "Another Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 622562724, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 303873333, "plain_value": "PRJ1-3", "html_value": "PRJ1-3", "rich_value": "PRJ1-3", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 303873333, "plain_value": "Another Third Feature", "html_value": "Another Third Feature", "rich_value": "Another Third Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 303873333, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 209201304, "plain_value": "PRJ1-4", "html_value": "PRJ1-4", "rich_value": "PRJ1-4", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 209201304, "plain_value": "Another Fourth Feature", "html_value": "Another Fourth Feature", "rich_value": "Another Fourth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 209201304, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 998184963, "plain_value": "PRJ1-5", "html_value": "PRJ1-5", "rich_value": "PRJ1-5", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 998184963, "plain_value": "Another Fifth Feature", "html_value": "Another Fifth Feature", "rich_value": "Another Fifth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 998184963, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ] ], [ ], [ ] ], [ [ ], [ [ { "id": 101074039, "plain_value": "PRJ2-1", "html_value": "PRJ2-1", "rich_value": "PRJ2-1", "row_ref": 5, "column_ref": 2, "field_definition_ref": 9 }, { "id": 101074039, "plain_value": "A feature in project 2", "html_value": "A feature in project 2", "rich_value": "A feature in project 2", "row_ref": 5, "column_ref": 2, "field_definition_ref": 10 }, { "id": 101074039, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 5, "column_ref": 2, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 5, "column_ref": 2, "field_definition_ref": 12 } ] ], [ ] ], [ [ ], [ ], [ [ { "id": 229579240, "plain_value": "PRJ3-1", "html_value": "PRJ3-1", "rich_value": "PRJ3-1", "row_ref": 6, "column_ref": 3, "field_definition_ref": 9 }, { "id": 229579240, "plain_value": "Feature without Requirements", "html_value": "Feature without Requirements", "rich_value": "Feature without Requirements", "row_ref": 6, "column_ref": 3, "field_definition_ref": 10 }, { "id": 229579240, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 6, "column_ref": 3, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 6, "column_ref": 3, "field_definition_ref": 12 } ], [ { "id": 959120953, "plain_value": "PRJ3-2", "html_value": "PRJ3-2", "rich_value": "PRJ3-2", "row_ref": 6, "column_ref": 3, "field_definition_ref": 9 }, { "id": 959120953, "plain_value": "A third Feature", "html_value": "A third Feature", "rich_value": "A third Feature", "row_ref": 6, "column_ref": 3, "field_definition_ref": 10 }, { "id": 959120953, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 6, "column_ref": 3, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 6, "column_ref": 3, "field_definition_ref": 12 } ] ] ] ], "field_definitions": { "7": { "ref": 7, "table": "projects", "field": "name", "title": "Workspace name" }, "8": { "ref": 8, "table": "releases", "field": "name", "title": "Release name" }, "9": { "ref": 9, "table": "features", "field": "reference_num", "title": "Feature reference #" }, "10": { "ref": 10, "table": "features", "field": "name", "title": "Feature name" }, "11": { "ref": 11, "table": "features", "field": "status", "title": "Feature status" }, "12": { "ref": 12, "table": "ideas", "field": "created_by_user_id", "title": "Idea created by" } } } }, "DeletionsGetResponse": { "type": "object", "properties": { "deletions": { "type": "array", "items": { } }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 0 }, "total_pages": { "type": "integer", "example": 0 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "example": { "deletions": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "DeletionsPostResponse": { "type": "object", "properties": { "deletion": { "type": "object", "properties": { "status": { "type": "string", "example": "restore_in_progress" }, "record": { "type": "object", "properties": { "name": { "type": "string", "example": "Feature 1" }, "type": { "type": "string", "example": "Feature" }, "reference_num": { "type": "string", "example": "PRJ1-1" } }, "example": { "name": "Feature 1", "type": "Feature", "reference_num": "PRJ1-1" } }, "deleted_by": { "type": "object", "properties": { "id": { "type": "integer", "example": 1049303076 }, "name": { "type": "string", "example": "George Gently" }, "email": { "type": "string", "example": "no-reply@aha.io" } }, "example": { "id": 1049303076, "name": "George Gently", "email": "no-reply@aha.io" } }, "id": { "type": "string", "example": "6776881149497698683" }, "deleted_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "status": "restore_in_progress", "record": { "name": "Feature 1", "type": "Feature", "reference_num": "PRJ1-1" }, "deleted_by": { "id": 1049303076, "name": "George Gently", "email": "no-reply@aha.io" }, "id": "6776881149497698683", "deleted_at": "2019-01-01T00:00:00.000Z" } } }, "example": { "deletion": { "status": "restore_in_progress", "record": { "name": "Feature 1", "type": "Feature", "reference_num": "PRJ1-1" }, "deleted_by": { "id": 1049303076, "name": "George Gently", "email": "no-reply@aha.io" }, "id": "6776881149497698683", "deleted_at": "2019-01-01T00:00:00.000Z" } } }, "EpicsGetResponse": { "type": "object", "properties": { "epic": { "type": "object", "properties": { "id": { "type": "string", "example": "999605892" }, "name": { "type": "string", "example": "Epic 1" }, "reference_num": { "type": "string", "example": "PRJ1-E-1" }, "initiative_reference_num": { "type": "string", "example": "PRJ1-S-1" }, "position": { "type": "integer", "example": 1 }, "score": { "type": "integer", "example": 42 }, "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": "null" }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_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_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": "4321567" }, "body": { "type": "string", "example": "Body of Epic Description" }, "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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "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": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "created_at": "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" }, "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" } } }, "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 } }, "features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "product_id": { "type": "string" } }, "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" } }, "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" } ] }, "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": { } }, "comments_count": { "type": "integer", "example": 1 }, "score_facts": { "type": "array", "items": { } }, "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" } ] }, "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": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } }, "example": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ] }, "epic_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": "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } }, "example": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ] }, "master_feature_only_original_estimate": { "type": "null" }, "master_feature_only_remaining_estimate": { "type": "null" }, "master_feature_only_work_done": { "type": "null" }, "epic_only_original_estimate": { "type": "null" }, "epic_only_remaining_estimate": { "type": "null" }, "epic_only_work_done": { "type": "null" } }, "example": { "id": "999605892", "name": "Epic 1", "reference_num": "PRJ1-E-1", "initiative_reference_num": "PRJ1-S-1", "position": 1, "score": 42, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": "2019-01-01", "due_date": "2019-01-01", "product_id": "131414752", "progress": null, "progress_source": "progress_manual", "duration_source": "duration_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_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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "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", "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" } }, "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 }, "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" } ], "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": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ "Infrastructure" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" } ], "custom_fields": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ], "epic_links": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "example": { "epic": { "id": "999605892", "name": "Epic 1", "reference_num": "PRJ1-E-1", "initiative_reference_num": "PRJ1-S-1", "position": 1, "score": 42, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": "2019-01-01", "due_date": "2019-01-01", "product_id": "131414752", "progress": null, "progress_source": "progress_manual", "duration_source": "duration_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_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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "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", "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" } }, "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 }, "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" } ], "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": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ "Infrastructure" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" } ], "custom_fields": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ], "epic_links": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "EpicsPostRequest": { "type": "object", "properties": { "name": { "type": "string", "example": "New name" }, "description": { "type": "string", "example": "New description" } }, "example": { "name": "New name", "description": "New description" } }, "EpicsPostResponse": { "type": "object", "properties": { "epic": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149485403843" }, "name": { "type": "string", "example": "New name" }, "reference_num": { "type": "string", "example": "PRJ1-E-251" }, "initiative_reference_num": { "type": "null" }, "position": { "type": "integer", "example": 1 }, "score": { "type": "integer", "example": 2 }, "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": "null" }, "due_date": { "type": "null" }, "product_id": { "type": "string", "example": "131414752" }, "progress": { "type": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "status_changed_on": { "type": "string", "example": "2019-01-01" }, "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" } }, "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": "6776881149495498605" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149495498605", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "attachments": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/epics/PRJ1-E-251" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/epics/PRJ1-E-251" }, "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" } } }, "assigned_to_user": { "type": "object", "properties": { "id": { "type": "string", "example": "689956296" }, "name": { "type": "string", "example": "Henry 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" }, "default_assignee": { "type": "boolean", "example": true } }, "example": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true } }, "features": { "type": "array", "items": { } }, "goals": { "type": "array", "items": { } }, "key_results": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 }, "score_facts": { "type": "array", "items": { } }, "tags": { "type": "array", "items": { } }, "full_tags": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "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": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } }, "example": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "epic_links": { "type": "array", "items": { } }, "master_feature_only_original_estimate": { "type": "null" }, "master_feature_only_remaining_estimate": { "type": "null" }, "master_feature_only_work_done": { "type": "null" }, "epic_only_original_estimate": { "type": "null" }, "epic_only_remaining_estimate": { "type": "null" }, "epic_only_work_done": { "type": "null" } }, "example": { "id": "6776881149485403843", "name": "New name", "reference_num": "PRJ1-E-251", "initiative_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_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": "6776881149495498605", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ1-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-251", "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" } }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "epic_links": [ ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "example": { "epic": { "id": "6776881149485403843", "name": "New name", "reference_num": "PRJ1-E-251", "initiative_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_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": "6776881149495498605", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ1-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-251", "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" } }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "epic_links": [ ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "EpicsPutResponse": { "type": "object", "properties": { "epic": { "type": "object", "properties": { "id": { "type": "string", "example": "999605892" }, "name": { "type": "string", "example": "Epic 1" }, "reference_num": { "type": "string", "example": "PRJ1-E-1" }, "initiative_reference_num": { "type": "string", "example": "PRJ1-S-1" }, "position": { "type": "integer", "example": 1 }, "score": { "type": "integer", "example": 42 }, "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" }, "duration_source": { "type": "string", "example": "duration_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_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": "4321567" }, "body": { "type": "string", "example": "Body of Epic Description" }, "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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "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": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "created_at": "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" }, "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" } } }, "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 } }, "features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "product_id": { "type": "string" } }, "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" } }, "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" } ] }, "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": { } }, "comments_count": { "type": "integer", "example": 1 }, "score_facts": { "type": "array", "items": { } }, "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" } ] }, "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": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } }, "example": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ] }, "epic_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": "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } }, "example": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ] }, "master_feature_only_original_estimate": { "type": "null" }, "master_feature_only_remaining_estimate": { "type": "null" }, "master_feature_only_work_done": { "type": "null" }, "epic_only_original_estimate": { "type": "null" }, "epic_only_remaining_estimate": { "type": "null" }, "epic_only_work_done": { "type": "null" } }, "example": { "id": "999605892", "name": "Epic 1", "reference_num": "PRJ1-E-1", "initiative_reference_num": "PRJ1-S-1", "position": 1, "score": 42, "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", "duration_source": "duration_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_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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "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", "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" } }, "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 }, "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" } ], "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": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ "Infrastructure" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" } ], "custom_fields": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ], "epic_links": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "example": { "epic": { "id": "999605892", "name": "Epic 1", "reference_num": "PRJ1-E-1", "initiative_reference_num": "PRJ1-S-1", "position": 1, "score": 42, "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", "duration_source": "duration_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_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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "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", "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" } }, "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 }, "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" } ], "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": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ "Infrastructure" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" } ], "custom_fields": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ], "epic_links": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "CapacityestimatevaluesPostRequest": { "type": "object", "properties": { }, "example": { } }, "CapacityestimatevaluesPostResponse": { "type": "object", "properties": { "updated": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487632203" }, "team_id": { "type": "integer", "example": 563889676 }, "team_membership_id": { "type": "null" }, "period_start": { "type": "string", "example": "2019-01-01" }, "total": { "type": "number", "example": 15.0 }, "computed": { "type": "boolean", "example": false }, "ignored": { "type": "boolean", "example": false } }, "example": { "id": "6776881149487632203", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false } }, "example": [ { "id": "6776881149487632203", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false }, { "id": "6776881149489311818", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149490125878", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149490529746", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149490943142", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149492175407", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149493726512", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149494705557", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149498133135", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149499236800", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false } ] }, "destroyed": { "type": "array", "items": { } } }, "example": { "updated": [ { "id": "6776881149487632203", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false }, { "id": "6776881149489311818", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149490125878", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149490529746", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149490943142", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149492175407", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149493726512", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149494705557", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149498133135", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149499236800", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false } ], "destroyed": [ ] } }, "CapacityestimatevaluesGetResponse": { "type": "object", "properties": { "estimate_values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149483568838" }, "team_id": { "type": "null" }, "team_membership_id": { "type": "null" }, "period_start": { "type": "string", "example": "2019-01-01" }, "total": { "type": "number", "example": 5.0 }, "computed": { "type": "boolean", "example": true }, "ignored": { "type": "boolean", "example": false } }, "example": { "id": "6776881149483568838", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false } }, "example": [ { "id": "6776881149483568838", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149485225809", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149487362068", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149487778568", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false }, { "id": "6776881149494637954", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149497124166", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149497859029", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149498218684", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149498683658", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149498909376", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 10 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 10, "total_pages": 1, "current_page": 1 } } }, "example": { "estimate_values": [ { "id": "6776881149483568838", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149485225809", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149487362068", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149487778568", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false }, { "id": "6776881149494637954", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149497124166", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149497859029", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149498218684", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149498683658", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149498909376", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false } ], "pagination": { "total_records": 10, "total_pages": 1, "current_page": 1 } } }, "CapacityestimatevaluesPutResponse": { "type": "object", "properties": { "updated": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487468817" }, "team_id": { "type": "integer", "example": 949295028 }, "team_membership_id": { "type": "null" }, "period_start": { "type": "null" }, "total": { "type": "number", "example": 25.0 }, "computed": { "type": "boolean", "example": true }, "ignored": { "type": "boolean", "example": false } }, "example": { "id": "6776881149487468817", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 25.0, "computed": true, "ignored": false } }, "example": [ { "id": "6776881149487468817", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149490802007", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149491123830", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149492562019", "team_id": null, "team_membership_id": null, "period_start": null, "total": 60.0, "computed": true, "ignored": false } ] }, "destroyed": { "type": "array", "items": { } } }, "example": { "updated": [ { "id": "6776881149487468817", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149490802007", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149491123830", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149492562019", "team_id": null, "team_membership_id": null, "period_start": null, "total": 60.0, "computed": true, "ignored": false } ], "destroyed": [ ] } }, "CapacityestimatevaluesDeleteResponse": { "type": "object", "properties": { "updated": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149491741642" }, "team_id": { "type": "null" }, "team_membership_id": { "type": "null" }, "period_start": { "type": "null" }, "total": { "type": "number", "example": 40.0 }, "computed": { "type": "boolean", "example": true }, "ignored": { "type": "boolean", "example": false } }, "example": { "id": "6776881149491741642", "team_id": null, "team_membership_id": null, "period_start": null, "total": 40.0, "computed": true, "ignored": false } }, "example": [ { "id": "6776881149491741642", "team_id": null, "team_membership_id": null, "period_start": null, "total": 40.0, "computed": true, "ignored": false }, { "id": "6776881149493435663", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149496255620", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 5.0, "computed": true, "ignored": false } ] }, "destroyed": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149486253923" }, "team_id": { "type": "integer", "example": 949295028 }, "team_membership_id": { "type": "null" }, "period_start": { "type": "string", "example": "2019-01-01" }, "total": { "type": "number", "example": 10.0 }, "computed": { "type": "boolean", "example": false }, "ignored": { "type": "boolean", "example": false } }, "example": { "id": "6776881149486253923", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false } }, "example": [ { "id": "6776881149486253923", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false } ] } }, "example": { "updated": [ { "id": "6776881149491741642", "team_id": null, "team_membership_id": null, "period_start": null, "total": 40.0, "computed": true, "ignored": false }, { "id": "6776881149493435663", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149496255620", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 5.0, "computed": true, "ignored": false } ], "destroyed": [ { "id": "6776881149486253923", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false } ] } }, "FeaturesPostRequest": { "type": "object", "properties": { "feature": { "type": "object", "properties": { "name": { "type": "string", "example": "New name" }, "workflow_kind": { "type": "string", "example": "new" }, "workflow_status": { "type": "object", "properties": { "name": { "type": "string", "example": "Designed" } }, "example": { "name": "Designed" } }, "description": { "type": "string", "example": "

This is the description

" }, "assigned_to_user": { "type": "object", "properties": { "email": { "type": "string", "example": "no-reply@aha.io" } }, "example": { "email": "no-reply@aha.io" } } }, "example": { "name": "New name", "workflow_kind": "new", "workflow_status": { "name": "Designed" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } }, "example": { "feature": { "name": "New name", "workflow_kind": "new", "workflow_status": { "name": "Designed" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } }, "FeaturesPostResponse": { "type": "object", "properties": { "": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149483859492" }, "name": { "type": "string", "example": "A feature in project 2" }, "reference_num": { "type": "string", "example": "PRJ2-E-251" }, "initiative_reference_num": { "type": "null" }, "position": { "type": "integer", "example": 1000 }, "score": { "type": "integer", "example": 0 }, "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": "null" }, "due_date": { "type": "null" }, "product_id": { "type": "string", "example": "517761884" }, "progress": { "type": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "status_changed_on": { "type": "string", "example": "2019-01-01" }, "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": "962984386" }, "name": { "type": "string", "example": "Designed" }, "position": { "type": "integer", "example": 2 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#ecdd8f" } }, "example": { "id": "962984386", "name": "Designed", "position": 2, "complete": false, "color": "#ecdd8f" } }, "project": { "type": "object", "properties": { "id": { "type": "string", "example": "517761884" }, "reference_prefix": { "type": "string", "example": "PRJ2" }, "name": { "type": "string", "example": "Project 2" }, "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/PRJ2" } }, "example": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487582254" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149487582254", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "attachments": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/epics/PRJ2-E-251" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/epics/PRJ2-E-251" }, "release": { "type": "object", "properties": { "id": { "type": "string", "example": "1000426269" }, "reference_num": { "type": "string", "example": "PRJ2-R-1" }, "name": { "type": "string", "example": "Release 2" }, "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": "517761884" }, "integration_fields": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/releases/PRJ2-R-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } }, "example": { "id": "1000426269", "reference_num": "PRJ2-R-1", "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": "517761884", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ2-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } }, "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 } }, "features": { "type": "array", "items": { } }, "goals": { "type": "array", "items": { } }, "key_results": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 }, "score_facts": { "type": "array", "items": { } }, "tags": { "type": "array", "items": { } }, "full_tags": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "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": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } }, "example": [ { "status_id": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "_links": { "type": "array", "items": { } }, "master_feature_only_original_estimate": { "type": "null" }, "master_feature_only_remaining_estimate": { "type": "null" }, "master_feature_only_work_done": { "type": "null" }, "epic_only_original_estimate": { "type": "null" }, "epic_only_remaining_estimate": { "type": "null" }, "epic_only_work_done": { "type": "null" } }, "example": { "id": "6776881149483859492", "name": "A feature in project 2", "reference_num": "PRJ2-E-251", "initiative_reference_num": null, "position": 1000, "score": 0, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "517761884", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "id": "962984386", "name": "Designed", "position": 2, "complete": false, "color": "#ecdd8f" }, "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" }, "description": { "id": "6776881149487582254", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ2-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ2-E-251", "release": { "id": "1000426269", "reference_num": "PRJ2-R-1", "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": "517761884", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ2-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, "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 }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "_links": [ ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "example": { "": { "id": "6776881149483859492", "name": "A feature in project 2", "reference_num": "PRJ2-E-251", "initiative_reference_num": null, "position": 1000, "score": 0, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "517761884", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "id": "962984386", "name": "Designed", "position": 2, "complete": false, "color": "#ecdd8f" }, "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" }, "description": { "id": "6776881149487582254", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ2-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ2-E-251", "release": { "id": "1000426269", "reference_num": "PRJ2-R-1", "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": "517761884", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ2-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, "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 }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "_links": [ ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } }, "FeaturesGetResponse": { "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": "null" }, "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": "6776881149487303525", "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": "6776881149487303525", "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": "6776881149485217306", "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": null, "progress_source": "progress_manual", "status_changed_on": null, "created_by_user": { "id": "16338845", "name": "John Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "6776881149487303525", "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": "6776881149485217306", "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": null, "progress_source": "progress_manual", "status_changed_on": null, "created_by_user": { "id": "16338845", "name": "John Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "6776881149487303525", "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": "6776881149485217306", "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 } } }, "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 } } }, "IdeacategoriesGetResponse": { "type": "object", "properties": { "idea_categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "251347229" }, "name": { "type": "string", "example": "Usability" }, "parent_id": { "type": "null" }, "project_id": { "type": "integer", "example": 131414752 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "251347229", "name": "Usability", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "251347229", "name": "Usability", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "972845454", "name": "Hard disk drive", "parent_id": 552935478, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 3 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "example": { "idea_categories": [ { "id": "251347229", "name": "Usability", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "972845454", "name": "Hard disk drive", "parent_id": 552935478, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "IdeacommentsPostRequest": { "type": "object", "properties": { "idea_comment": { "type": "object", "properties": { "spam": { "type": "string", "example": "true" } }, "example": { "spam": "true" } } }, "example": { "idea_comment": { "spam": "true" } } }, "IdeacommentsPostResponse": { "type": "object", "properties": { "idea_comment": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149497092049" }, "idea_id": { "type": "string", "example": "58056975" }, "body": { "type": "string", "example": "

This is the comment body.

" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "visibility": { "type": "string", "example": "Visible to all ideas portal users" }, "parent_idea_comment_id": { "type": "null" }, "idea_commenter_user": { "type": "object", "properties": { "id": { "type": "string", "example": "689956296" }, "name": { "type": "string", "example": "Henry 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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "58056975" }, "reference_num": { "type": "string", "example": "PRJ1-I-1" }, "name": { "type": "string", "example": "Idea 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "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": [ ] } }, "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" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "6776881149497092049", "idea_id": "58056975", "body": "

This is the comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } } }, "example": { "idea_comment": { "id": "6776881149497092049", "idea_id": "58056975", "body": "

This is the comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } } }, "IdeacommentsGetResponse": { "type": "object", "properties": { "idea_comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "622085811" }, "idea_id": { "type": "string", "example": "58056975" }, "body": { "type": "string", "example": "This is a great idea! We'll get started right away." }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "visibility": { "type": "string", "example": "Visible to all ideas portal users" }, "parent_idea_comment_id": { "type": "null" }, "idea_commenter_user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "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" } }, "idea": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "workflow_status": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "622085811", "idea_id": "58056975", "body": "This is a great idea! We'll get started right away.", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } }, "example": [ { "id": "622085811", "idea_id": "58056975", "body": "This is a great idea! We'll get started right away.", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] }, { "id": "6776881149487056351", "idea_id": "58056975", "body": "A reply to a comment", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": 622085811, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] }, { "id": "6776881149491301288", "idea_id": "58056975", "body": "Just us employees", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to creator and employees", "parent_idea_comment_id": null, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 3 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "example": { "idea_comments": [ { "id": "622085811", "idea_id": "58056975", "body": "This is a great idea! We'll get started right away.", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] }, { "id": "6776881149487056351", "idea_id": "58056975", "body": "A reply to a comment", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": 622085811, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] }, { "id": "6776881149491301288", "idea_id": "58056975", "body": "Just us employees", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to creator and employees", "parent_idea_comment_id": null, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "IdeacommentsPutResponse": { "type": "object", "properties": { "idea_comment": { "type": "object", "properties": { "id": { "type": "string", "example": "622085811" }, "idea_id": { "type": "string", "example": "58056975" }, "body": { "type": "string", "example": "

Updated comment body.

" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "visibility": { "type": "string", "example": "Visible to all ideas portal users" }, "parent_idea_comment_id": { "type": "null" }, "idea_commenter_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" } }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "58056975" }, "reference_num": { "type": "string", "example": "PRJ1-I-1" }, "name": { "type": "string", "example": "Idea 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "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": [ ] } }, "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" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "622085811", "idea_id": "58056975", "body": "

Updated comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } } }, "example": { "idea_comment": { "id": "622085811", "idea_id": "58056975", "body": "

Updated comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } } }, "IdeavotesPostRequest": { "type": "object", "properties": { "idea_endorsement": { "type": "object", "properties": { "value": { "type": "number", "example": 123.45 } }, "example": { "value": 123.45 } } }, "example": { "idea_endorsement": { "value": 123.45 } } }, "IdeavotesPostResponse": { "type": "object", "properties": { "idea_endorsement": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149496332684" }, "idea_id": { "type": "string", "example": "140490859" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "value": { "type": "null" }, "link": { "type": "null" }, "weight": { "type": "integer", "example": 1 }, "endorsed_by_portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149488700322" }, "name": { "type": "string", "example": "no-reply@aha.io" }, "email": { "type": "string", "example": "no-reply@aha.io" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "6776881149488700322", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z" } }, "endorsed_by_idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490328278" }, "name": { "type": "string", "example": "no-reply@aha.io" }, "email": { "type": "string", "example": "no-reply@aha.io" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "title": { "type": "null" } }, "example": { "id": "6776881149490328278", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "created_at": { "type": "null" }, "updated_at": { "type": "null" }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] } }, "integration_fields": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "140490859" }, "reference_num": { "type": "string", "example": "PRJ1-I-8" }, "name": { "type": "string", "example": "Some idea name 3" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "6776881149487885666", "body": "", "editor_version": 2, "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/ideas/ideas/PRJ1-I-8" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" } }, "example": { "id": "140490859", "reference_num": "PRJ1-I-8", "name": "Some idea name 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149487885666", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-8", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" } } }, "example": { "id": "6776881149496332684", "idea_id": "140490859", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "6776881149488700322", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "6776881149490328278", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ ], "custom_fields": [ ], "idea": { "id": "140490859", "reference_num": "PRJ1-I-8", "name": "Some idea name 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149487885666", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-8", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" } } } }, "example": { "idea_endorsement": { "id": "6776881149496332684", "idea_id": "140490859", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "6776881149488700322", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "6776881149490328278", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ ], "custom_fields": [ ], "idea": { "id": "140490859", "reference_num": "PRJ1-I-8", "name": "Some idea name 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149487885666", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-8", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" } } } }, "IdeavotesGetResponse": { "type": "object", "properties": { "idea_endorsement": { "type": "object", "properties": { "id": { "type": "string", "example": "53377392" }, "idea_id": { "type": "string", "example": "58056975" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "value": { "type": "null" }, "link": { "type": "null" }, "weight": { "type": "integer", "example": 1 }, "endorsed_by_portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "646391926" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" } }, "endorsed_by_idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "1056507375" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "title": { "type": "null" } }, "example": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, "idea_organization": { "type": "object", "properties": { "id": { "type": "string", "example": "138732915" }, "name": { "type": "string", "example": "Acme" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/ideas/idea_organizations/138732915" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, "example": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, "idea_users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" } }, "example": { "id": "670061655", "first_name": "Tim", "last_name": "Smith", "email": "tim@smith.com" } }, "example": [ { "id": "670061655", "first_name": "Tim", "last_name": "Smith", "email": "tim@smith.com" }, { "id": "1056507375", "first_name": "John", "last_name": "Long", "email": "john@long.com" } ] }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490876559" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149490876559", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "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": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ] }, "custom_fields": { "type": "array", "items": { } }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "58056975" }, "reference_num": { "type": "string", "example": "PRJ1-I-1" }, "name": { "type": "string", "example": "Idea 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "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": [ ] } }, "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" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } }, "example": { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "idea_users": [ { "id": "670061655", "first_name": "Tim", "last_name": "Smith", "email": "tim@smith.com" }, { "id": "1056507375", "first_name": "John", "last_name": "Long", "email": "john@long.com" } ], "description": { "id": "6776881149490876559", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "example": { "idea_endorsement": { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "idea_users": [ { "id": "670061655", "first_name": "Tim", "last_name": "Smith", "email": "tim@smith.com" }, { "id": "1056507375", "first_name": "John", "last_name": "Long", "email": "john@long.com" } ], "description": { "id": "6776881149490876559", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "IdeavotesPutResponse": { "type": "object", "properties": { "idea_endorsement": { "type": "object", "properties": { "id": { "type": "string", "example": "53377392" }, "idea_id": { "type": "string", "example": "58056975" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "value": { "type": "null" }, "link": { "type": "null" }, "weight": { "type": "integer", "example": 1 }, "endorsed_by_portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "646391926" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" } }, "endorsed_by_idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "1056507375" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "title": { "type": "null" } }, "example": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, "idea_organization": { "type": "object", "properties": { "id": { "type": "string", "example": "138732915" }, "name": { "type": "string", "example": "Acme" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/ideas/idea_organizations/138732915" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, "example": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "created_at": { "type": "null" }, "updated_at": { "type": "null" }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] } }, "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": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "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": "6776881149489855953", "key": "vote_priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P3", "type": "string" } }, "example": [ { "id": "6776881149489855953", "key": "vote_priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P3", "type": "string" } ] }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "58056975" }, "reference_num": { "type": "string", "example": "PRJ1-I-1" }, "name": { "type": "string", "example": "Idea 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "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": [ ] } }, "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" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } }, "example": { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "6776881149489855953", "key": "vote_priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P3", "type": "string" } ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "example": { "idea_endorsement": { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "6776881149489855953", "key": "vote_priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P3", "type": "string" } ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "IdeaorganizationsGetResponse": { "type": "object", "properties": { "idea_organization": { "type": "object", "properties": { "id": { "type": "string", "example": "138732915" }, "name": { "type": "string", "example": "Acme" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/ideas/idea_organizations/138732915" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149484915034" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149484915034", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "endorsements_count": { "type": "integer", "example": 2 }, "email_domains": { "type": "string", "example": "" }, "revenue": { "type": "null" }, "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": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } }, "example": [ { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ] }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "description": { "id": "6776881149484915034", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "endorsements_count": 2, "email_domains": "", "revenue": null, "custom_fields": [ { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ], "integration_fields": [ ] } } }, "example": { "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "description": { "id": "6776881149484915034", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "endorsements_count": 2, "email_domains": "", "revenue": null, "custom_fields": [ { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ], "integration_fields": [ ] } } }, "IdeaorganizationsPostRequest": { "type": "object", "properties": { "idea_organization": { "type": "object", "properties": { "name": { "type": "string", "example": "My organization" }, "email_domains": { "type": "string", "example": "example.com, example.org" }, "revenue": { "type": "string", "example": "55000" } }, "example": { "name": "My organization", "email_domains": "example.com, example.org", "revenue": "55000" } } }, "example": { "idea_organization": { "name": "My organization", "email_domains": "example.com, example.org", "revenue": "55000" } } }, "IdeaorganizationsPutResponse": { "type": "object", "properties": { "idea_organization": { "type": "object", "properties": { "id": { "type": "string", "example": "138732915" }, "name": { "type": "string", "example": "Acme" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/ideas/idea_organizations/138732915" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "body": { "type": "string", "example": "#" }, "editor_version": { "type": "integer", "example": 2 }, "created_at": { "type": "null" }, "updated_at": { "type": "null" }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] } }, "endorsements_count": { "type": "integer", "example": 2 }, "email_domains": { "type": "string", "example": "" }, "revenue": { "type": "null" }, "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": "6776881149493996495", "key": "industry", "name": "Industry", "updatedAt": "2019-01-01T00:00:00Z", "value": "retail", "type": "string" } }, "example": [ { "id": "6776881149493996495", "key": "industry", "name": "Industry", "updatedAt": "2019-01-01T00:00:00Z", "value": "retail", "type": "string" }, { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ] }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "endorsements_count": 2, "email_domains": "", "revenue": null, "custom_fields": [ { "id": "6776881149493996495", "key": "industry", "name": "Industry", "updatedAt": "2019-01-01T00:00:00Z", "value": "retail", "type": "string" }, { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ], "integration_fields": [ ] } } }, "example": { "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "endorsements_count": 2, "email_domains": "", "revenue": null, "custom_fields": [ { "id": "6776881149493996495", "key": "industry", "name": "Industry", "updatedAt": "2019-01-01T00:00:00Z", "value": "retail", "type": "string" }, { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ], "integration_fields": [ ] } } }, "IdeaorganizationsPostResponse": { "type": "object", "properties": { "idea_organization": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149496968773" }, "name": { "type": "string", "example": "My organization" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/ideas/idea_organizations/6776881149496968773" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149489955957" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149489955957", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "created_by_user": { "type": "object", "properties": { "id": { "type": "string", "example": "1049303076" }, "name": { "type": "string", "example": "George Gently" }, "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": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "endorsements_count": { "type": "integer", "example": 0 }, "email_domains": { "type": "string", "example": "example.com, example.org" }, "revenue": { "type": "string", "example": "55000.0" }, "custom_fields": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149496968773", "name": "My organization", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/6776881149496968773", "description": { "id": "6776881149489955957", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_by_user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "endorsements_count": 0, "email_domains": "example.com, example.org", "revenue": "55000.0", "custom_fields": [ ], "integration_fields": [ ] } } }, "example": { "idea_organization": { "id": "6776881149496968773", "name": "My organization", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/6776881149496968773", "description": { "id": "6776881149489955957", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_by_user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "endorsements_count": 0, "email_domains": "example.com, example.org", "revenue": "55000.0", "custom_fields": [ ], "integration_fields": [ ] } } }, "IdeaPortalsGetResponse": { "type": "object", "properties": { "idea_portals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "297813804" }, "title": { "type": "string", "example": "Ideas 3" }, "portal_enabled": { "type": "boolean", "example": true }, "access_type": { "type": "string", "example": "public" }, "external_url": { "type": "string", "example": "https://testideaportal2.ideas.aha.io:8338/" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "297813804", "title": "Ideas 3", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal2.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "297813804", "title": "Ideas 3", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal2.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "650606523", "title": "Ideas 2", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal1.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "675900055", "title": "portal with 1 endorsement per idea", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal3.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "747493361", "title": "portal with 2 endorsements per idea", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal4.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "1070474755", "title": "Ideas 1", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 5 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 5, "total_pages": 1, "current_page": 1 } } }, "example": { "idea_portals": [ { "id": "297813804", "title": "Ideas 3", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal2.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "650606523", "title": "Ideas 2", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal1.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "675900055", "title": "portal with 1 endorsement per idea", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal3.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "747493361", "title": "portal with 2 endorsements per idea", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal4.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "1070474755", "title": "Ideas 1", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 5, "total_pages": 1, "current_page": 1 } } }, "IdeasubscriptionsPostRequest": { "type": "object", "properties": { "idea_subscription": { "type": "object", "properties": { "email": { "type": "string", "example": "username@example.com" } }, "example": { "email": "username@example.com" } } }, "example": { "idea_subscription": { "email": "username@example.com" } } }, "IdeasubscriptionsPostResponse": { "type": "object", "properties": { "idea_subscription": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149499782711" }, "idea_id": { "type": "string", "example": "58056975" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490241023" }, "name": { "type": "string", "example": "username@example.com" }, "email": { "type": "string", "example": "username@example.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "6776881149490241023", "name": "username@example.com", "email": "username@example.com", "created_at": "2019-01-01T00:00:00.000Z" } }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "58056975" }, "reference_num": { "type": "string", "example": "PRJ1-I-1" }, "name": { "type": "string", "example": "Idea 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "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": [ ] } }, "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" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } }, "example": { "id": "6776881149499782711", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "6776881149490241023", "name": "username@example.com", "email": "username@example.com", "created_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "example": { "idea_subscription": { "id": "6776881149499782711", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "6776881149490241023", "name": "username@example.com", "email": "username@example.com", "created_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "IdeasubscriptionsGetResponse": { "type": "object", "properties": { "idea_subscription": { "type": "object", "properties": { "id": { "type": "string", "example": "783147498" }, "idea_id": { "type": "string", "example": "58056975" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "646391926" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" } }, "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "58056975" }, "reference_num": { "type": "string", "example": "PRJ1-I-1" }, "name": { "type": "string", "example": "Idea 1" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "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": "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": [ ] } }, "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" } }, "example": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } }, "example": { "id": "783147498", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "example": { "idea_subscription": { "id": "783147498", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "IdeausersPostRequest": { "type": "object", "properties": { "idea_user": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Sarah" } }, "example": { "first_name": "Sarah" } } }, "example": { "idea_user": { "first_name": "Sarah" } } }, "IdeausersPostResponse": { "type": "object", "properties": { "idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149489958901" }, "name": { "type": "string", "example": "sam doe" }, "email": { "type": "string", "example": "sam.doe@example.com" }, "discovery_interview_count": { "type": "integer", "example": 0 }, "discovery_last_invite": { "type": "null" }, "discovery_last_interview": { "type": "null" }, "discovery_next_interview": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "idea_organizations": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149489958901", "name": "sam doe", "email": "sam.doe@example.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } } }, "example": { "idea_user": { "id": "6776881149489958901", "name": "sam doe", "email": "sam.doe@example.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } } }, "IdeausersGetResponse": { "type": "object", "properties": { "idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "1056507375" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "discovery_interview_count": { "type": "integer", "example": 0 }, "discovery_last_invite": { "type": "null" }, "discovery_last_interview": { "type": "null" }, "discovery_next_interview": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "idea_organizations": { "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": "6776881149490597073", "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "the value for the field", "type": "string" } }, "example": [ { "id": "6776881149490597073", "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "the value for the field", "type": "string" } ] }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ { "id": "6776881149490597073", "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "the value for the field", "type": "string" } ], "integration_fields": [ ] } } }, "example": { "idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ { "id": "6776881149490597073", "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "the value for the field", "type": "string" } ], "integration_fields": [ ] } } }, "IdeausersPutResponse": { "type": "object", "properties": { "idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "1056507375" }, "name": { "type": "string", "example": "John Long" }, "email": { "type": "string", "example": "john@long.com" }, "discovery_interview_count": { "type": "integer", "example": 0 }, "discovery_last_invite": { "type": "null" }, "discovery_last_interview": { "type": "null" }, "discovery_next_interview": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "idea_organizations": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } } }, "example": { "idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } } }, "IdeasPostRequest": { "type": "object", "properties": { "promotable_type": { "type": "string", "example": "feature" }, "release_id": { "type": "integer", "example": 278327321 } }, "example": { "promotable_type": "feature", "release_id": 278327321 } }, "IdeasPostResponse": { "type": "object", "properties": { "idea": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487483845" }, "name": { "type": "string", "example": "Comprehensive Feature Request" }, "reference_num": { "type": "string", "example": "PRJ1-I-10" }, "score": { "type": "integer", "example": 2 }, "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": 15 }, "initial_votes": { "type": "integer", "example": 15 }, "status_changed_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "3259216" }, "name": { "type": "string", "example": "New" }, "position": { "type": "integer", "example": 1 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#dce7c6" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149489364397" }, "body": { "type": "string", "example": "

Problem Statement

Users need better mobile experience

Proposed Solution

Native mobile app with offline capabilities

" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149489364397", "body": "

Problem Statement

Users need better mobile experience

Proposed Solution

Native mobile app with offline capabilities

", "editor_version": 2, "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" }, "admin_response": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149492320383" }, "body": { "type": "string", "example": "Great idea! This aligns with our mobile strategy roadmap. We'll evaluate this for Q3 implementation." }, "editor_version": { "type": "integer", "example": 2 }, "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": { } }, "responded_by_user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "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": "6776881149492320383", "body": "Great idea! This aligns with our mobile strategy roadmap. We'll evaluate this for Q3 implementation.", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ], "responded_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" } } }, "url": { "type": "string", "example": "http://company.aha.io/ideas/ideas/PRJ1-I-10" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/ideas/PRJ1-I-10" }, "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_portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "384687358" }, "name": { "type": "string", "example": "Sammy Smith" }, "email": { "type": "string", "example": "sammy@smith.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "384687358", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z" } }, "created_by_idea_user": { "type": "object", "properties": { "id": { "type": "string", "example": "244576613" }, "name": { "type": "string", "example": "Sammy Smith" }, "email": { "type": "string", "example": "sammy@smith.com" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "title": { "type": "null" } }, "example": { "id": "244576613", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, "assigned_to_user": { "type": "null" }, "endorsements_count": { "type": "integer", "example": 0 }, "comments_count": { "type": "integer", "example": 0 }, "score_facts": { "type": "array", "items": { } }, "tags": { "type": "array", "items": { "type": "string", "example": "mobile" }, "example": [ "mobile", "offline", "performance", "UX" ] }, "full_tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "6776881149483567678", "name": "performance", "color": "#e05298" } }, "example": [ { "id": "6776881149483567678", "name": "performance", "color": "#e05298" }, { "id": "6776881149486951248", "name": "UX", "color": "#a952e0" }, { "id": "6776881149488941674", "name": "mobile", "color": "#bae052" }, { "id": "6776881149490298781", "name": "offline", "color": "#9ae052" } ] }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parent_id": { "type": "null" }, "project_id": { "type": "string" }, "created_at": { "type": "string" } }, "example": { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ] }, "custom_fields": { "type": "array", "items": { } }, "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": "3259216", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } }, "example": [ { "status_id": "3259216", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "submitted_idea_portal_record_url": { "type": "string", "example": "https://testideaportal1.ideas.aha.io:8338/ideas/PRJ1-I-10" }, "integration_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149487483845", "name": "Comprehensive Feature Request", "reference_num": "PRJ1-I-10", "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "votes": 15, "initial_votes": 15, "status_changed_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149489364397", "body": "

Problem Statement

Users need better mobile experience

Proposed Solution

Native mobile app with offline capabilities

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "visibility": "Visible to all ideas portal users", "admin_response": { "id": "6776881149492320383", "body": "Great idea! This aligns with our mobile strategy roadmap. We'll evaluate this for Q3 implementation.", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ], "responded_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" } }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-10", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10", "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_portal_user": { "id": "384687358", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z" }, "created_by_idea_user": { "id": "244576613", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "assigned_to_user": null, "endorsements_count": 0, "comments_count": 0, "score_facts": [ ], "tags": [ "mobile", "offline", "performance", "UX" ], "full_tags": [ { "id": "6776881149483567678", "name": "performance", "color": "#e05298" }, { "id": "6776881149486951248", "name": "UX", "color": "#a952e0" }, { "id": "6776881149488941674", "name": "mobile", "color": "#bae052" }, { "id": "6776881149490298781", "name": "offline", "color": "#9ae052" } ], "categories": [ { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "3259216", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "submitted_idea_portal_record_url": "https://testideaportal1.ideas.aha.io:8338/ideas/PRJ1-I-10", "integration_fields": [ ] } } }, "example": { "idea": { "id": "6776881149487483845", "name": "Comprehensive Feature Request", "reference_num": "PRJ1-I-10", "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "votes": 15, "initial_votes": 15, "status_changed_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149489364397", "body": "

Problem Statement

Users need better mobile experience

Proposed Solution

Native mobile app with offline capabilities

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "visibility": "Visible to all ideas portal users", "admin_response": { "id": "6776881149492320383", "body": "Great idea! This aligns with our mobile strategy roadmap. We'll evaluate this for Q3 implementation.", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ], "responded_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" } }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-10", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10", "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_portal_user": { "id": "384687358", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z" }, "created_by_idea_user": { "id": "244576613", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "assigned_to_user": null, "endorsements_count": 0, "comments_count": 0, "score_facts": [ ], "tags": [ "mobile", "offline", "performance", "UX" ], "full_tags": [ { "id": "6776881149483567678", "name": "performance", "color": "#e05298" }, { "id": "6776881149486951248", "name": "UX", "color": "#a952e0" }, { "id": "6776881149488941674", "name": "mobile", "color": "#bae052" }, { "id": "6776881149490298781", "name": "offline", "color": "#9ae052" } ], "categories": [ { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "3259216", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "submitted_idea_portal_record_url": "https://testideaportal1.ideas.aha.io:8338/ideas/PRJ1-I-10", "integration_fields": [ ] } } }, "IdeasGetResponse": { "type": "object", "properties": { "ideas": { "type": "array", "items": { } }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 0 }, "total_pages": { "type": "integer", "example": 0 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "example": { "ideas": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "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": [ ] } } }, "IdentityprovidersGetResponse": { "type": "object", "properties": { "identity_provider": { "type": "object", "properties": { "id": { "type": "string", "example": "483954339" }, "enabled": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "notebook" }, "sso_endpoint": { "type": "string", "example": "https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "483954339", "enabled": true, "name": "notebook", "sso_endpoint": "https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } }, "example": { "identity_provider": { "id": "483954339", "enabled": true, "name": "notebook", "sso_endpoint": "https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } }, "InitiativesPostRequest": { "type": "object", "properties": { "initiative": { "type": "object", "properties": { "name": { "type": "string", "example": "Smarter initiative" } }, "example": { "name": "Smarter initiative" } } }, "example": { "initiative": { "name": "Smarter initiative" } } }, "InitiativesPostResponse": { "type": "object", "properties": { "initiative": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487133341" }, "name": { "type": "string", "example": "Assigned Initiative" }, "reference_num": { "type": "string", "example": "PRJ1-S-251" }, "status": { "type": "string", "example": "not_started" }, "effort": { "type": "integer", "example": 95 }, "value": { "type": "integer", "example": 40 }, "presented": { "type": "boolean", "example": true }, "color": { "type": "string", "example": "#397e82" }, "start_date": { "type": "null" }, "end_date": { "type": "null" }, "position": { "type": "integer", "example": 3 }, "score": { "type": "integer", "example": 2 }, "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" }, "progress": { "type": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "url": { "type": "string", "example": "http://company.aha.io/initiatives/PRJ1-S-251" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/initiatives/PRJ1-S-251" }, "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" } }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "53968949" }, "name": { "type": "string", "example": "Not Started" }, "position": { "type": "integer", "example": 1 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#dce7c6" } }, "example": { "id": "53968949", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149499189237" }, "body": { "type": "string", "example": "Initiative with assignee" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149499189237", "body": "Initiative with assignee", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "attachments": { "type": "array", "items": { } }, "assigned_to_user": { "type": "object", "properties": { "id": { "type": "string", "example": "1049303076" }, "name": { "type": "string", "example": "George Gently" }, "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": "1049303076", "name": "George Gently", "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": { "type": "integer", "example": 0 }, "goals": { "type": "array", "items": { } }, "key_results": { "type": "array", "items": { } }, "score_facts": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } }, "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": "53968949", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } }, "example": [ { "status_id": "53968949", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "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": "6776881149487133341", "name": "Assigned Initiative", "reference_num": "PRJ1-S-251", "status": "not_started", "effort": 95, "value": 40, "presented": true, "color": "#397e82", "start_date": null, "end_date": null, "position": 3, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "url": "http://company.aha.io/initiatives/PRJ1-S-251", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-251", "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": "6776881149499189237", "body": "Initiative with assignee", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "assigned_to_user": { "id": "1049303076", "name": "George Gently", "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": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ], "workflow_status_times": [ { "status_id": "53968949", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } } }, "example": { "initiative": { "id": "6776881149487133341", "name": "Assigned Initiative", "reference_num": "PRJ1-S-251", "status": "not_started", "effort": 95, "value": 40, "presented": true, "color": "#397e82", "start_date": null, "end_date": null, "position": 3, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "url": "http://company.aha.io/initiatives/PRJ1-S-251", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-251", "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": "6776881149499189237", "body": "Initiative with assignee", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "assigned_to_user": { "id": "1049303076", "name": "George Gently", "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": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ], "workflow_status_times": [ { "status_id": "53968949", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } } }, "InitiativesGetResponse": { "type": "object", "properties": { "initiative": { "type": "object", "properties": { "id": { "type": "string", "example": "423077122" }, "name": { "type": "string", "example": "Initiative 1" }, "reference_num": { "type": "string", "example": "PRJ1-S-1" }, "status": { "type": "string", "example": "not_started" }, "effort": { "type": "integer", "example": 30 }, "value": { "type": "integer", "example": 50 }, "presented": { "type": "boolean", "example": true }, "color": { "type": "string", "example": "#bada55" }, "start_date": { "type": "null" }, "end_date": { "type": "null" }, "position": { "type": "integer", "example": 1 }, "score": { "type": "integer", "example": 4 }, "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" }, "progress": { "type": "null" }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "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" }, "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" } }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "53968949" }, "name": { "type": "string", "example": "Not Started" }, "position": { "type": "integer", "example": 1 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#dce7c6" } }, "example": { "id": "53968949", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "673273729" }, "body": { "type": "string", "example": "Description of initiative 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": "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": { "type": "array", "items": { } }, "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 } }, "comments_count": { "type": "integer", "example": 1 }, "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": { } }, "score_facts": { "type": "array", "items": { } }, "features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "product_id": { "type": "string" } }, "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" } }, "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" } ] }, "master_features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" } }, "example": { "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" } }, "example": [ { "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": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" } }, "example": { "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" } }, "example": [ { "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": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "release_date": { "type": "string" }, "parking_lot": { "type": "string" }, "created_at": { "type": "string" }, "product_id": { "type": "string" }, "integration_fields": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "owner": { "type": "string" }, "project": { "type": "string" } }, "example": { "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" } } }, "example": [ { "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": { "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": "546711007", "name": "id", "value": "9913333", "integration_id": 186281709, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "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" } ] }, "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": 973371762, "key": "initiative_custom_date", "name": "Initiative custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } }, "example": [ { "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" } ] }, "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": "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": [ ] } } ], "key_results": [ ], "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" } ], "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": { "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": [ ] } } ], "key_results": [ ], "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" } ], "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" } } } }, "InitiativesPutResponse": { "type": "object", "properties": { "initiative": { "type": "object", "properties": { "id": { "type": "string", "example": "423077122" }, "name": { "type": "string", "example": "Initiative 1" }, "reference_num": { "type": "string", "example": "PRJ1-S-1" }, "status": { "type": "string", "example": "not_started" }, "effort": { "type": "integer", "example": 30 }, "value": { "type": "integer", "example": 50 }, "presented": { "type": "boolean", "example": true }, "color": { "type": "string", "example": "#bada55" }, "start_date": { "type": "null" }, "end_date": { "type": "null" }, "position": { "type": "integer", "example": 1 }, "score": { "type": "integer", "example": 4 }, "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" }, "progress": { "type": "integer", "example": 25 }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "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" }, "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" } }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "53968949" }, "name": { "type": "string", "example": "Not Started" }, "position": { "type": "integer", "example": 1 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#dce7c6" } }, "example": { "id": "53968949", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" } }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "673273729" }, "body": { "type": "string", "example": "Description of initiative 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": "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": { "type": "array", "items": { } }, "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 } }, "comments_count": { "type": "integer", "example": 1 }, "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": { } }, "score_facts": { "type": "array", "items": { } }, "features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "product_id": { "type": "string" } }, "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" } }, "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" } ] }, "master_features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" } }, "example": { "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" } }, "example": [ { "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": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" } }, "example": { "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" } }, "example": [ { "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": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "release_date": { "type": "string" }, "parking_lot": { "type": "string" }, "created_at": { "type": "string" }, "product_id": { "type": "string" }, "integration_fields": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "owner": { "type": "string" }, "project": { "type": "string" } }, "example": { "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" } } }, "example": [ { "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": { "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": "546711007", "name": "id", "value": "9913333", "integration_id": 186281709, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "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" } ] }, "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": 973371762, "key": "initiative_custom_date", "name": "Initiative custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } }, "example": [ { "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" } ] }, "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": "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": 25, "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": [ ] } } ], "key_results": [ ], "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" } ], "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": { "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": 25, "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": [ ] } } ], "key_results": [ ], "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" } ], "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" } } } }, "IntegrationchangesPostRequest": { "type": "object", "properties": { "integration_id": { "type": "integer", "example": 204584239 }, "model_class": { "type": "string", "example": "Feature" }, "model_id": { "type": "integer", "example": 1007868956 } }, "example": { "integration_id": 204584239, "model_class": "Feature", "model_id": 1007868956 } }, "IntegrationchangesPostResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "success" } }, "example": { "status": "success" } }, "IntegrationfieldsPostRequest": { "type": "object", "properties": { "integration_field": { "type": "object", "properties": { "name": { "type": "string", "example": "key" }, "value": { "type": "string", "example": "JRA-34" } }, "example": { "name": "key", "value": "JRA-34" } } }, "example": { "integration_field": { "name": "key", "value": "JRA-34" } } }, "IntegrationfieldsPostResponse": { "type": "object", "properties": { "integration_field": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149495233147" }, "name": { "type": "string", "example": "key" }, "value": { "type": "string", "example": "JRA-34" }, "integration_id": { "type": "integer", "example": 204584239 }, "service_name": { "type": "string", "example": "jira" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "integratable": { "type": "object", "properties": { "url": { "type": "string", "example": "http://company.aha.io/ideas/ideas/PRJ1-I-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/ideas/api%2Fv1%2FPRJ1-I-1" } }, "example": { "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/api%2Fv1%2FPRJ1-I-1" } } }, "example": { "id": "6776881149495233147", "name": "key", "value": "JRA-34", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z", "integratable": { "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/api%2Fv1%2FPRJ1-I-1" } } } }, "example": { "integration_field": { "id": "6776881149495233147", "name": "key", "value": "JRA-34", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z", "integratable": { "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/api%2Fv1%2FPRJ1-I-1" } } } }, "IntegrationfieldsPostResponseArrayInteger": { "type": "array", "items": { "type": "integer", "example": 907392375 }, "example": [ 907392375, 790422735 ] }, "IntegrationfieldsPostResponseArrayString": { "type": "array", "items": { "type": "string", "example": "6776881149484343025" }, "example": [ "6776881149484343025", "6776881149496067156" ] }, "IntegrationfieldsGetResponse": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "idea_endorsement": { "type": "object", "properties": { "integration_id": { "type": "string" }, "service_name": { "type": "string" }, "id": { "type": "string" }, "idea_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "value": { "type": "null" }, "link": { "type": "null" }, "weight": { "type": "string" }, "endorsed_by_portal_user": { "type": "string" }, "endorsed_by_idea_user": { "type": "string" }, "idea_organization": { "type": "string" }, "description": { "type": "string" }, "integration_fields": { "type": "string" }, "custom_fields": { "type": "string" }, "idea": { "type": "string" } }, "example": { "integration_id": 204584239, "service_name": "jira", "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149485668658", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "example": { "idea_endorsement": { "integration_id": 204584239, "service_name": "jira", "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149485668658", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } }, "example": [ { "idea_endorsement": { "integration_id": 204584239, "service_name": "jira", "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149485668658", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 1, "total_pages": 1, "current_page": 1 } } }, "example": { "records": [ { "idea_endorsement": { "integration_id": 204584239, "service_name": "jira", "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149485668658", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } }, "IntegrationsPostRequest": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "example": { "enabled": true } } }, "example": { "integration": { "enabled": true } } }, "IntegrationsPostResponse": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149497259401" }, "service_name": { "type": "string", "example": "jira" }, "template_id": { "type": "null" }, "name": { "type": "string", "example": "Jira" }, "enabled": { "type": "boolean", "example": true }, "callback_token": { "type": "string", "example": "5e0c518000b1e19f" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "last_error_at": { "type": "null" }, "last_webhook_request_at": { "type": "null" }, "url": { "type": "string", "example": "http://company.aha.io/integrations/6776881149497259401" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/integrations/6776881149497259401" }, "jql_filter": { "type": "null" }, "owner": { "type": "object", "properties": { "type": { "type": "string", "example": "Project" }, "id": { "type": "string", "example": "131414752" }, "url": { "type": "string", "example": "http://company.aha.io/projects/PRJ1" }, "resource": { "type": "string", "example": "http://company.aha.io/projects/PRJ1" } }, "example": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } }, "example": { "id": "6776881149497259401", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "5e0c518000b1e19f", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/6776881149497259401", "resource": "http://company.aha.io/api/v1/integrations/6776881149497259401", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } }, "example": { "integration": { "id": "6776881149497259401", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "5e0c518000b1e19f", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/6776881149497259401", "resource": "http://company.aha.io/api/v1/integrations/6776881149497259401", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } }, "IntegrationsGetResponse": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "id": { "type": "string", "example": "204584239" }, "service_name": { "type": "string", "example": "jira" }, "template_id": { "type": "null" }, "name": { "type": "string", "example": "Jira" }, "enabled": { "type": "boolean", "example": true }, "callback_token": { "type": "string", "example": "22b7893e7fa1c4c60847090f78fbf0ec" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "last_error_at": { "type": "null" }, "last_webhook_request_at": { "type": "null" }, "url": { "type": "string", "example": "http://company.aha.io/integrations/204584239" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/integrations/204584239" }, "jql_filter": { "type": "null" }, "owner": { "type": "object", "properties": { "type": { "type": "string", "example": "Project" }, "id": { "type": "string", "example": "131414752" }, "url": { "type": "string", "example": "http://company.aha.io/projects/PRJ1" }, "resource": { "type": "string", "example": "http://company.aha.io/projects/PRJ1" } }, "example": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } }, "example": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } }, "example": { "integration": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } }, "IntegrationsPutResponse": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "id": { "type": "string", "example": "204584239" }, "service_name": { "type": "string", "example": "jira" }, "template_id": { "type": "null" }, "name": { "type": "string", "example": "Jira" }, "enabled": { "type": "boolean", "example": true }, "callback_token": { "type": "string", "example": "22b7893e7fa1c4c60847090f78fbf0ec" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "last_error_at": { "type": "null" }, "last_webhook_request_at": { "type": "null" }, "url": { "type": "string", "example": "http://company.aha.io/integrations/204584239" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/integrations/204584239" }, "jql_filter": { "type": "null" }, "owner": { "type": "object", "properties": { "type": { "type": "string", "example": "Project" }, "id": { "type": "string", "example": "131414752" }, "url": { "type": "string", "example": "http://company.aha.io/projects/PRJ1" }, "resource": { "type": "string", "example": "http://company.aha.io/projects/PRJ1" } }, "example": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } }, "example": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } }, "example": { "integration": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } }, "KeyresultsGetResponse": { "type": "object", "properties": { "key_result": { "type": "object", "properties": { "id": { "type": "string", "example": "631791848" }, "name": { "type": "string", "example": "KR 1" }, "reference_num": { "type": "string", "example": "DEMOENT-G-1-KR-1" }, "position": { "type": "integer", "example": 2 }, "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" }, "target_metric": { "type": "string", "example": "100%" }, "starting_metric": { "type": "string", "example": "5%" }, "current_metric": { "type": "string", "example": "20%" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149495921680" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149495921680", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "assigned_to_user": { "type": "null" }, "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" } }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "6776881149495921680", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ ] } } }, "example": { "key_result": { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "6776881149495921680", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ ] } } }, "KeyresultsPostRequest": { "type": "object", "properties": { "key_result": { "type": "object", "properties": { "name": { "type": "string", "example": "New name" }, "workflow_status": { "type": "object", "properties": { "name": { "type": "string", "example": "On track" } }, "example": { "name": "On track" } }, "description": { "type": "string", "example": "

This is the description

" }, "assigned_to_user": { "type": "object", "properties": { "email": { "type": "string", "example": "no-reply@aha.io" } }, "example": { "email": "no-reply@aha.io" } } }, "example": { "name": "New name", "workflow_status": { "name": "On track" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } }, "example": { "key_result": { "name": "New name", "workflow_status": { "name": "On track" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } }, "KeyresultsPutResponse": { "type": "object", "properties": { "key_result": { "type": "object", "properties": { "id": { "type": "string", "example": "631791848" }, "name": { "type": "string", "example": "KR 1" }, "reference_num": { "type": "string", "example": "DEMOENT-G-1-KR-1" }, "position": { "type": "integer", "example": 2 }, "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" }, "target_metric": { "type": "string", "example": "100%" }, "starting_metric": { "type": "string", "example": "5%" }, "current_metric": { "type": "string", "example": "20%" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "body": { "type": "string", "example": "#" }, "editor_version": { "type": "integer", "example": 2 }, "created_at": { "type": "null" }, "updated_at": { "type": "null" }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] } }, "assigned_to_user": { "type": "null" }, "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" } }, "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": "6776881149496972898", "key": "stretch_goal", "name": "Stretch goal", "updatedAt": "2019-01-01T00:00:00Z", "value": "my metric", "type": "string" } }, "example": [ { "id": "6776881149496972898", "key": "stretch_goal", "name": "Stretch goal", "updatedAt": "2019-01-01T00:00:00Z", "value": "my metric", "type": "string" } ] } }, "example": { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ { "id": "6776881149496972898", "key": "stretch_goal", "name": "Stretch goal", "updatedAt": "2019-01-01T00:00:00Z", "value": "my metric", "type": "string" } ] } } }, "example": { "key_result": { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ { "id": "6776881149496972898", "key": "stretch_goal", "name": "Stretch goal", "updatedAt": "2019-01-01T00:00:00Z", "value": "my metric", "type": "string" } ] } } }, "KeyresultsPostResponse": { "type": "object", "properties": { "key_result": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149483625245" }, "name": { "type": "string", "example": "New name" }, "reference_num": { "type": "string", "example": "DEMOENT-G-1-KR-1" }, "position": { "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" }, "progress": { "type": "integer", "example": 0 }, "target_metric": { "type": "null" }, "starting_metric": { "type": "null" }, "current_metric": { "type": "null" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149493544532" }, "body": { "type": "string", "example": "

This is the description

" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149493544532", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "assigned_to_user": { "type": "object", "properties": { "id": { "type": "string", "example": "689956296" }, "name": { "type": "string", "example": "Henry 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" }, "default_assignee": { "type": "boolean", "example": false } }, "example": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": false } }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "76947914" }, "name": { "type": "string", "example": "On Track" }, "position": { "type": "integer", "example": 2 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#ecdd8f" } }, "example": { "id": "76947914", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" } }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149483625245", "name": "New name", "reference_num": "DEMOENT-G-1-KR-1", "position": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": 0, "target_metric": null, "starting_metric": null, "current_metric": null, "description": { "id": "6776881149493544532", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": false }, "workflow_status": { "id": "76947914", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, "custom_fields": [ ] } } }, "example": { "key_result": { "id": "6776881149483625245", "name": "New name", "reference_num": "DEMOENT-G-1-KR-1", "position": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": 0, "target_metric": null, "starting_metric": null, "current_metric": null, "description": { "id": "6776881149493544532", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": false }, "workflow_status": { "id": "76947914", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, "custom_fields": [ ] } } }, "RollupreleasesGetResponse": { "type": "object", "properties": { "roll_up_releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149485843899" }, "reference_num": { "type": "string", "example": "PL1-R-3" }, "name": { "type": "string", "example": "My release 002" }, "start_date": { "type": "string", "example": "2019-01-01" }, "release_date": { "type": "string", "example": "2019-01-01" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/master_releases/PL1-R-3" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PL1-R-3" } }, "example": { "id": "6776881149485843899", "reference_num": "PL1-R-3", "name": "My release 002", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-3", "resource": "http://company.aha.io/api/v1/releases/PL1-R-3" } }, "example": [ { "id": "6776881149485843899", "reference_num": "PL1-R-3", "name": "My release 002", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-3", "resource": "http://company.aha.io/api/v1/releases/PL1-R-3" }, { "id": "6776881149489814133", "reference_num": "PL1-R-2", "name": "My release 001", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-2", "resource": "http://company.aha.io/api/v1/releases/PL1-R-2" } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 2 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 2, "total_pages": 1, "current_page": 1 } } }, "example": { "roll_up_releases": [ { "id": "6776881149485843899", "reference_num": "PL1-R-3", "name": "My release 002", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-3", "resource": "http://company.aha.io/api/v1/releases/PL1-R-3" }, { "id": "6776881149489814133", "reference_num": "PL1-R-2", "name": "My release 001", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-2", "resource": "http://company.aha.io/api/v1/releases/PL1-R-2" } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } }, "RollupreleasesPostRequest": { "type": "object", "properties": { "roll_up_release": { "type": "object", "properties": { "name": { "type": "string", "example": "Different release" } }, "example": { "name": "Different release" } } }, "example": { "roll_up_release": { "name": "Different release" } } }, "RollupreleasesPostResponse": { "type": "object", "properties": { "roll_up_release": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490916934" }, "reference_num": { "type": "string", "example": "PL1-R-2" }, "name": { "type": "string", "example": "Roll up release" }, "start_date": { "type": "string", "example": "2019-01-01" }, "release_date": { "type": "string", "example": "2019-01-01" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/master_releases/PL1-R-2" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PL1-R-2" } }, "example": { "id": "6776881149490916934", "reference_num": "PL1-R-2", "name": "Roll up release", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-2", "resource": "http://company.aha.io/api/v1/releases/PL1-R-2" } } }, "example": { "roll_up_release": { "id": "6776881149490916934", "reference_num": "PL1-R-2", "name": "Roll up release", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-2", "resource": "http://company.aha.io/api/v1/releases/PL1-R-2" } } }, "RollupreleasesPutResponse": { "type": "object", "properties": { "roll_up_release": { "type": "object", "properties": { "id": { "type": "string", "example": "292454904" }, "reference_num": { "type": "string", "example": "PRJ1-MR-1" }, "name": { "type": "string", "example": "Roll-up Release 1" }, "start_date": { "type": "string", "example": "2019-01-01" }, "release_date": { "type": "string", "example": "2019-01-01" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/master_releases/PRJ1-MR-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } }, "example": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } } }, "example": { "roll_up_release": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } } }, "MeGetResponse": { "type": "object", "properties": { "assigned": { "type": "array", "items": { } } }, "example": { "assigned": [ ] } }, "NotesPostRequest": { "type": "object", "properties": { "page": { "type": "object", "properties": { "name": { "type": "string", "example": "New name for the note" }, "description_attributes": { "type": "object", "properties": { "body": { "type": "string", "example": "

An awesome new note

" } }, "example": { "body": "

An awesome new note

" } } }, "example": { "name": "New name for the note", "description_attributes": { "body": "

An awesome new note

" } } } }, "example": { "page": { "name": "New name for the note", "description_attributes": { "body": "

An awesome new note

" } } } }, "NotesPostResponse": { "type": "object", "properties": { "page": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149490967959" }, "name": { "type": "null" }, "title": { "type": "string", "example": "PRJ1-N-11 Untitled" }, "document_title": { "type": "string", "example": "Untitled | Aha!" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "reference_num": { "type": "string", "example": "PRJ1-N-11" }, "emoji_value": { "type": "null" }, "document_type": { "type": "integer", "example": 80 }, "document_type_name": { "type": "string", "example": "internal_link" }, "editor_width": { "type": "null" }, "type_name": { "type": "string", "example": "internal link" }, "position": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "location": { "type": "null" }, "edit_locked": { "type": "boolean", "example": false }, "linked_record_id": { "type": "integer", "example": 1007868956 }, "linked_record_type": { "type": "string", "example": "Feature" }, "url": { "type": "string", "example": "http://company.aha.io/pages/PRJ1-N-11" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/pages/PRJ1-N-11" }, "product_id": { "type": "string", "example": "131414752" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149488431496" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149488431496", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parent_id": { "type": "null" }, "tags": { "type": "array", "items": { } }, "full_tags": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149490967959", "name": null, "title": "PRJ1-N-11 Untitled", "document_title": "Untitled | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-11", "emoji_value": null, "document_type": 80, "document_type_name": "internal_link", "editor_width": null, "type_name": "internal link", "position": null, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "linked_record_id": 1007868956, "linked_record_type": "Feature", "url": "http://company.aha.io/pages/PRJ1-N-11", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-11", "product_id": "131414752", "description": { "id": "6776881149488431496", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "parent_id": null, "tags": [ ], "full_tags": [ ], "comments_count": 0, "custom_fields": [ ] } } }, "example": { "page": { "id": "6776881149490967959", "name": null, "title": "PRJ1-N-11 Untitled", "document_title": "Untitled | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-11", "emoji_value": null, "document_type": 80, "document_type_name": "internal_link", "editor_width": null, "type_name": "internal link", "position": null, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "linked_record_id": 1007868956, "linked_record_type": "Feature", "url": "http://company.aha.io/pages/PRJ1-N-11", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-11", "product_id": "131414752", "description": { "id": "6776881149488431496", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "parent_id": null, "tags": [ ], "full_tags": [ ], "comments_count": 0, "custom_fields": [ ] } } }, "NotesGetResponse": { "type": "object", "properties": { "page": { "type": "object", "properties": { "id": { "type": "string", "example": "1051981226" }, "name": { "type": "string", "example": "Title of the first note" }, "title": { "type": "string", "example": "PRJ1-N-1 Title of the first note" }, "document_title": { "type": "string", "example": "Title of the first note | Aha!" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "reference_num": { "type": "string", "example": "PRJ1-N-1" }, "emoji_value": { "type": "null" }, "document_type": { "type": "integer", "example": 10 }, "document_type_name": { "type": "string", "example": "note" }, "editor_width": { "type": "string", "example": "FULL" }, "type_name": { "type": "string", "example": "note" }, "position": { "type": "integer", "example": 100000 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "location": { "type": "null" }, "edit_locked": { "type": "boolean", "example": false }, "url": { "type": "string", "example": "http://company.aha.io/pages/PRJ1-N-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/pages/PRJ1-N-1" }, "product_id": { "type": "string", "example": "131414752" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "669149001" }, "body": { "type": "string", "example": "Description 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": { } } }, "example": { "id": "669149001", "body": "Description of note 1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parent_id": { "type": "null" }, "tags": { "type": "array", "items": { "type": "string", "example": "Infrastructure" }, "example": [ "Infrastructure", "Sales" ] }, "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" }, { "id": 926098016, "name": "Sales", "color": "#e0da52" } ] }, "comments_count": { "type": "integer", "example": 0 }, "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": 416524155, "key": "review_date", "name": "Review date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } }, "example": [ { "id": 416524155, "key": "review_date", "name": "Review date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ] } }, "example": { "id": "1051981226", "name": "Title of the first note", "title": "PRJ1-N-1 Title of the first note", "document_title": "Title of the first note | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-1", "emoji_value": null, "document_type": 10, "document_type_name": "note", "editor_width": "FULL", "type_name": "note", "position": 100000, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "url": "http://company.aha.io/pages/PRJ1-N-1", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-1", "product_id": "131414752", "description": { "id": "669149001", "body": "Description of note 1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "parent_id": null, "tags": [ "Infrastructure", "Sales" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" }, { "id": 926098016, "name": "Sales", "color": "#e0da52" } ], "comments_count": 0, "custom_fields": [ { "id": 416524155, "key": "review_date", "name": "Review date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ] } } }, "example": { "page": { "id": "1051981226", "name": "Title of the first note", "title": "PRJ1-N-1 Title of the first note", "document_title": "Title of the first note | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-1", "emoji_value": null, "document_type": 10, "document_type_name": "note", "editor_width": "FULL", "type_name": "note", "position": 100000, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "url": "http://company.aha.io/pages/PRJ1-N-1", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-1", "product_id": "131414752", "description": { "id": "669149001", "body": "Description of note 1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "parent_id": null, "tags": [ "Infrastructure", "Sales" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" }, { "id": 926098016, "name": "Sales", "color": "#e0da52" } ], "comments_count": 0, "custom_fields": [ { "id": 416524155, "key": "review_date", "name": "Review date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ] } } }, "NotesPutResponse": { "type": "object", "properties": { "page": { "type": "object", "properties": { "id": { "type": "string", "example": "280859787" }, "name": { "type": "string", "example": "Build products customers love" }, "title": { "type": "string", "example": "PRJ1-N-6 Build products customers love" }, "document_title": { "type": "string", "example": "Build products customers love | Aha!" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "reference_num": { "type": "string", "example": "PRJ1-N-6" }, "emoji_value": { "type": "null" }, "document_type": { "type": "integer", "example": 70 }, "document_type_name": { "type": "string", "example": "external_link" }, "editor_width": { "type": "null" }, "type_name": { "type": "string", "example": "external link" }, "position": { "type": "integer", "example": 500000 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "location": { "type": "null" }, "edit_locked": { "type": "boolean", "example": false }, "external_url": { "type": "string", "example": "https://www.aha.io/solutions/product" }, "url": { "type": "string", "example": "http://company.aha.io/pages/PRJ1-N-6" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/pages/PRJ1-N-6" }, "product_id": { "type": "string", "example": "131414752" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "" }, "body": { "type": "string", "example": "#" }, "editor_version": { "type": "integer", "example": 2 }, "created_at": { "type": "null" }, "updated_at": { "type": "null" }, "attachments": { "type": "array", "items": { } } }, "example": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] } }, "parent_id": { "type": "null" }, "tags": { "type": "array", "items": { } }, "full_tags": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "280859787", "name": "Build products customers love", "title": "PRJ1-N-6 Build products customers love", "document_title": "Build products customers love | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-6", "emoji_value": null, "document_type": 70, "document_type_name": "external_link", "editor_width": null, "type_name": "external link", "position": 500000, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "external_url": "https://www.aha.io/solutions/product", "url": "http://company.aha.io/pages/PRJ1-N-6", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-6", "product_id": "131414752", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "parent_id": null, "tags": [ ], "full_tags": [ ], "comments_count": 0, "custom_fields": [ ] } } }, "example": { "page": { "id": "280859787", "name": "Build products customers love", "title": "PRJ1-N-6 Build products customers love", "document_title": "Build products customers love | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-6", "emoji_value": null, "document_type": 70, "document_type_name": "external_link", "editor_width": null, "type_name": "external link", "position": 500000, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "external_url": "https://www.aha.io/solutions/product", "url": "http://company.aha.io/pages/PRJ1-N-6", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-6", "product_id": "131414752", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "parent_id": null, "tags": [ ], "full_tags": [ ], "comments_count": 0, "custom_fields": [ ] } } }, "PaidSeatGroupsGetResponse": { "type": "object", "properties": { "paid_seat_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "354640896" }, "name": { "type": "string", "example": "Group 3" }, "administrators": { "type": "array", "items": { } }, "capacity": { "type": "integer", "example": 2 }, "allocated_seats": { "type": "integer", "example": 0 }, "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": "6776881149498351732", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "354640896", "name": "Group 3", "administrators": [ ], "capacity": 2, "allocated_seats": 0, "description": { "id": "6776881149498351732", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "354640896", "name": "Group 3", "administrators": [ ], "capacity": 2, "allocated_seats": 0, "description": { "id": "6776881149498351732", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 20, "allocated_seats": 2, "description": { "id": "6776881149487500319", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "id": "992805589", "name": "Group 1", "administrators": [ { "id": "373433676", "name": "Jim Jingles", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 21, "allocated_seats": 1, "description": { "id": "6776881149492142258", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ] } }, "example": { "paid_seat_groups": [ { "id": "354640896", "name": "Group 3", "administrators": [ ], "capacity": 2, "allocated_seats": 0, "description": { "id": "6776881149498351732", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 20, "allocated_seats": 2, "description": { "id": "6776881149487500319", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "id": "992805589", "name": "Group 1", "administrators": [ { "id": "373433676", "name": "Jim Jingles", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 21, "allocated_seats": 1, "description": { "id": "6776881149492142258", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ] } }, "PaidSeatGroupsPostRequest": { "type": "object", "properties": { "user_id": { "type": "integer", "example": 1049303076 }, "remove": { "type": "null" } }, "example": { "user_id": 1049303076, "remove": null } }, "PaidSeatGroupsPutResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "572805993" }, "name": { "type": "string", "example": "Group 2" }, "administrators": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "82352673" }, "name": { "type": "string", "example": "Bob 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": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ] }, "capacity": { "type": "integer", "example": 3 }, "allocated_seats": { "type": "integer", "example": 2 }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149486533886" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149486533886", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 3, "allocated_seats": 2, "description": { "id": "6776881149486533886", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "PaidSeatGroupsPostResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "572805993" }, "name": { "type": "string", "example": "Group 2" }, "administrators": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "82352673" }, "name": { "type": "string", "example": "Bob 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": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ] }, "capacity": { "type": "integer", "example": 20 }, "allocated_seats": { "type": "integer", "example": 2 }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149483785369" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149483785369", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 20, "allocated_seats": 2, "description": { "id": "6776881149483785369", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, "PersonasPostRequest": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "name": { "type": "string", "example": "Julie" } }, "example": { "name": "Julie" } } }, "example": { "persona": { "name": "Julie" } } }, "PersonasPostResponse": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149484114529" }, "name": { "type": "string", "example": "John" }, "color": { "type": "integer", "example": 13421772 }, "occupation": { "type": "null" }, "quote": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/personas/PRJ1-P-1" }, "resource": { "type": "string", "example": "http://company.aha.io/personas/PRJ1-P-1" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "6776881149484114529", "name": "John", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PRJ1-P-1", "resource": "http://company.aha.io/personas/PRJ1-P-1", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "persona": { "id": "6776881149484114529", "name": "John", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PRJ1-P-1", "resource": "http://company.aha.io/personas/PRJ1-P-1", "custom_fields": [ ], "comments_count": 0 } } }, "PersonasGetResponse": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "id": { "type": "string", "example": "344093881" }, "name": { "type": "string", "example": "Jane the athlete" }, "color": { "type": "integer", "example": 13421772 }, "occupation": { "type": "null" }, "quote": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/personas/PROD-P-1" }, "resource": { "type": "string", "example": "http://company.aha.io/personas/PROD-P-1" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "344093881", "name": "Jane the athlete", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PROD-P-1", "resource": "http://company.aha.io/personas/PROD-P-1", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "persona": { "id": "344093881", "name": "Jane the athlete", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PROD-P-1", "resource": "http://company.aha.io/personas/PROD-P-1", "custom_fields": [ ], "comments_count": 0 } } }, "PersonasPutResponse": { "type": "object", "properties": { "persona": { "type": "object", "properties": { "id": { "type": "string", "example": "344093881" }, "name": { "type": "string", "example": "Julie" }, "color": { "type": "integer", "example": 13421772 }, "occupation": { "type": "null" }, "quote": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/personas/PROD-P-1" }, "resource": { "type": "string", "example": "http://company.aha.io/personas/PROD-P-1" }, "custom_fields": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "344093881", "name": "Julie", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PROD-P-1", "resource": "http://company.aha.io/personas/PROD-P-1", "custom_fields": [ ], "comments_count": 0 } } }, "example": { "persona": { "id": "344093881", "name": "Julie", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PROD-P-1", "resource": "http://company.aha.io/personas/PROD-P-1", "custom_fields": [ ], "comments_count": 0 } } }, "IdeasportalusersubscriptionsGetResponse": { "type": "object", "properties": { "portal_user_subscriptions": { "type": "object", "properties": { "preferences": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" } }, "example": { "type": "project", "id": 131414752 } }, "example": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } }, "example": { "preferences": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } } }, "example": { "portal_user_subscriptions": { "preferences": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } } }, "IdeasportalusersubscriptionsPostRequest": { "type": "object", "properties": { "portal_user_subscriptions": { "type": "object", "properties": { "preferences": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "project" }, "id": { "type": "integer", "example": 131414752 } }, "example": { "type": "project", "id": 131414752 } }, "example": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } }, "example": { "preferences": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } } }, "example": { "portal_user_subscriptions": { "preferences": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } } }, "IdeasportalusersubscriptionsPostResponse": { "type": "object", "properties": { "portal_user_subscriptions": { "type": "object", "properties": { "preferences": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" } }, "example": { "type": "category", "id": 251347229 } }, "example": [ { "type": "category", "id": 251347229 }, { "type": "category", "id": 552935478 } ] } }, "example": { "preferences": [ { "type": "category", "id": 251347229 }, { "type": "category", "id": 552935478 } ] } } }, "example": { "portal_user_subscriptions": { "preferences": [ { "type": "category", "id": 251347229 }, { "type": "category", "id": 552935478 } ] } } }, "IdeasportalusersPostRequest": { "type": "object", "properties": { "portal_user": { "type": "object", "properties": { "first_name": { "type": "string", "example": "Sarah" } }, "example": { "first_name": "Sarah" } } }, "example": { "portal_user": { "first_name": "Sarah" } } }, "IdeasportalusersPostResponse": { "type": "object", "properties": { "portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149497060074" }, "email": { "type": "string", "example": "sam.doe@example.com" }, "first_name": { "type": "string", "example": "sam" }, "last_name": { "type": "string", "example": "doe" }, "enabled": { "type": "boolean", "example": true }, "verified": { "type": "boolean", "example": false }, "employee": { "type": "boolean", "example": true }, "max_endorsements_override": { "type": "null" }, "idea_user_id": { "type": "string", "example": "6776881149491801214" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "unsubscribed": { "type": "boolean", "example": false }, "unsubscribed_from_weekly_emails": { "type": "null" } }, "example": { "id": "6776881149497060074", "email": "sam.doe@example.com", "first_name": "sam", "last_name": "doe", "enabled": true, "verified": false, "employee": true, "max_endorsements_override": null, "idea_user_id": "6776881149491801214", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } } }, "example": { "portal_user": { "id": "6776881149497060074", "email": "sam.doe@example.com", "first_name": "sam", "last_name": "doe", "enabled": true, "verified": false, "employee": true, "max_endorsements_override": null, "idea_user_id": "6776881149491801214", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } } }, "IdeasportalusersGetResponse": { "type": "object", "properties": { "portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "646391926" }, "email": { "type": "string", "example": "john@long.com" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Long" }, "enabled": { "type": "boolean", "example": true }, "verified": { "type": "boolean", "example": false }, "employee": { "type": "boolean", "example": false }, "max_endorsements_override": { "type": "null" }, "idea_user_id": { "type": "string", "example": "1056507375" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "unsubscribed": { "type": "boolean", "example": false }, "unsubscribed_from_weekly_emails": { "type": "null" } }, "example": { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } } }, "example": { "portal_user": { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } } }, "IdeasportalusersPutResponse": { "type": "object", "properties": { "portal_user": { "type": "object", "properties": { "id": { "type": "string", "example": "646391926" }, "email": { "type": "string", "example": "john@long.com" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Long" }, "enabled": { "type": "boolean", "example": true }, "verified": { "type": "boolean", "example": false }, "employee": { "type": "boolean", "example": false }, "max_endorsements_override": { "type": "null" }, "idea_user_id": { "type": "string", "example": "1056507375" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "unsubscribed": { "type": "boolean", "example": true }, "unsubscribed_from_weekly_emails": { "type": "boolean", "example": true } }, "example": { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": true, "unsubscribed_from_weekly_emails": true } } }, "example": { "portal_user": { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": true, "unsubscribed_from_weekly_emails": true } } }, "ProductsPostRequest": { "type": "object", "properties": { "product": { "type": "object", "properties": { "name": { "type": "string", "example": "New Product" }, "description": { "type": "string", "example": "An amazing new product" }, "prefix": { "type": "string", "example": "NEWPRODUCT" } }, "example": { "name": "New Product", "description": "An amazing new product", "prefix": "NEWPRODUCT" } } }, "example": { "product": { "name": "New Product", "description": "An amazing new product", "prefix": "NEWPRODUCT" } } }, "ProductsPostResponse": { "type": "object", "properties": { "product": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149497073946" }, "reference_prefix": { "type": "string", "example": "NEWPRODUCT" }, "name": { "type": "string", "example": "New Product Line" }, "product_line": { "type": "boolean", "example": true }, "product_line_type": { "type": "string", "example": "a new product line type" }, "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": "6776881149488051949" }, "body": { "type": "string", "example": "An amazing new product line" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149488051949", "body": "An amazing new product line", "editor_version": 2, "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/NEWPRODUCT" }, "resource": { "type": "string", "example": "http://company.aha.io/projects/NEWPRODUCT" }, "children": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "screen_definition_ids": { "type": "object", "properties": { }, "example": { } }, "screen_definitions": { "type": "array", "items": { } }, "has_ideas": { "type": "boolean", "example": false }, "has_master_features": { "type": "boolean", "example": true }, "has_epics": { "type": "boolean", "example": true }, "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": 845522269 }, "name": { "type": "string", "example": "Example product feature workflow" }, "statusable_type": { "type": "string", "example": "Feature" }, "workflow_type": { "type": "string", "example": "requirement" } }, "example": { "id": 845522269, "name": "Example product feature workflow", "statusable_type": "Feature", "workflow_type": "requirement" } }, "feature_workflow": { "type": "object", "properties": { "id": { "type": "integer", "example": 845522269 }, "name": { "type": "string", "example": "Example product feature workflow" }, "statusable_type": { "type": "string", "example": "Feature" }, "workflow_type": { "type": "string", "example": "feature" } }, "example": { "id": 845522269, "name": "Example 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": 845522269 }, "name": { "type": "string", "example": "Example product feature workflow" }, "statusable_type": { "type": "string", "example": "Feature" }, "workflow_type": { "type": "string", "example": "epic" } }, "example": { "id": 845522269, "name": "Example 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": 883066232 }, "name": { "type": "string", "example": "Account goal workflow" }, "statusable_type": { "type": "string", "example": "StrategicImperative" }, "workflow_type": { "type": "string", "example": "key_result" } }, "example": { "id": 883066232, "name": "Account goal workflow", "statusable_type": "StrategicImperative", "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": "6776881149497073946", "reference_prefix": "NEWPRODUCT", "name": "New Product Line", "product_line": true, "product_line_type": "a new product line type", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": { "id": "6776881149488051949", "body": "An amazing new product line", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/projects/NEWPRODUCT", "resource": "http://company.aha.io/projects/NEWPRODUCT", "children": [ ], "custom_fields": [ ], "screen_definition_ids": { }, "screen_definitions": [ ], "has_ideas": false, "has_master_features": true, "has_epics": true, "release_workflow": { "id": 717623509, "name": "Account product release workflow", "statusable_type": "Release", "workflow_type": "release" }, "requirement_workflow": { "id": 845522269, "name": "Example product feature workflow", "statusable_type": "Feature", "workflow_type": "requirement" }, "feature_workflow": { "id": 845522269, "name": "Example 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": 845522269, "name": "Example 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": 883066232, "name": "Account goal workflow", "statusable_type": "StrategicImperative", "workflow_type": "key_result" }, "capacity_planning_enabled": false, "default_capacity_units": 10, "enhanced_capacity_planning_enabled": false, "workspace_type": "product_workspace" } } }, "example": { "product": { "id": "6776881149497073946", "reference_prefix": "NEWPRODUCT", "name": "New Product Line", "product_line": true, "product_line_type": "a new product line type", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": { "id": "6776881149488051949", "body": "An amazing new product line", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/projects/NEWPRODUCT", "resource": "http://company.aha.io/projects/NEWPRODUCT", "children": [ ], "custom_fields": [ ], "screen_definition_ids": { }, "screen_definitions": [ ], "has_ideas": false, "has_master_features": true, "has_epics": true, "release_workflow": { "id": 717623509, "name": "Account product release workflow", "statusable_type": "Release", "workflow_type": "release" }, "requirement_workflow": { "id": 845522269, "name": "Example product feature workflow", "statusable_type": "Feature", "workflow_type": "requirement" }, "feature_workflow": { "id": 845522269, "name": "Example 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": 845522269, "name": "Example 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": 883066232, "name": "Account goal workflow", "statusable_type": "StrategicImperative", "workflow_type": "key_result" }, "capacity_planning_enabled": false, "default_capacity_units": 10, "enhanced_capacity_planning_enabled": false, "workspace_type": "product_workspace" } } }, "ProductsGetResponse": { "type": "object", "properties": { "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 }, "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": "Project 1", "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": "Project 1", "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" } } }, "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" } } }, "RecordlinksGetResponse": { "type": "object", "properties": { "record_link": { "type": "object", "properties": { "id": { "type": "integer", "example": 170959948 }, "link_type": { "type": "string", "example": "Depends on" }, "link_type_id": { "type": "integer", "example": 20 }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "parent_record_type": { "type": "string", "example": "feature" }, "parent_record_id": { "type": "integer", "example": 1007868956 }, "child_record_type": { "type": "string", "example": "feature" }, "child_record_id": { "type": "integer", "example": 622562724 }, "parent": { "type": "boolean", "example": true }, "parent_record": { "type": "object", "properties": { "record_type": { "type": "string", "example": "feature" }, "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": { "record_type": "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" } }, "child_record": { "type": "object", "properties": { "record_type": { "type": "string", "example": "feature" }, "id": { "type": "string", "example": "622562724" }, "reference_num": { "type": "string", "example": "PRJ1-2" }, "name": { "type": "string", "example": "Another Feature" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/features/PRJ1-2" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/features/PRJ1-2" }, "product_id": { "type": "string", "example": "131414752" } }, "example": { "record_type": "feature", "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": { "id": 170959948, "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record_type": "feature", "parent_record_id": 1007868956, "child_record_type": "feature", "child_record_id": 622562724, "parent": true, "parent_record": { "record_type": "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" }, "child_record": { "record_type": "feature", "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": { "record_link": { "id": 170959948, "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record_type": "feature", "parent_record_id": 1007868956, "child_record_type": "feature", "child_record_id": 622562724, "parent": true, "parent_record": { "record_type": "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" }, "child_record": { "record_type": "feature", "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" } } } }, "RecordlinksPostRequest": { "type": "object", "properties": { "record_link": { "type": "object", "properties": { "record_type": { "type": "string", "example": "feature" }, "record_id": { "type": "integer", "example": 303873333 }, "link_type": { "type": "integer", "example": 10 } }, "example": { "record_type": "feature", "record_id": 303873333, "link_type": 10 } } }, "example": { "record_link": { "record_type": "feature", "record_id": 303873333, "link_type": 10 } } }, "ReleasephasesGetResponse": { "type": "object", "properties": { "release_phases": { "type": "array", "items": { "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": [ ] } } }, "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": [ ] } }, { "id": "405824017", "name": "Beta", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "965145324", "body": "Description of release phase 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "792154778", "name": "Beta [2]", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149487000230", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "827574075", "name": "Gamma", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149494371573", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 4 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 4, "total_pages": 1, "current_page": 1 } } }, "example": { "release_phases": [ { "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": [ ] } }, { "id": "405824017", "name": "Beta", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "965145324", "body": "Description of release phase 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "792154778", "name": "Beta [2]", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149487000230", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "827574075", "name": "Gamma", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149494371573", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "pagination": { "total_records": 4, "total_pages": 1, "current_page": 1 } } }, "ReleasephasesPostRequest": { "type": "object", "properties": { "release_phase": { "type": "object", "properties": { "name": { "type": "string", "example": "Another name" }, "description": { "type": "string", "example": "

new description

" }, "phase_type": { "type": "string", "example": "milestone" } }, "example": { "name": "Another name", "description": "

new description

", "phase_type": "milestone" } } }, "example": { "release_phase": { "name": "Another name", "description": "

new description

", "phase_type": "milestone" } } }, "ReleasephasesPostResponse": { "type": "object", "properties": { "release_phase": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149493480488" }, "name": { "type": "string", "example": "New release milestone" }, "start_on": { "type": "string", "example": "2019-01-01" }, "end_on": { "type": "string", "example": "2019-01-01" }, "type": { "type": "string", "example": "milestone" }, "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": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149492778822" }, "body": { "type": "string", "example": "

This is the description

" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149492778822", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } }, "example": { "id": "6776881149493480488", "name": "New release milestone", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "release_id": 278327321, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "description": { "id": "6776881149492778822", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } } }, "example": { "release_phase": { "id": "6776881149493480488", "name": "New release milestone", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "release_id": 278327321, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "description": { "id": "6776881149492778822", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } } }, "ReleasephasesPutResponse": { "type": "object", "properties": { "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": "integer", "example": 25 }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "243384959" }, "body": { "type": "string", "example": "Description of release phase 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": "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": 25, "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": [ ] } } } }, "example": { "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": 25, "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": [ ] } } } }, "ReleasesPostRequest": { "type": "object", "properties": { "release": { "type": "object", "properties": { "initiatives": { "type": "array", "items": { } }, "name": { "type": "string", "example": "Smarter release" } }, "example": { "initiatives": [ ], "name": "Smarter release" } } }, "example": { "release": { "initiatives": [ ], "name": "Smarter release" } } }, "ReleasesPostResponse": { "type": "object", "properties": { "release": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149492110971" }, "name": { "type": "string", "example": "[Copy] Release 1" } }, "example": { "id": "6776881149492110971", "name": "[Copy] Release 1" } } }, "example": { "release": { "id": "6776881149492110971", "name": "[Copy] Release 1" } } }, "ReleasesGetResponse": { "type": "object", "properties": { "release": { "type": "object", "properties": { "id": { "type": "string", "example": "278327321" }, "product_id": { "type": "string", "example": "131414752" }, "reference_num": { "type": "string", "example": "PRJ1-R-1" }, "name": { "type": "string", "example": "Release 1" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "null" }, "development_started_on": { "type": "string", "example": "2019-01-01" }, "release_date": { "type": "string", "example": "2019-01-01" }, "external_release_date": { "type": "string", "example": "2019-01-01" }, "external_release_date_description": { "type": "string", "example": "Sep 11, 2025" }, "external_date_resolution": { "type": "string", "example": "exact" }, "released": { "type": "boolean", "example": false }, "parking_lot": { "type": "boolean", "example": false }, "master_release": { "type": "boolean", "example": false }, "released_on": { "type": "string", "example": "2019-01-01" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "position": { "type": "null" }, "progress": { "type": "null" }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "status_changed_on": { "type": "null" }, "theme": { "type": "object", "properties": { "id": { "type": "string", "example": "522610666" }, "body": { "type": "string", "example": "Theme of the release" }, "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": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PRJ1-R-1" }, "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": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "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" }, "body": { "type": "string" }, "editor_version": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "attachments": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "example": { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } }, "example": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ] }, "comments_count": { "type": "integer", "example": 1 }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "738862546" }, "name": { "type": "string", "example": "New" }, "position": { "type": "integer", "example": 1 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#dce7c6" } }, "example": { "id": "738862546", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "owner": { "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" } }, "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": { } }, "initiatives": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "integration_fields": { "type": "string" } }, "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" } ] } }, "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" } ] } ] }, "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" } }, "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" } } }, "example": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ], "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": [ ] } } ], "key_results": [ ], "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" } } } }, "example": { "release": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ], "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": [ ] } } ], "key_results": [ ], "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" } } } }, "ReleasesPutResponse": { "type": "object", "properties": { "release": { "type": "object", "properties": { "id": { "type": "string", "example": "278327321" }, "product_id": { "type": "string", "example": "131414752" }, "reference_num": { "type": "string", "example": "PRJ1-R-1" }, "name": { "type": "string", "example": "Release 1" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "null" }, "development_started_on": { "type": "string", "example": "2019-01-01" }, "release_date": { "type": "string", "example": "2019-01-01" }, "external_release_date": { "type": "string", "example": "2019-01-01" }, "external_release_date_description": { "type": "string", "example": "Sep 11, 2025" }, "external_date_resolution": { "type": "string", "example": "exact" }, "released": { "type": "boolean", "example": false }, "parking_lot": { "type": "boolean", "example": false }, "master_release": { "type": "boolean", "example": false }, "released_on": { "type": "null" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "position": { "type": "null" }, "progress": { "type": "null" }, "progress_source": { "type": "string", "example": "progress_manual" }, "duration_source": { "type": "string", "example": "duration_manual" }, "status_changed_on": { "type": "null" }, "theme": { "type": "object", "properties": { "id": { "type": "string", "example": "522610666" }, "body": { "type": "string", "example": "Theme of the release" }, "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": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PRJ1-R-1" }, "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": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "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" }, "body": { "type": "string" }, "editor_version": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "attachments": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "example": { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } }, "example": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ] }, "comments_count": { "type": "integer", "example": 1 }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string", "example": "738862546" }, "name": { "type": "string", "example": "New" }, "position": { "type": "integer", "example": 1 }, "complete": { "type": "boolean", "example": false }, "color": { "type": "string", "example": "#dce7c6" } }, "example": { "id": "738862546", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "owner": { "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" } }, "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": { } }, "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" } }, "parent": { "type": "object", "properties": { "id": { "type": "string", "example": "292454904" }, "reference_num": { "type": "string", "example": "PRJ1-MR-1" }, "name": { "type": "string", "example": "Roll-up Release 1" }, "start_date": { "type": "string", "example": "2019-01-01" }, "release_date": { "type": "string", "example": "2019-01-01" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "url": { "type": "string", "example": "http://company.aha.io/master_releases/PRJ1-MR-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } }, "example": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } }, "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" } } }, "example": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ], "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": [ ] } } ], "key_results": [ ], "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" }, "parent": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" }, "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" } } } }, "example": { "release": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ], "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": [ ] } } ], "key_results": [ ], "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" }, "parent": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" }, "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" } } } }, "RequirementsGetResponse": { "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": 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": 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": 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 } } }, "RequirementsPostRequest": { "type": "object", "properties": { "requirement": { "type": "object", "properties": { "name": { "type": "string", "example": "New name" }, "workflow_status": { "type": "object", "properties": { "name": { "type": "string", "example": "Designed" } }, "example": { "name": "Designed" } }, "description": { "type": "string", "example": "

This is the description

" }, "assigned_to_user": { "type": "object", "properties": { "email": { "type": "string", "example": "no-reply@aha.io" } }, "example": { "email": "no-reply@aha.io" } } }, "example": { "name": "New name", "workflow_status": { "name": "Designed" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } }, "example": { "requirement": { "name": "New name", "workflow_status": { "name": "Designed" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } }, "RequirementsPostResponse": { "type": "object", "properties": { "feature": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149487717549" }, "name": { "type": "string", "example": "Body of requirement 1" }, "reference_num": { "type": "string", "example": "PRJ1-251" }, "initiative_reference_num": { "type": "null" }, "release_reference_num": { "type": "string", "example": "PRJ1-R-1" }, "epic_reference_num": { "type": "null" }, "position": { "type": "integer", "example": 1 }, "score": { "type": "integer", "example": 2 }, "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": "null" }, "due_date": { "type": "null" }, "product_id": { "type": "string", "example": "131414752" }, "progress": { "type": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "status_changed_on": { "type": "string", "example": "2019-01-01" }, "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_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": "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": [ ] } }, "attachments": { "type": "array", "items": { } }, "integration_fields": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/features/PRJ1-251" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/features/PRJ1-251" }, "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" } } }, "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": { } }, "goals": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 1 }, "score_facts": { "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": "6776881149495350529", "key": "expected_completion_date", "name": "Expected completion date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } }, "example": [ { "id": "6776881149495350529", "key": "expected_completion_date", "name": "Expected completion date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ] }, "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": "Relates to", "link_type_id": 10, "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": "6776881149487717549", "reference_num": "PRJ1-251", "name": "Body of requirement 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" } } }, "example": [ { "link_type": "Relates to", "link_type_id": 10, "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": "6776881149487717549", "reference_num": "PRJ1-251", "name": "Body of requirement 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" } } ] }, "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": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } }, "example": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "feature_only_original_estimate": { "type": "null" }, "feature_only_remaining_estimate": { "type": "null" }, "feature_only_work_done": { "type": "null" } }, "example": { "id": "6776881149487717549", "name": "Body of requirement 1", "reference_num": "PRJ1-251", "initiative_reference_num": null, "release_reference_num": "PRJ1-R-1", "epic_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "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": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/features/PRJ1-251", "resource": "http://company.aha.io/api/v1/features/PRJ1-251", "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" } }, "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": [ ], "goals": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ { "id": "6776881149495350529", "key": "expected_completion_date", "name": "Expected completion date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ], "feature_links": [ { "link_type": "Relates to", "link_type_id": 10, "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": "6776881149487717549", "reference_num": "PRJ1-251", "name": "Body of requirement 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" } } ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "feature_only_original_estimate": null, "feature_only_remaining_estimate": null, "feature_only_work_done": null } } }, "example": { "feature": { "id": "6776881149487717549", "name": "Body of requirement 1", "reference_num": "PRJ1-251", "initiative_reference_num": null, "release_reference_num": "PRJ1-R-1", "epic_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "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": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/features/PRJ1-251", "resource": "http://company.aha.io/api/v1/features/PRJ1-251", "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" } }, "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": [ ], "goals": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ { "id": "6776881149495350529", "key": "expected_completion_date", "name": "Expected completion date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ], "feature_links": [ { "link_type": "Relates to", "link_type_id": 10, "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": "6776881149487717549", "reference_num": "PRJ1-251", "name": "Body of requirement 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" } } ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "feature_only_original_estimate": null, "feature_only_remaining_estimate": null, "feature_only_work_done": null } } }, "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 } } }, "SchedulablechangesPostRequest": { "type": "object", "properties": { }, "example": { } }, "SchedulablechangesPostResponse": { "type": "object", "properties": { "schedulable_change": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149488722242" }, "effective_start_date": { "type": "string", "example": "2019-01-01" }, "team_members_count": { "type": "integer", "example": 5 }, "hourly_rate": { "type": "string", "example": "155.0" }, "color": { "type": "integer", "example": 6710886 }, "schedule": { "type": "object", "properties": { "id": { "type": "string", "example": "54870801" }, "name": { "type": "string", "example": "Another schedule" }, "hours_per_day": { "type": "string", "example": "10.0" }, "story_points_per_day": { "type": "string", "example": "5.0" }, "velocity": { "type": "string", "example": "10.0" } }, "example": { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" } }, "team_memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "new_user": { "type": "string" }, "deleted": { "type": "null" }, "schedule": { "type": "string" } }, "example": { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } }, "example": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } }, "example": { "id": "6776881149488722242", "effective_start_date": "2019-01-01", "team_members_count": 5, "hourly_rate": "155.0", "color": 6710886, "schedule": { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } }, "example": { "schedulable_change": { "id": "6776881149488722242", "effective_start_date": "2019-01-01", "team_members_count": 5, "hourly_rate": "155.0", "color": 6710886, "schedule": { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } }, "SchedulablechangesGetResponse": { "type": "object", "properties": { "schedulable_changes": { "type": "array", "items": { } }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 0 }, "total_pages": { "type": "integer", "example": 0 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "example": { "schedulable_changes": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } }, "SchedulablechangesPutResponse": { "type": "object", "properties": { "schedulable_change": { "type": "object", "properties": { "id": { "type": "string", "example": "711001786" }, "effective_start_date": { "type": "string", "example": "2019-01-01" }, "team_members_count": { "type": "integer", "example": 5 }, "hourly_rate": { "type": "string", "example": "100.0" }, "color": { "type": "integer", "example": 6710886 }, "schedule": { "type": "object", "properties": { "id": { "type": "string", "example": "441193141" }, "name": { "type": "string", "example": "Default schedule" }, "hours_per_day": { "type": "string", "example": "8.2" }, "story_points_per_day": { "type": "string", "example": "1.0" }, "velocity": { "type": "string", "example": "10.5" } }, "example": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" } }, "team_memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "new_user": { "type": "string" }, "deleted": { "type": "null" }, "schedule": { "type": "string" } }, "example": { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } }, "example": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } }, "example": { "id": "711001786", "effective_start_date": "2019-01-01", "team_members_count": 5, "hourly_rate": "100.0", "color": 6710886, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } }, "example": { "schedulable_change": { "id": "711001786", "effective_start_date": "2019-01-01", "team_members_count": 5, "hourly_rate": "100.0", "color": 6710886, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } }, "SchedulesGetResponse": { "type": "object", "properties": { "schedules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "54870801" }, "name": { "type": "string", "example": "Another schedule" }, "hours_per_day": { "type": "string", "example": "10.0" }, "story_points_per_day": { "type": "string", "example": "5.0" }, "velocity": { "type": "string", "example": "10.0" } }, "example": { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" } }, "example": [ { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, { "id": "876770204", "name": "Child schedule", "hours_per_day": "19.0", "story_points_per_day": "28.0", "velocity": null } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 3 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "example": { "schedules": [ { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, { "id": "876770204", "name": "Child schedule", "hours_per_day": "19.0", "story_points_per_day": "28.0", "velocity": null } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } }, "CustomLayoutsGetResponse": { "type": "object", "properties": { "id": { "type": "integer", "example": 19837977 }, "screenable_type": { "type": "string", "example": "Feature" }, "name": { "type": "string", "example": "Screen Definition 6" }, "custom_field_definitions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 839883647 }, "key": { "type": "string", "example": "custom_scorecard_definition" }, "position": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "Some custom scorecard definition" }, "type": { "type": "string", "example": "CustomFieldDefinitions::ScorecardField" }, "api_type": { "type": "string", "example": "scorecard" }, "required": { "type": "boolean", "example": false } }, "example": { "id": 839883647, "key": "custom_scorecard_definition", "position": 3, "name": "Some custom scorecard definition", "type": "CustomFieldDefinitions::ScorecardField", "api_type": "scorecard", "required": false } }, "example": [ { "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 } ] } }, "GoalsPostRequest": { "type": "object", "properties": { "goal": { "type": "object", "properties": { "description": { "type": "string", "example": "An even smarter goal." }, "workflow_status": { "type": "string", "example": "On Track" } }, "example": { "description": "An even smarter goal.", "workflow_status": "On Track" } } }, "example": { "goal": { "description": "An even smarter goal.", "workflow_status": "On Track" } } }, "GoalsPostResponse": { "type": "object", "properties": { "goal": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149493942444" }, "name": { "type": "string", "example": "Goal 3" }, "reference_num": { "type": "string", "example": "PRJ1-G-1" }, "effort": { "type": "integer", "example": 95 }, "value": { "type": "integer", "example": 54 }, "color": { "type": "string", "example": "#397e82" }, "position": { "type": "integer", "example": 6 }, "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" }, "progress": { "type": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "url": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/PRJ1-G-1" }, "resource": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/PRJ1-G-1" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149500114967" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149500114967", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "success_metric": { "type": "object", "properties": { "name": { "type": "string", "example": "FooBar" }, "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": "6776881149483601587", "body": "Foo Bar", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "412273758", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" } }, "workflow_status_times": { "type": "array", "items": { "type": "string" }, "example": [ { "status_id": "412273758", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] } }, "example": { "name": "FooBar", "description": { "id": "6776881149483601587", "body": "Foo Bar", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "workflow_status": { "id": "412273758", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, "workflow_status_times": [ { "status_id": "412273758", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] } }, "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" } }, "initiatives": { "type": "array", "items": { } }, "key_results": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 }, "features": { "type": "array", "items": { } }, "releases": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } }, "watchers": { "type": "array", "items": { "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" } }, "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" }, { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "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": "6776881149493942444", "name": "Goal 3", "reference_num": "PRJ1-G-1", "effort": 95, "value": 54, "color": "#397e82", "position": 6, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ1-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ1-G-1", "description": { "id": "6776881149500114967", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "FooBar", "description": { "id": "6776881149483601587", "body": "Foo Bar", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "workflow_status": { "id": "412273758", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, "workflow_status_times": [ { "status_id": "412273758", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "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": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ], "watchers": [ { "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" }, { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "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": { "goal": { "id": "6776881149493942444", "name": "Goal 3", "reference_num": "PRJ1-G-1", "effort": 95, "value": 54, "color": "#397e82", "position": 6, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ1-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ1-G-1", "description": { "id": "6776881149500114967", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "FooBar", "description": { "id": "6776881149483601587", "body": "Foo Bar", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "workflow_status": { "id": "412273758", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, "workflow_status_times": [ { "status_id": "412273758", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "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": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ], "watchers": [ { "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" }, { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "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" } ] } } }, "GoalsGetResponse": { "type": "object", "properties": { "goal": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149493103487" }, "name": { "type": "string", "example": "Goal 001" }, "reference_num": { "type": "string", "example": "PRJ3-G-1" }, "effort": { "type": "integer", "example": 10 }, "value": { "type": "integer", "example": 70 }, "color": { "type": "string", "example": "#397e82" }, "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" }, "product_id": { "type": "string", "example": "702241743" }, "progress": { "type": "integer", "example": 0 }, "progress_source": { "type": "string", "example": "progress_manual" }, "url": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/PRJ3-G-1" }, "resource": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/PRJ3-G-1" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149493796208" }, "body": { "type": "string", "example": "" }, "editor_version": { "type": "integer", "example": 2 }, "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": "6776881149493796208", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "success_metric": { "type": "object", "properties": { "name": { "type": "string", "example": "Metric 001" }, "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": "6776881149488589993", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "workflow_status": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "396368932", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" } }, "workflow_status_times": { "type": "array", "items": { "type": "string" }, "example": [ { "status_id": "396368932", "status_name": "On Track", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] } }, "example": { "name": "Metric 001", "description": { "id": "6776881149488589993", "body": "", "editor_version": 2, "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" }, "workflow_status_times": [ { "status_id": "396368932", "status_name": "On Track", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] } }, "project": { "type": "object", "properties": { "id": { "type": "string", "example": "702241743" }, "reference_prefix": { "type": "string", "example": "PRJ3" }, "name": { "type": "string", "example": "Project 3" }, "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/PRJ3" } }, "example": { "id": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" } }, "parent": { "type": "object", "properties": { "id": { "type": "string", "example": "352745835" }, "name": { "type": "string", "example": "Product Line Goal 1" }, "url": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/PL1-G-1" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/goals/PL1-G-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": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } }, "example": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } }, "parents": { "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": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } }, "example": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ] }, "initiatives": { "type": "array", "items": { } }, "key_results": { "type": "array", "items": { } }, "comments_count": { "type": "integer", "example": 0 }, "features": { "type": "array", "items": { } }, "releases": { "type": "array", "items": { } }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149493103487", "name": "Goal 001", "reference_num": "PRJ3-G-1", "effort": 10, "value": 70, "color": "#397e82", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "progress": 0, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "description": { "id": "6776881149493796208", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 001", "description": { "id": "6776881149488589993", "body": "", "editor_version": 2, "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" }, "workflow_status_times": [ { "status_id": "396368932", "status_name": "On Track", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "project": { "id": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" }, "parent": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parents": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] } } }, "example": { "goal": { "id": "6776881149493103487", "name": "Goal 001", "reference_num": "PRJ3-G-1", "effort": 10, "value": 70, "color": "#397e82", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "progress": 0, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "description": { "id": "6776881149493796208", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 001", "description": { "id": "6776881149488589993", "body": "", "editor_version": 2, "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" }, "workflow_status_times": [ { "status_id": "396368932", "status_name": "On Track", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "project": { "id": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" }, "parent": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parents": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] } } }, "GoalsPutResponse": { "type": "object", "properties": { "goal": { "type": "object", "properties": { "id": { "type": "string", "example": "602095703" }, "name": { "type": "string", "example": "Goal 1" }, "reference_num": { "type": "string", "example": "DEMOENT-G-1" }, "effort": { "type": "integer", "example": 10 }, "value": { "type": "integer", "example": 70 }, "color": { "type": "string", "example": "#bada55" }, "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" }, "product_id": { "type": "string", "example": "131414752" }, "progress": { "type": "integer", "example": 25 }, "progress_source": { "type": "string", "example": "progress_manual" }, "url": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1" }, "resource": { "type": "string", "example": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1" }, "description": { "type": "object", "properties": { "id": { "type": "string", "example": "166463080" }, "body": { "type": "string", "example": "Description of goal 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": "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": { "type": "object", "properties": { "name": { "type": "string", "example": "Metric 1" }, "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": "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": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "396368932", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" } } }, "example": { "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": { "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" } }, "initiatives": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "integration_fields": { "type": "string" } }, "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" } ] } }, "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" } ] } ] }, "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ] }, "comments_count": { "type": "integer", "example": 1 }, "features": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "product_id": { "type": "string" } }, "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" } }, "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" } ] }, "releases": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "start_date": { "type": "string" }, "release_date": { "type": "string" }, "parking_lot": { "type": "string" }, "created_at": { "type": "string" }, "product_id": { "type": "string" }, "integration_fields": { "type": "string" }, "url": { "type": "string" }, "resource": { "type": "string" }, "owner": { "type": "string" }, "project": { "type": "string" } }, "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" } } }, "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" } } ] }, "custom_fields": { "type": "array", "items": { } } }, "example": { "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": 25, "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" } ] } ], "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "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": [ ] } } }, "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": 25, "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" } ] } ], "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "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": [ ] } } }, "StrategicmodelsGetResponse": { "type": "object", "properties": { "strategy_model": { "type": "object", "properties": { "id": { "type": "string", "example": "111251416" }, "name": { "type": "string", "example": "Aha! business model canvas" }, "kind": { "type": "string", "example": "Business" }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "example": { "id": 62803905, "name": "Growth opportunity", "description": "" } }, "example": [ { "id": 62803905, "name": "Growth opportunity", "description": "" } ] }, "url": { "type": "string", "example": "http://company.aha.io/business_models/111251416" }, "resource": { "type": "string", "example": "http://company.aha.io/business_models/111251416" }, "project": { "type": "object", "properties": { "id": { "type": "string", "example": "517761884" }, "reference_prefix": { "type": "string", "example": "PRJ2" }, "name": { "type": "string", "example": "Project 2" }, "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/PRJ2" } }, "example": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } }, "example": { "id": "111251416", "name": "Aha! business model canvas", "kind": "Business", "components": [ { "id": 62803905, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/111251416", "resource": "http://company.aha.io/business_models/111251416", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } } }, "example": { "strategy_model": { "id": "111251416", "name": "Aha! business model canvas", "kind": "Business", "components": [ { "id": 62803905, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/111251416", "resource": "http://company.aha.io/business_models/111251416", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } } }, "StrategicpositioningsGetResponse": { "type": "object", "properties": { "strategy_positioning": { "type": "object", "properties": { "id": { "type": "string", "example": "453528824" }, "name": { "type": "string", "example": "Aha! strategic positioning model canvas" }, "kind": { "type": "string", "example": "Positioning" }, "components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "example": { "id": 37485938, "name": "Growth opportunity", "description": "" } }, "example": [ { "id": 37485938, "name": "Growth opportunity", "description": "" } ] }, "url": { "type": "string", "example": "http://company.aha.io/business_models/453528824" }, "resource": { "type": "string", "example": "http://company.aha.io/business_models/453528824" }, "project": { "type": "object", "properties": { "id": { "type": "string", "example": "517761884" }, "reference_prefix": { "type": "string", "example": "PRJ2" }, "name": { "type": "string", "example": "Project 2" }, "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/PRJ2" } }, "example": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } }, "example": { "id": "453528824", "name": "Aha! strategic positioning model canvas", "kind": "Positioning", "components": [ { "id": 37485938, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/453528824", "resource": "http://company.aha.io/business_models/453528824", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } } }, "example": { "strategy_positioning": { "id": "453528824", "name": "Aha! strategic positioning model canvas", "kind": "Positioning", "components": [ { "id": 37485938, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/453528824", "resource": "http://company.aha.io/business_models/453528824", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } } }, "StrategicvisionsGetResponse": { "type": "object", "properties": { "strategy_vision": { "type": "object", "properties": { "id": { "type": "string", "example": "613708188" }, "name": { "type": "string", "example": "Project 1 Strategy" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "description": { "type": "null" }, "strategy_vision_components": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "null" } }, "example": { "id": 669674847, "name": "Our market", "title": null } }, "example": [ { "id": 669674847, "name": "Our market", "title": null }, { "id": 1055079655, "name": "Our strengths", "title": null } ] }, "url": { "type": "string", "example": "http://company.aha.io/project_strategies/613708188" }, "resource": { "type": "string", "example": "http://company.aha.io/project_strategies/613708188" }, "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" } } }, "example": { "id": "613708188", "name": "Project 1 Strategy", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": null, "strategy_vision_components": [ { "id": 669674847, "name": "Our market", "title": null }, { "id": 1055079655, "name": "Our strengths", "title": null } ], "url": "http://company.aha.io/project_strategies/613708188", "resource": "http://company.aha.io/project_strategies/613708188", "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" } } } }, "example": { "strategy_vision": { "id": "613708188", "name": "Project 1 Strategy", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": null, "strategy_vision_components": [ { "id": 669674847, "name": "Our market", "title": null }, { "id": 1055079655, "name": "Our strengths", "title": null } ], "url": "http://company.aha.io/project_strategies/613708188", "resource": "http://company.aha.io/project_strategies/613708188", "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" } } } }, "To-dosPostRequest": { "type": "object", "properties": { "task": { "type": "object", "properties": { "body": { "type": "string", "example": "

Can you please review this press release

" } }, "example": { "body": "

Can you please review this press release

" } } }, "example": { "task": { "body": "

Can you please review this press release

" } } }, "To-dosPostResponse": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149495424765" }, "name": { "type": "string", "example": "Review press release" }, "body": { "type": "string", "example": "

Can you please review the press release

" }, "due_date": { "type": "null" }, "status": { "type": "string", "example": "pending" }, "position": { "type": "null" }, "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": "" }, "assigned_to_users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "user": { "type": "string" } }, "example": { "id": "6776881149484955852", "status": "pending", "user": { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } }, "example": [ { "id": "6776881149484955852", "status": "pending", "user": { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "6776881149486559736", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ] }, "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" } }, "attachments": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/tasks/6776881149495424765" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/tasks/6776881149495424765" }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "6776881149495424765", "name": "Review press release", "body": "

Can you please review the press release

", "due_date": null, "status": "pending", "position": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "", "assigned_to_users": [ { "id": "6776881149484955852", "status": "pending", "user": { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "6776881149486559736", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/6776881149495424765", "resource": "http://company.aha.io/api/v1/tasks/6776881149495424765", "comments_count": 0 } } }, "example": { "task": { "id": "6776881149495424765", "name": "Review press release", "body": "

Can you please review the press release

", "due_date": null, "status": "pending", "position": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "", "assigned_to_users": [ { "id": "6776881149484955852", "status": "pending", "user": { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "6776881149486559736", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/6776881149495424765", "resource": "http://company.aha.io/api/v1/tasks/6776881149495424765", "comments_count": 0 } } }, "To-dosGetResponse": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "example": "1041191038" }, "name": { "type": "string", "example": "Task name" }, "body": { "type": "string", "example": "Task body" }, "due_date": { "type": "string", "example": "2019-01-01" }, "status": { "type": "string", "example": "partially_complete" }, "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" }, "product_id": { "type": "string", "example": "" }, "assigned_to_users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "user": { "type": "string" } }, "example": { "id": "1061194521", "status": "completed", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } }, "example": [ { "id": "1061194521", "status": "completed", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "642374309", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ] }, "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" } }, "attachments": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/tasks/1041191038" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/tasks/1041191038" }, "comments_count": { "type": "integer", "example": 0 } }, "example": { "id": "1041191038", "name": "Task name", "body": "Task body", "due_date": "2019-01-01", "status": "partially_complete", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "", "assigned_to_users": [ { "id": "1061194521", "status": "completed", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "642374309", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/1041191038", "resource": "http://company.aha.io/api/v1/tasks/1041191038", "comments_count": 0 } } }, "example": { "task": { "id": "1041191038", "name": "Task name", "body": "Task body", "due_date": "2019-01-01", "status": "partially_complete", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "", "assigned_to_users": [ { "id": "1061194521", "status": "completed", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "642374309", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/1041191038", "resource": "http://company.aha.io/api/v1/tasks/1041191038", "comments_count": 0 } } }, "To-dosPutResponse": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "example": "568474467" }, "name": { "type": "string", "example": "Task name" }, "body": { "type": "string", "example": "Task body" }, "due_date": { "type": "string", "example": "2019-01-01" }, "status": { "type": "string", "example": "completed" }, "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" }, "product_id": { "type": "string", "example": "702241743" }, "assigned_to_users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "completed_date": { "type": "string" }, "user": { "type": "string" } }, "example": { "id": "938180846", "status": "completed", "completed_date": "2019-01-01T00:00:00.000Z", "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": [ { "id": "938180846", "status": "completed", "completed_date": "2019-01-01T00:00:00.000Z", "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" } } ] }, "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" } }, "attachments": { "type": "array", "items": { } }, "url": { "type": "string", "example": "http://company.aha.io/tasks/568474467" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/tasks/568474467" }, "comments_count": { "type": "integer", "example": 0 }, "taskable": { "type": "object", "properties": { "type": { "type": "string", "example": "Feature" }, "id": { "type": "string", "example": "959120953" }, "reference_num": { "type": "string", "example": "PRJ3-2" }, "name": { "type": "string", "example": "A third Feature" }, "url": { "type": "string", "example": "http://company.aha.io/features/PRJ3-2" }, "resource": { "type": "string", "example": "http://company.aha.io/api/v1/features/PRJ3-2" } }, "example": { "type": "Feature", "id": "959120953", "reference_num": "PRJ3-2", "name": "A third Feature", "url": "http://company.aha.io/features/PRJ3-2", "resource": "http://company.aha.io/api/v1/features/PRJ3-2" } } }, "example": { "id": "568474467", "name": "Task name", "body": "Task body", "due_date": "2019-01-01", "status": "completed", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "assigned_to_users": [ { "id": "938180846", "status": "completed", "completed_date": "2019-01-01T00:00:00.000Z", "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" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/568474467", "resource": "http://company.aha.io/api/v1/tasks/568474467", "comments_count": 0, "taskable": { "type": "Feature", "id": "959120953", "reference_num": "PRJ3-2", "name": "A third Feature", "url": "http://company.aha.io/features/PRJ3-2", "resource": "http://company.aha.io/api/v1/features/PRJ3-2" } } } }, "example": { "task": { "id": "568474467", "name": "Task name", "body": "Task body", "due_date": "2019-01-01", "status": "completed", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "assigned_to_users": [ { "id": "938180846", "status": "completed", "completed_date": "2019-01-01T00:00:00.000Z", "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" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/568474467", "resource": "http://company.aha.io/api/v1/tasks/568474467", "comments_count": 0, "taskable": { "type": "Feature", "id": "959120953", "reference_num": "PRJ3-2", "name": "A third Feature", "url": "http://company.aha.io/features/PRJ3-2", "resource": "http://company.aha.io/api/v1/features/PRJ3-2" } } } }, "TeammembersPostRequest": { "type": "object", "properties": { }, "example": { } }, "TeammembersPostResponse": { "type": "object", "properties": { "team_member": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149494512236" }, "name": { "type": "string", "example": "Sam Doe" }, "email": { "type": "string", "example": "sam.doe@example.com" }, "user_id": { "type": "null" }, "virtual": { "type": "boolean", "example": true } }, "example": { "id": "6776881149494512236", "name": "Sam Doe", "email": "sam.doe@example.com", "user_id": null, "virtual": true } } }, "example": { "team_member": { "id": "6776881149494512236", "name": "Sam Doe", "email": "sam.doe@example.com", "user_id": null, "virtual": true } } }, "TeammembersGetResponse": { "type": "object", "properties": { "team_members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "540018633" }, "name": { "type": "string", "example": "John Johnson" }, "email": { "type": "string", "example": "john.johnson@corporation.com" }, "user_id": { "type": "null" }, "virtual": { "type": "boolean", "example": true } }, "example": { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true } }, "example": [ { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 2 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 2, "total_pages": 1, "current_page": 1 } } }, "example": { "team_members": [ { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } }, "TeammembershipsPostRequest": { "type": "object", "properties": { }, "example": { } }, "TeammembershipsGetResponse": { "type": "object", "properties": { "team_memberships": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "202266373" }, "team_member": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "user_id": { "type": "null" }, "virtual": { "type": "string" } }, "example": { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true } }, "team": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "example": { "id": "949295028", "name": "Default team" } }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "example": { "id": "202266373", "team_member": { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" } }, "example": [ { "id": "202266373", "team_member": { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "646482528", "team_member": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 2 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 2, "total_pages": 1, "current_page": 1 } } }, "example": { "team_memberships": [ { "id": "202266373", "team_member": { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "646482528", "team_member": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } }, "TeamsPostRequest": { "type": "object", "properties": { }, "example": { } }, "TeamsPostResponse": { "type": "object", "properties": { "team": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149489987892" }, "name": { "type": "string", "example": "Product team" }, "team_members_count": { "type": "integer", "example": 0 }, "automatically_calculate_team_members_count": { "type": "boolean", "example": true }, "capacity": { "type": "integer", "example": 0 }, "hourly_rate": { "type": "null" }, "color": { "type": "string", "example": "#666666" }, "start_date": { "type": "null" }, "end_date": { "type": "null" }, "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" } }, "schedule": { "type": "object", "properties": { "id": { "type": "string", "example": "441193141" }, "name": { "type": "string", "example": "Default schedule" }, "hours_per_day": { "type": "string", "example": "8.2" }, "story_points_per_day": { "type": "string", "example": "1.0" }, "velocity": { "type": "string", "example": "10.5" } }, "example": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" } }, "custom_fields": { "type": "array", "items": { } } }, "example": { "id": "6776881149489987892", "name": "Product team", "team_members_count": 0, "automatically_calculate_team_members_count": true, "capacity": 0, "hourly_rate": null, "color": "#666666", "start_date": null, "end_date": null, "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" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ] } } }, "example": { "team": { "id": "6776881149489987892", "name": "Product team", "team_members_count": 0, "automatically_calculate_team_members_count": true, "capacity": 0, "hourly_rate": null, "color": "#666666", "start_date": null, "end_date": null, "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" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ] } } }, "TeamsGetResponse": { "type": "object", "properties": { "team": { "type": "object", "properties": { "id": { "type": "string", "example": "949295028" }, "name": { "type": "string", "example": "Default team" }, "team_members_count": { "type": "integer", "example": 5 }, "automatically_calculate_team_members_count": { "type": "boolean", "example": false }, "capacity": { "type": "string", "example": "205.0" }, "hourly_rate": { "type": "string", "example": "100.0" }, "color": { "type": "string", "example": "#666666" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "string", "example": "2019-01-01" }, "project": { "type": "null" }, "schedule": { "type": "object", "properties": { "id": { "type": "string", "example": "441193141" }, "name": { "type": "string", "example": "Default schedule" }, "hours_per_day": { "type": "string", "example": "8.2" }, "story_points_per_day": { "type": "string", "example": "1.0" }, "velocity": { "type": "string", "example": "10.5" } }, "example": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" } }, "custom_fields": { "type": "array", "items": { } }, "team_members": { "type": "object", "properties": { "id": { "type": "string", "example": "960059005" }, "name": { "type": "string", "example": "Mary Humpty" }, "email": { "type": "string", "example": "no-reply@aha.io" }, "user_id": { "type": "string", "example": "1020675218" }, "virtual": { "type": "boolean", "example": false } }, "example": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } } }, "example": { "id": "949295028", "name": "Default team", "team_members_count": 5, "automatically_calculate_team_members_count": false, "capacity": "205.0", "hourly_rate": "100.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "project": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } } } }, "example": { "team": { "id": "949295028", "name": "Default team", "team_members_count": 5, "automatically_calculate_team_members_count": false, "capacity": "205.0", "hourly_rate": "100.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "project": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } } } }, "TeamsPutResponse": { "type": "object", "properties": { "team": { "type": "object", "properties": { "id": { "type": "string", "example": "134558347" }, "name": { "type": "string", "example": "Project team" }, "team_members_count": { "type": "integer", "example": 1 }, "automatically_calculate_team_members_count": { "type": "boolean", "example": true }, "capacity": { "type": "string", "example": "41.0" }, "hourly_rate": { "type": "string", "example": "250.0" }, "color": { "type": "string", "example": "#666666" }, "start_date": { "type": "string", "example": "2019-01-01" }, "end_date": { "type": "string", "example": "2019-01-01" }, "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" } }, "schedule": { "type": "object", "properties": { "id": { "type": "string", "example": "441193141" }, "name": { "type": "string", "example": "Default schedule" }, "hours_per_day": { "type": "string", "example": "8.2" }, "story_points_per_day": { "type": "string", "example": "1.0" }, "velocity": { "type": "string", "example": "10.5" } }, "example": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" } }, "custom_fields": { "type": "array", "items": { } }, "team_members": { "type": "object", "properties": { "id": { "type": "string", "example": "730311797" }, "name": { "type": "string", "example": "Peter Parker" }, "email": { "type": "null" }, "user_id": { "type": "null" }, "virtual": { "type": "boolean", "example": true } }, "example": { "id": "730311797", "name": "Peter Parker", "email": null, "user_id": null, "virtual": true } } }, "example": { "id": "134558347", "name": "Project team", "team_members_count": 1, "automatically_calculate_team_members_count": true, "capacity": "41.0", "hourly_rate": "250.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "730311797", "name": "Peter Parker", "email": null, "user_id": null, "virtual": true } } } }, "example": { "team": { "id": "134558347", "name": "Project team", "team_members_count": 1, "automatically_calculate_team_members_count": true, "capacity": "41.0", "hourly_rate": "250.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "730311797", "name": "Peter Parker", "email": null, "user_id": null, "virtual": true } } } }, "TimetrackingeventsPostRequest": { "type": "object", "properties": { "time_tracking_event": { "type": "object", "properties": { "user_id": { "type": "integer", "example": 689956296 }, "work_done_text": { "type": "string", "example": "2h" } }, "example": { "user_id": 689956296, "work_done_text": "2h" } } }, "example": { "time_tracking_event": { "user_id": 689956296, "work_done_text": "2h" } } }, "TimetrackingeventsPostResponse": { "type": "object", "properties": { "time_tracking_event": { "type": "object", "properties": { "id": { "type": "string", "example": "6776881149484363523" }, "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" } }, "occurred_on": { "type": "string", "example": "2019-01-01" }, "work_done": { "type": "number", "example": 120.0 }, "work_units": { "type": "integer", "example": 10 } }, "example": { "id": "6776881149484363523", "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" }, "occurred_on": "2019-01-01", "work_done": 120.0, "work_units": 10 } } }, "example": { "time_tracking_event": { "id": "6776881149484363523", "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" }, "occurred_on": "2019-01-01", "work_done": 120.0, "work_units": 10 } } }, "UsersPostRequest": { "type": "object", "properties": { "user_role": { "type": "object", "properties": { "custom_role_id": { "type": "integer", "example": 409541421 }, "product_id": { "type": "integer", "example": 131414752 } }, "example": { "custom_role_id": 409541421, "product_id": 131414752 } } }, "example": { "user_role": { "custom_role_id": 409541421, "product_id": 131414752 } } }, "UsersPostResponse": { "type": "object", "properties": { "role_id": { "type": "integer", "example": 409541421 }, "name": { "type": "string", "example": "Project scoped role 1" }, "scope": { "type": "object", "properties": { "type": { "type": "string", "example": "project" }, "name": { "type": "string", "example": "Project 1" }, "id": { "type": "integer", "example": 131414752 } }, "example": { "type": "project", "name": "Project 1", "id": 131414752 } } }, "example": { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Project 1", "id": 131414752 } } }, "UsersGetResponse": { "type": "object", "properties": { "user_roles": { "type": "array", "items": { "type": "object", "properties": { "role_id": { "type": "integer", "example": 409541421 }, "name": { "type": "string", "example": "Project scoped role 1" }, "scope": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "example": { "type": "project", "name": "Project 1", "id": 131414752 } } }, "example": { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Project 1", "id": 131414752 } } }, "example": [ { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Project 1", "id": 131414752 } } ] }, "pagination": { "type": "object", "properties": { "total_records": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 1 }, "current_page": { "type": "integer", "example": 1 } }, "example": { "total_records": 1, "total_pages": 1, "current_page": 1 } } }, "example": { "user_roles": [ { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Project 1", "id": 131414752 } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } }, "UsersPutResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "1020675218" }, "name": { "type": "string", "example": "Sarah Humpty" }, "email": { "type": "string", "example": "no-reply@aha.io" }, "timezone": { "type": "string", "example": "America/Los_Angeles" }, "created_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "accessed_at": { "type": "string", "example": "2019-01-01T00:00:00.000Z" }, "product_roles": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "integer", "example": 20 }, "role_description": { "type": "string", "example": "Owner" }, "product_id": { "type": "string", "example": "131414752" }, "product_name": { "type": "string", "example": "Project 1" } }, "example": { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" } }, "example": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" }, { "role": 20, "role_description": "Owner", "product_id": "517761884", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "610602692", "product_name": null } ] }, "enabled": { "type": "boolean", "example": false }, "paid_seat": { "type": "boolean", "example": true }, "roadmaps_seat": { "type": "boolean", "example": true }, "develop_seat": { "type": "boolean", "example": false }, "teamwork_seat": { "type": "boolean", "example": false }, "administrator": { "type": "boolean", "example": false }, "administrator_roles": { "type": "object", "properties": { "administer_account": { "type": "boolean", "example": false }, "administer_billing": { "type": "boolean", "example": false }, "administer_configuration": { "type": "boolean", "example": false } }, "example": { "administer_account": false, "administer_billing": false, "administer_configuration": false } }, "identity_provider": { "type": "object", "properties": { "type": { "type": "string", "example": "password" } }, "example": { "type": "password" } } }, "example": { "id": "1020675218", "name": "Sarah Humpty", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": "2019-01-01T00:00:00.000Z", "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" }, { "role": 20, "role_description": "Owner", "product_id": "517761884", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "610602692", "product_name": null } ], "enabled": false, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } } }, "WorkflowsGetResponse": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "id": { "type": "integer", "example": 80245244 }, "name": { "type": "string", "example": "Account product idea workflow" }, "statusable_type": { "type": "string", "example": "Idea" }, "transitions_only": { "type": "boolean", "example": false }, "workflow_statuses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "complete": { "type": "string" }, "color": { "type": "string" } }, "example": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" } }, "example": [ { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "349486678", "name": "Shipped", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" } ] }, "workflow_kinds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "example": { "id": "1809278", "name": "Improvement" } }, "example": [ { "id": "1809278", "name": "Improvement" }, { "id": "787053401", "name": "New" } ] } }, "example": { "id": 80245244, "name": "Account product idea workflow", "statusable_type": "Idea", "transitions_only": false, "workflow_statuses": [ { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "349486678", "name": "Shipped", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "1809278", "name": "Improvement" }, { "id": "787053401", "name": "New" } ] } } }, "example": { "workflow": { "id": 80245244, "name": "Account product idea workflow", "statusable_type": "Idea", "transitions_only": false, "workflow_statuses": [ { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "349486678", "name": "Shipped", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "1809278", "name": "Improvement" }, { "id": "787053401", "name": "New" } ] } } } }, "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" } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "paths": { "/api/v1/account_backups": { "get": { "summary": "List account backups", "description": "Account backups let you create a complete off-site backup of your Aha! account.\nThey can be [created](/api/resources/account_backups/create_an_account_backup),\n[listed](/api/resources/account_backups/list_account_backups), and [downloaded](/api/resources/account_backups/download_an_account_backup) via the API.\n\nAn account backup may only be created once every 24 hours.\n\nThe backup file contains a representation of all of the data in the Aha! account, including all relationships. \nIt does not contain user authentication data or integration secrets. The backup does not include any uploaded files.\n\n**[Account backups](https://www.aha.io/support/roadmaps/account/security-and-system-requirements/export-backup-aha-data) are an Enterprise+ exclusive feature.**", "tags": [ "Account backups" ], "parameters": [ ], "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/AccountbackupsGetResponse" }, "example": { "account_backups": [ { "id": "1", "status_code": 2, "status_description": "Completed", "created_at": "2019-01-01T00:00:00.000Z", "file_size": "", "download_url": "http://company.aha.io/api/v1/account_backups/1.tgz" }, { "id": "2", "status_code": 2, "status_description": "Completed", "created_at": "2019-01-01T00:00:00.000Z", "file_size": "", "download_url": "http://company.aha.io/api/v1/account_backups/2.tgz" } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create an account backup", "description": "The backup may take some time to generate (as long as ten minutes in a \nlarge account). You should poll the GET endpoint to see when the backup \nis complete. You should not poll more frequently than once every twenty \nseconds. Returns an HTTP status of 429 if a backup was already created\nwithin the last 24 hours.", "tags": [ "Account backups" ], "parameters": [ ], "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/AccountbackupsPostResponse" }, "example": { "account_backup": { "id": "6776881149498172525", "status_code": 0, "status_description": "In Queue", "created_at": "2019-01-01T00:00:00.000Z" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/account_backups/{id}": { "get": { "summary": "Get a specific account backup", "description": "The status field indicates whether the backup is ready. The possible\nvalues are: 0 (queued), 1 (in progress), 2 (completed), 3 (error).", "tags": [ "Account backups" ], "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/AccountbackupsGetResponse" }, "example": { "account_backup": { "id": "6776881149499462668", "status_code": 3, "status_description": "Error", "created_at": "2019-01-01T00:00:00.000Z" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/account_backups/{id}.tgz": { "get": { "summary": "Download an account backup", "description": "Account backups let you create a complete off-site backup of your Aha! account.\nThey can be [created](/api/resources/account_backups/create_an_account_backup),\n[listed](/api/resources/account_backups/list_account_backups), and [downloaded](/api/resources/account_backups/download_an_account_backup) via the API.\n\nAn account backup may only be created once every 24 hours.\n\nThe backup file contains a representation of all of the data in the Aha! account, including all relationships. \nIt does not contain user authentication data or integration secrets. The backup does not include any uploaded files.\n\n**[Account backups](https://www.aha.io/support/roadmaps/account/security-and-system-requirements/export-backup-aha-data) are an Enterprise+ exclusive feature.**", "tags": [ "Account backups" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "200": { "description": "Successful operation", "headers": { "Content-Type": { "description": "application/gzip", "schema": { "type": "string" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/comments/{comment_id}/attachments": { "post": { "summary": "Create an attachment on a comment", "description": "Uploads a file attachment to a comment using multipart/form-data", "tags": [ "Attachments" ], "parameters": [ { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CommentId 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/AttachmentsPostResponse" }, "example": { "attachment": { "id": "6776881149496969408", "download_url": "https://company.aha.io/attachments/6776881149496969408/token/5e0c5180006c4cfa.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment[data]": { "type": "string", "format": "binary", "description": "File to upload" } } } } } } } }, "/api/v1/idea_comments/{idea_comment_id}/attachments": { "post": { "summary": "Create an attachment on an idea comment", "description": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_note_field)\n\nThe format of an attachment is either a `multipart/form-data` upload with\nthe input name `attachment[data]` or a JSON payload pointing to an URL link:\n\n```json\n{\n \"attachment\": {\n \"file_url\": \"http://www.aha.io/\",\n \"content_type\": \"text/html\",\n \"file_name\": \"home_page.html\"\n }\n}\n```", "tags": [ "Attachments" ], "parameters": [ { "name": "idea_comment_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaCommentId 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/AttachmentsPostResponse" }, "example": { "attachment": { "id": "6776881149499676024", "download_url": "https://company.aha.io/attachments/6776881149499676024/token/5e0c5180006af027.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment[data]": { "type": "string", "format": "binary", "description": "File to upload" } } } } } } } }, "/api/v1/tasks/{task_id}/attachments": { "post": { "summary": "Create an attachment on a to-do", "description": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_note_field)\n\nThe format of an attachment is either a `multipart/form-data` upload with\nthe input name `attachment[data]` or a JSON payload pointing to an URL link:\n\n```json\n{\n \"attachment\": {\n \"file_url\": \"http://www.aha.io/\",\n \"content_type\": \"text/html\",\n \"file_name\": \"home_page.html\"\n }\n}\n```", "tags": [ "Attachments" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "TaskId 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/AttachmentsPostResponse" }, "example": { "attachment": { "id": "6776881149492544916", "download_url": "https://company.aha.io/attachments/6776881149492544916/token/5e0c518000a14554.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment[data]": { "type": "string", "format": "binary", "description": "File to upload" } } } } } } } }, "/api/v1/custom_fields/{custom_field_id}/attachments": { "post": { "summary": "Create an attachment on a custom note field", "description": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_note_field)\n\nThe format of an attachment is either a `multipart/form-data` upload with\nthe input name `attachment[data]` or a JSON payload pointing to an URL link:\n\n```json\n{\n \"attachment\": {\n \"file_url\": \"http://www.aha.io/\",\n \"content_type\": \"text/html\",\n \"file_name\": \"home_page.html\"\n }\n}\n```", "tags": [ "Attachments" ], "parameters": [ { "name": "custom_field_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldId 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/AttachmentsPostResponse" }, "example": { "attachment": { "id": "6776881149491054206", "download_url": "https://company.aha.io/attachments/6776881149491054206/token/5e0c518000e0d32f.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment[data]": { "type": "string", "format": "binary", "description": "File to upload" } } } } } } } }, "/api/v1/custom_field_values/{custom_field_value_id}/attachments": { "post": { "summary": "Create an attachment on a custom attachment field", "description": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_note_field)\n\nThe format of an attachment is either a `multipart/form-data` upload with\nthe input name `attachment[data]` or a JSON payload pointing to an URL link:\n\n```json\n{\n \"attachment\": {\n \"file_url\": \"http://www.aha.io/\",\n \"content_type\": \"text/html\",\n \"file_name\": \"home_page.html\"\n }\n}\n```", "tags": [ "Attachments" ], "parameters": [ { "name": "custom_field_value_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldValueId 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/AttachmentsPostResponse" }, "example": { "attachment": { "id": "6776881149499253955", "download_url": "https://company.aha.io/attachments/6776881149499253955/token/5e0c518000f7d402.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment[data]": { "type": "string", "format": "binary", "description": "File to upload" } } } } } } } }, "/api/v1/notes/{note_id}/attachments": { "post": { "summary": "Create an attachment on a record description", "description": "Many records throughout Aha! have an associated description: features, requirements, ideas, etc. You can find the ID of a record's description within the `description` attribute returned by any record show endpoint. You can then use that description ID to create an attachment on the record by providing it as the `note_id` URL parameter for this endpoint.", "tags": [ "Attachments" ], "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "NoteId 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/AttachmentsPostResponse" }, "example": { "attachment": { "id": "6776881149488245716", "download_url": "https://company.aha.io/attachments/6776881149488245716/token/5e0c5180003396dd.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 0, "content_type": "text/html", "file_name": "home_page.html", "file_size": 0 } } } } }, "412": { "description": "Precondition failed", "headers": { "Content-Type": { "description": "application/json; charset=utf-8", "schema": { "type": "string" } } }, "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/AttachmentsPost412Response" }, "example": { "status": "duplicate", "success": false, "attachmentId": "6776881149490765072", "attachmentUrl": "https://company.aha.io/attachments/6776881149490765072/token/5e0c518000ac2936?size=original" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attachment[data]": { "type": "string", "format": "binary", "description": "File to upload" } } } } } } } }, "/api/v1/attachments/{attachment_id}": { "delete": { "summary": "Delete an attachment", "description": "Files can be uploaded to Aha! as a sub-resource on any resource that supports them.\nThese resources support attachments:\n\n- [Record descriptions](/api/resources/attachments/create_an_attachment_on_a_record_description) (the description of a feature, requirement, etc.)\n- [Comments](/api/resources/attachments/create_an_attachment_on_a_comment)\n- [To-dos](/api/resources/attachments/create_an_attachment_on_a_to-do)\n- [Custom note fields](/api/resources/attachments/create_an_attachment_on_a_custom_note_field)\n\nThe format of an attachment is either a `multipart/form-data` upload with\nthe input name `attachment[data]` or a JSON payload pointing to an URL link:\n\n```json\n{\n \"attachment\": {\n \"file_url\": \"http://www.aha.io/\",\n \"content_type\": \"text/html\",\n \"file_name\": \"home_page.html\"\n }\n}\n```", "tags": [ "Attachments" ], "parameters": [ { "name": "attachment_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "AttachmentId identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/audits": { "get": { "summary": "Retrieve the history of only the description of a record", "description": "Audit records describe historical changes to records in Aha! and are created automatically when a record is created, updated, or deleted. Audits are immutable and cannot be modified or deleted.\n\nAudits are stored not only for first-class objects such as Features or Release, but also for secondary objects attached to those records such as custom field values, equation field values, descriptions, and record links.\n\nAudit records are only available for the last 12 calendar months. After that, they must be accessed using the [Historical Audits](/api/resources/historical_audits/create_an_audit_search/) endpoint.\n\nThe performance of the Audits API can be improved by judicious use of the `created_since` and `created_before` parameters. Since this is high-volume timeseries data, these parameters should be used when attempting to scan through record activity, and the `after_id` parameter should be used in lieu of pagination.", "tags": [ "Audits" ], "parameters": [ { "name": "associated_id", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1007868956" }, { "name": "associated_type", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Feature" }, { "name": "auditable_type", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Note" } ], "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/AuditsGetResponse" }, "example": { "audits": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/historical_audits": { "get": { "summary": "Read the contents of the historical index", "description": "The historical audits endpoint is similar to the the Audits endpoint, but searches for audit records generated more than 12 calendar months ago. For searches of more recent data, the much more performant [Audits API](/api/resources/audits) should be used.\n\nThe [historical index](/api/resources/historical_audits/read_the_contents_of_the_historical_index) should first be used to identify time-periods of interest, and then a search can be conducted to fetch the full details of the audit records from that period.\n\nThere are three important caveats to using this API:\n\n1. Searching through historical audits is an asynchronous operation. A search must first be [created](/api/resources/historical_audits/create_an_audit_search), and then the data may be [consumed later](/api/resources/historical_audits/read_the_results_of_an_audit_search)\n2. Searching through historical audits imposes a stricter rate-limit than the general rate limit of the API. This API also enforces rate-limiting through a _token-based system._\n 1. Each Audits search consumes a specific number of tokens. The token cost of a search will be presented to the user through the [read results operation.](/api/resources/historical_audits/read_the_results_of_an_audit_search)\n 2. The token cost of a request is only known after the search completes, and corresponds to the amount of data which was required to be scanned to fulfill the request. Specifying additional filters, such as `user_id`, `auditable_type`, and `audit_action` will decrease the token cost.\n 3. Upon making a request, the maximum token cost for a query will be charged to your account. The difference between the actual token cost and the maximum token cost will be refunded when the search completes and you read the search data.\n 4. Tokens are continually replenished. You can see the current number of tokens available in the `X-Historical-Tokens-Available` header, present on every response to these resources.\n 5. Reading from the [historical index](/api/resources/historical_audits/read_the_contents_of_the_historical_index) does not consume any tokens.\n3. Only administrators are able to perform historical audit searches.", "tags": [ "Historical Audits" ], "parameters": [ { "name": "created_since", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2019-01-01T00:00:00Z" }, { "name": "created_before", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2019-01-01T00:00:00Z" }, { "name": "auditable_type", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Feature" }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1049303076" } ], "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/HistoricalAuditsGetResponse" }, "example": { "historical_audits": [ { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] }, { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] }, { "auditable_id": 1007868956, "auditable_type": "Feature", "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "dates_active": [ "2019-01-01", "2019-01-01", "2019-01-01", "2019-01-01" ] } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create an audit search", "description": "The historical audits endpoint is similar to the the Audits endpoint, but searches for audit records generated more than 12 calendar months ago. For searches of more recent data, the much more performant [Audits API](/api/resources/audits) should be used.\n\nThe [historical index](/api/resources/historical_audits/read_the_contents_of_the_historical_index) should first be used to identify time-periods of interest, and then a search can be conducted to fetch the full details of the audit records from that period.\n\nThere are three important caveats to using this API:\n\n1. Searching through historical audits is an asynchronous operation. A search must first be [created](/api/resources/historical_audits/create_an_audit_search), and then the data may be [consumed later](/api/resources/historical_audits/read_the_results_of_an_audit_search)\n2. Searching through historical audits imposes a stricter rate-limit than the general rate limit of the API. This API also enforces rate-limiting through a _token-based system._\n 1. Each Audits search consumes a specific number of tokens. The token cost of a search will be presented to the user through the [read results operation.](/api/resources/historical_audits/read_the_results_of_an_audit_search)\n 2. The token cost of a request is only known after the search completes, and corresponds to the amount of data which was required to be scanned to fulfill the request. Specifying additional filters, such as `user_id`, `auditable_type`, and `audit_action` will decrease the token cost.\n 3. Upon making a request, the maximum token cost for a query will be charged to your account. The difference between the actual token cost and the maximum token cost will be refunded when the search completes and you read the search data.\n 4. Tokens are continually replenished. You can see the current number of tokens available in the `X-Historical-Tokens-Available` header, present on every response to these resources.\n 5. Reading from the [historical index](/api/resources/historical_audits/read_the_contents_of_the_historical_index) does not consume any tokens.\n3. Only administrators are able to perform historical audit searches.", "tags": [ "Historical Audits" ], "parameters": [ ], "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/HistoricalAuditsPostResponse" }, "example": { "search_id": "6776881149486782892" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricalAuditsPostRequest" }, "example": { "search": { "created_since": "2019-01-01T00:00:00Z", "created_before": "2019-01-01T00:00:00Z", "auditable_type": "Feature", "auditable_id": 1007868956 } } } } } } }, "/api/v1/initiatives/{initiative_id}/capacity_investments": { "post": { "summary": "Create a capacity investment on an initiative", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/CapacityinvestmentsPostResponse" }, "example": { "capacity_investment": { "id": "6776881149484188557", "capacity_scenario_id": "997808419", "total": 0.0, "estimate_source": "epics", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "initiative": { "id": "1042392694", "reference_num": "PL1-S-1", "name": "Workspace line initiative 1", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/initiatives/PL1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PL1-S-1" }, "estimate_values": [ { "id": "6776881149486881903", "team_id": null, "team_membership_id": null, "period_start": null, "total": 0.0, "computed": true, "ignored": false } ], "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityinvestmentsPostRequest" }, "example": { "capacity_investment": { "start_date": "2019-01-01", "end_date": "2019-01-01", "date_source": "manual_dates", "estimate_source": "epics" } } } } } }, "get": { "summary": "List capacity investments for an initiative", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityinvestmentsGetResponse" }, "example": { "capacity_investments": [ { "id": "756888381", "capacity_scenario_id": "997808419", "total": null } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics/{epic_id}/capacity_investments": { "post": { "summary": "Create a capacity investment on an epic", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId 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/CapacityinvestmentsPostResponse" }, "example": { "capacity_investment": { "id": "6776881149493463903", "capacity_scenario_id": "997808419", "total": 0.0, "estimate_source": "features", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "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" }, "estimate_values": [ { "id": "6776881149496741502", "team_id": null, "team_membership_id": null, "period_start": null, "total": 0.0, "computed": true, "ignored": false } ], "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityinvestmentsPostRequest" }, "example": { "capacity_investment": { "start_date": "2019-01-01", "end_date": "2019-01-01", "date_source": "manual_dates", "estimate_source": "features" } } } } } }, "get": { "summary": "List capacity investments for an epic", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityinvestmentsGetResponse" }, "example": { "capacity_investments": [ { "id": "6776881149495109598", "capacity_scenario_id": "997808419", "total": null } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/{feature_id}/capacity_investments": { "post": { "summary": "Create a Capacity Investment with custom fields", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId 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/CapacityinvestmentsPostResponse" }, "example": { "capacity_investment": { "id": "6776881149497074336", "capacity_scenario_id": "997808419", "total": null, "estimate_source": "manual_estimate", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "estimate_values": [ ], "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityinvestmentsPostRequest" }, "example": { "capacity_investment": { "start_date": "2019-01-01", "end_date": "2019-01-01", "date_source": "manual_dates", "custom_fields": { "priority": "P3" } } } } } } }, "get": { "summary": "List capacity investments for a feature", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityinvestmentsGetResponse" }, "example": { "capacity_investments": [ { "id": "6776881149498957294", "capacity_scenario_id": "997808419", "total": null } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/capacity_investments": { "get": { "summary": "List capacity investments for a product", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityinvestmentsGetResponse" }, "example": { "capacity_investments": [ { "id": "756888381", "capacity_scenario_id": "997808419", "total": null }, { "id": "873751177", "capacity_scenario_id": "997808419", "total": 100.0 } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/capacity_investments/{id}": { "get": { "summary": "Get a capacity investment", "description": null, "tags": [ "Capacity investments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityinvestmentsGetResponse" }, "example": { "capacity_investment": { "id": "6776881149492244248", "capacity_scenario_id": "997808419", "total": 50.0, "estimate_source": "manual_estimate", "date_source": "capacity_plannable", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "estimate_values": [ { "id": "6776881149484177228", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149485556219", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149487389839", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149489538211", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149491485839", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149492682136", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149493180575", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149496397024", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149497562730", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149499233465", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false } ], "custom_fields": [ { "id": 424324947, "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "Acme Corp", "type": "string" } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a capacity investment's custom fields", "description": null, "tags": [ "Capacity investments" ], "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/CapacityinvestmentsPutResponse" }, "example": { "capacity_investment": { "id": "756888381", "capacity_scenario_id": "997808419", "total": null, "estimate_source": "manual_estimate", "date_source": "manual_dates", "start_date": "2019-01-01", "end_date": "2019-01-01", "initiative": { "id": "423077122", "reference_num": "PRJ1-S-1", "name": "Initiative 1", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" }, "estimate_values": [ ], "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityinvestmentsPostRequest" }, "example": { "capacity_investment": { "start_date": "2019-01-01", "end_date": "2019-01-01", "date_source": "manual_dates", "custom_fields": { "priority": "P3" } } } } } } } }, "/api/v1/capacity_scenarios": { "get": { "summary": "List capacity scenarios", "description": null, "tags": [ "Capacity scenarios" ], "parameters": [ { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityscenariosGetResponse" }, "example": { "capacity_scenarios": [ { "id": 16603097, "name": "Custom test scenario", "planning_interval": "month", "planning_start_date": "2019-01-01", "planning_end_date": "2019-01-01", "estimate_value_layout": "team_by_time", "data_entry_units": "custom", "archived": false }, { "id": 454855257, "name": "Second test scenario", "planning_interval": "month", "planning_start_date": "2019-01-01", "planning_end_date": "2019-01-01", "estimate_value_layout": "team_by_time", "data_entry_units": "headcount", "archived": false }, { "id": 997808419, "name": "Default test scenario", "planning_interval": "month", "planning_start_date": "2019-01-01", "planning_end_date": "2019-01-01", "estimate_value_layout": "team_by_time", "data_entry_units": "headcount", "archived": false } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/capacity_scenarios/{id}": { "get": { "summary": "Get a capacity scenario", "description": null, "tags": [ "Capacity scenarios" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityscenariosGetResponse" }, "example": { "capacity_scenario": { "id": 997808419, "name": "Default test scenario", "planning_interval": "month", "planning_start_date": "2019-01-01", "planning_end_date": "2019-01-01", "estimate_value_layout": "team_by_time", "data_entry_units": "headcount", "archived": false } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/{feature_id}/comments": { "post": { "summary": "Create a comment on a feature", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149488625529", "body": "

This is the comment body for a feature.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149488625529", "resource": "http://company.aha.io/api/v1/comments/6776881149488625529", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a feature.

" } } } } } }, "get": { "summary": "List comments on a feature", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "781701978", "body": "Comment on feature", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ], "url": "http://company.aha.io/comments/781701978", "resource": "http://company.aha.io/api/v1/comments/781701978", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics/{epic_id}/comments": { "post": { "summary": "Create a comment on an epic", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149490456459", "body": "

This is the comment body for an epic.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149490456459", "resource": "http://company.aha.io/api/v1/comments/6776881149490456459", "commentable": { "type": "Epic", "id": "999605892", "product_id": "131414752", "url": "http://company.aha.io/epics/PRJ1-E-1", "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for an epic.

" } } } } } }, "get": { "summary": "List comments on an epic", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "465979716", "body": "This is an epic comment", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/465979716", "resource": "http://company.aha.io/api/v1/comments/465979716", "commentable": { "type": "Epic", "id": "999605892", "product_id": "131414752", "url": "http://company.aha.io/epics/PRJ1-E-1", "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/requirements/{requirement_id}/comments": { "post": { "summary": "Create a comment on a requirement", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "requirement_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "RequirementId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149487246030", "body": "

This is the comment body for a requirement.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149487246030", "resource": "http://company.aha.io/api/v1/comments/6776881149487246030", "commentable": { "type": "Requirement", "id": "483368544", "product_id": "131414752", "url": "http://company.aha.io/requirements/PRJ1-1-1", "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a requirement.

" } } } } } }, "get": { "summary": "List comments on a requirement", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "requirement_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "RequirementId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "971503243", "body": "This is a requirement comment", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/971503243", "resource": "http://company.aha.io/api/v1/comments/971503243", "commentable": { "type": "Requirement", "id": "483368544", "product_id": "131414752", "url": "http://company.aha.io/requirements/PRJ1-1-1", "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/pages/{page_id}/comments": { "post": { "summary": "Create a comment on a note", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "page_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "PageId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149494267635", "body": "

This is the comment body for a note.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149494267635", "resource": "http://company.aha.io/api/v1/comments/6776881149494267635", "commentable": { "type": "Page", "id": "1051981226", "product_id": "131414752", "url": "http://company.aha.io/pages/PRJ1-N-1", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a note.

" } } } } } }, "get": { "summary": "List comments on a note", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "page_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "PageId 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/CommentsGetResponse" }, "example": { "comments": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/comments": { "post": { "summary": "Create an internal comment for an idea", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149495437410", "body": "

This is the comment body for an idea.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149495437410", "resource": "http://company.aha.io/api/v1/comments/6776881149495437410", "commentable": { "type": "Ideas::Idea", "id": "58056975", "product_id": "131414752", "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/ideas/PRJ1-I-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for an idea.

" } } } } } }, "get": { "summary": "List comments on an idea", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/CommentsGetResponse" }, "example": { "comments": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives/{initiative_id}/comments": { "post": { "summary": "Create a comment on an initiative", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149497068301", "body": "

This is the comment body for an initiative.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149497068301", "resource": "http://company.aha.io/api/v1/comments/6776881149497068301", "commentable": { "type": "Initiative", "id": "423077122", "product_id": "131414752", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for an initiative.

" } } } } } }, "get": { "summary": "List comments on an initiative", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "133461614", "body": "Comment on initiative", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/133461614", "resource": "http://company.aha.io/api/v1/comments/133461614", "commentable": { "type": "Initiative", "id": "423077122", "product_id": "131414752", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/goals/{goal_id}/comments": { "post": { "summary": "Create a comment on a goal", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149486535140", "body": "

This is the comment body for a goal.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149486535140", "resource": "http://company.aha.io/api/v1/comments/6776881149486535140", "commentable": { "type": "StrategicImperative", "id": "602095703", "product_id": "131414752", "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1", "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a goal.

" } } } } } }, "get": { "summary": "List comments on a goal", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "821249787", "body": "Comment on goal", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/821249787", "resource": "http://company.aha.io/api/v1/comments/821249787", "commentable": { "type": "StrategicImperative", "id": "602095703", "product_id": "131414752", "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1", "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/{release_id}/comments": { "post": { "summary": "Create a comment on a release", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149487602359", "body": "

This is the comment body for a release.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149487602359", "resource": "http://company.aha.io/api/v1/comments/6776881149487602359", "commentable": { "type": "Release", "id": "278327321", "product_id": "131414752", "url": "http://company.aha.io/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a release.

" } } } } } }, "get": { "summary": "List comments on a release", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "428925905", "body": "Comment on release", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/428925905", "resource": "http://company.aha.io/api/v1/comments/428925905", "commentable": { "type": "Release", "id": "278327321", "product_id": "131414752", "url": "http://company.aha.io/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/release_phases/{release_phase_id}/comments": { "post": { "summary": "Create a comment on a release phase", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "release_phase_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleasePhaseId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149489627713", "body": "

This is the comment body for a release phase.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149489627713", "resource": "http://company.aha.io/api/v1/comments/6776881149489627713", "commentable": { "type": "ReleasePhase", "id": "20526005", "url": "http://company.aha.io/release_phases/20526005", "resource": "http://company.aha.io/api/v1/release_phases/20526005" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a release phase.

" } } } } } }, "get": { "summary": "List comments on a release phase", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "release_phase_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleasePhaseId 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/CommentsGetResponse" }, "example": { "comments": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/tasks/{task_id}/comments": { "post": { "summary": "Create a comment on a to-do", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "TaskId 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/CommentsPostResponse" }, "example": { "comment": { "id": "6776881149487788674", "body": "

This is the comment body for a to-do.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/6776881149487788674", "resource": "http://company.aha.io/api/v1/comments/6776881149487788674", "commentable": { "type": "Task", "id": "748715293", "product_id": "131414752", "url": "http://company.aha.io/tasks/748715293", "resource": "http://company.aha.io/api/v1/tasks/748715293" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

This is the comment body for a to-do.

" } } } } } }, "get": { "summary": "List comments on a to-do", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "TaskId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "55160124", "body": "Comment on project", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/55160124", "resource": "http://company.aha.io/api/v1/comments/55160124", "commentable": { "type": "Task", "id": "748715293", "product_id": "131414752", "url": "http://company.aha.io/tasks/748715293", "resource": "http://company.aha.io/api/v1/tasks/748715293" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/comments/{id}": { "get": { "summary": "Get a specific comment", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "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/CommentsGetResponse" }, "example": { "comment": { "id": "781701978", "body": "Comment on feature", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ], "url": "http://company.aha.io/comments/781701978", "resource": "http://company.aha.io/api/v1/comments/781701978", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a comment", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "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/CommentsPutResponse" }, "example": { "comment": { "id": "781701978", "body": "

Updated comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ], "url": "http://company.aha.io/comments/781701978", "resource": "http://company.aha.io/api/v1/comments/781701978", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentsPostRequest" }, "example": { "comment": { "body": "

Updated comment body.

" } } } } } }, "delete": { "summary": "Delete a comment", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{project_id}/comments": { "get": { "summary": "List comments in a product", "description": "Comments can be added to and listed as a sub-resource on any resource that supports them.\nThese resources support comments:\n\n- [Features](/api/resources/comments/list_comments_on_a_feature)\n- [Epics](/api/resources/comments/list_comments_on_an_epic)\n- [Requirements](/api/resources/comments/list_comments_on_a_requirement)\n- [Ideas](/api/resources/comments/list_comments_on_an_idea)\n- [Initiatives](/api/resources/comments/list_comments_on_an_initiative)\n- [Goals](/api/resources/comments/list_comments_on_a_goal)\n- [Releases](/api/resources/comments/list_comments_on_a_release)\n- [Release phases](/api/resources/comments/list_comments_on_a_release_phase)\n- [To-dos](/api/resources/comments/list_comments_on_a_to-do)\n\nThey can be listed [product-wide](/api/resources/comments/list_comments_in_a_product),\nor retrieved from anywhere in the system using the root [comments resource](/api/resources/comments/get_a_specific_comment).", "tags": [ "Comments" ], "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProjectId 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/CommentsGetResponse" }, "example": { "comments": [ { "id": "428925905", "body": "Comment on release", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/428925905", "resource": "http://company.aha.io/api/v1/comments/428925905", "commentable": { "type": "Release", "id": "278327321", "product_id": "131414752", "url": "http://company.aha.io/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1" } }, { "id": "133461614", "body": "Comment on initiative", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/133461614", "resource": "http://company.aha.io/api/v1/comments/133461614", "commentable": { "type": "Initiative", "id": "423077122", "product_id": "131414752", "url": "http://company.aha.io/initiatives/PRJ1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1" } }, { "id": "821249787", "body": "Comment on goal", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/821249787", "resource": "http://company.aha.io/api/v1/comments/821249787", "commentable": { "type": "StrategicImperative", "id": "602095703", "product_id": "131414752", "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1", "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1" } }, { "id": "102125331", "body": "Comment 5", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/102125331", "resource": "http://company.aha.io/api/v1/comments/102125331", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "522133163", "body": "Comment 6", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/522133163", "resource": "http://company.aha.io/api/v1/comments/522133163", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "672673340", "body": "Comment 7", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/672673340", "resource": "http://company.aha.io/api/v1/comments/672673340", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "950481839", "body": "Comment 8", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/950481839", "resource": "http://company.aha.io/api/v1/comments/950481839", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "262144830", "body": "Comment 9", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/262144830", "resource": "http://company.aha.io/api/v1/comments/262144830", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "231087120", "body": "Comment 10", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/231087120", "resource": "http://company.aha.io/api/v1/comments/231087120", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "985738395", "body": "Comment 11", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/985738395", "resource": "http://company.aha.io/api/v1/comments/985738395", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "600341795", "body": "Comment 12", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/600341795", "resource": "http://company.aha.io/api/v1/comments/600341795", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "349130164", "body": "Comment 13", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/349130164", "resource": "http://company.aha.io/api/v1/comments/349130164", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "179034137", "body": "Comment 14", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/179034137", "resource": "http://company.aha.io/api/v1/comments/179034137", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "1034741892", "body": "Comment 15", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/1034741892", "resource": "http://company.aha.io/api/v1/comments/1034741892", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "614840636", "body": "Comment 16", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/614840636", "resource": "http://company.aha.io/api/v1/comments/614840636", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "329419181", "body": "Comment 17", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/329419181", "resource": "http://company.aha.io/api/v1/comments/329419181", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "52270142", "body": "Comment 18", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/52270142", "resource": "http://company.aha.io/api/v1/comments/52270142", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "823230344", "body": "Comment 4", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/823230344", "resource": "http://company.aha.io/api/v1/comments/823230344", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "796256805", "body": "Comment 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/796256805", "resource": "http://company.aha.io/api/v1/comments/796256805", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "410180276", "body": "Comment 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/410180276", "resource": "http://company.aha.io/api/v1/comments/410180276", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "24873740", "body": "Comment 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/24873740", "resource": "http://company.aha.io/api/v1/comments/24873740", "commentable": { "type": "Feature", "id": "622562724", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-2", "resource": "http://company.aha.io/api/v1/features/PRJ1-2" } }, { "id": "213086058", "body": "An annotation comment", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/213086058", "resource": "http://company.aha.io/api/v1/comments/213086058", "commentable": { "type": "Annotation", "id": "541632378", "url": "http://company.aha.io/annotations/541632378" } }, { "id": "971503243", "body": "This is a requirement comment", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/971503243", "resource": "http://company.aha.io/api/v1/comments/971503243", "commentable": { "type": "Requirement", "id": "483368544", "product_id": "131414752", "url": "http://company.aha.io/requirements/PRJ1-1-1", "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1" } }, { "id": "340318108", "body": "This feature is integrated", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/340318108", "resource": "http://company.aha.io/api/v1/comments/340318108", "commentable": { "type": "Feature", "id": "303873333", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-3", "resource": "http://company.aha.io/api/v1/features/PRJ1-3" } }, { "id": "110125740", "body": "Comment on competitor 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/110125740", "resource": "http://company.aha.io/api/v1/comments/110125740", "commentable": { "type": "Competitor", "id": "892399625", "product_id": "131414752", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/api/v1/competitors/PROD-C-1" } }, { "id": "781701978", "body": "Comment on feature", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "180276963", "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.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 }, { "id": "822785180", "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.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 } ], "url": "http://company.aha.io/comments/781701978", "resource": "http://company.aha.io/api/v1/comments/781701978", "commentable": { "type": "Feature", "id": "1007868956", "product_id": "131414752", "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } }, { "id": "933135074", "body": "Comment on project", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ { "id": "109125418", "download_url": "https://company.aha.io/attachments/109125418/token/aaabbbccc6.download?size=original", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "original_file_size": 67794, "content_type": "application/pdf", "file_name": "google_doc.pdf", "file_size": 67794 }, { "id": "221084308", "download_url": "https://company.aha.io/attachments/221084308/token/aaabbbccc14.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": "image/png", "file_name": "Mockup.png", "file_size": 123 }, { "id": "229957526", "download_url": "https://company.aha.io/attachments/229957526/token/aaabbbccc15.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": "image/png", "file_name": "not-a-mockup.png", "file_size": 123 }, { "id": "744925247", "download_url": "https://company.aha.io/attachments/744925247/token/aaabbbccc1.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 } ], "url": "http://company.aha.io/comments/933135074", "resource": "http://company.aha.io/api/v1/comments/933135074", "commentable": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/api/v1/products/PRJ1" } }, { "id": "55160124", "body": "Comment on project", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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" }, "attachments": [ ], "url": "http://company.aha.io/comments/55160124", "resource": "http://company.aha.io/api/v1/comments/55160124", "commentable": { "type": "Task", "id": "748715293", "product_id": "131414752", "url": "http://company.aha.io/tasks/748715293", "resource": "http://company.aha.io/api/v1/tasks/748715293" } }, { "id": "779056158", "body": "An annotation comment", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/779056158", "resource": "http://company.aha.io/api/v1/comments/779056158", "commentable": { "type": "Annotation", "id": "594874923", "url": "http://company.aha.io/annotations/594874923" } }, { "id": "714777635", "body": "An annotation comment", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "attachments": [ ], "url": "http://company.aha.io/comments/714777635", "resource": "http://company.aha.io/api/v1/comments/714777635", "commentable": { "type": "Annotation", "id": "345680906", "url": "http://company.aha.io/annotations/345680906" } } ], "pagination": { "total_records": 69, "total_pages": 3, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/competitors": { "get": { "summary": "List competitors in a product", "description": null, "tags": [ "Competitors" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/CompetitorsGetResponse" }, "example": { "competitors": [ { "id": "457085224", "name": "TrackFast", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "741974453", "name": "Road Racer", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "892399625", "name": "360 Tracker", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create a competitor", "description": null, "tags": [ "Competitors" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/CompetitorsPostResponse" }, "example": { "competitor": { "id": "6776881149490638099", "name": "Plan-a-lot", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PRJ1-C-1", "resource": "http://company.aha.io/competitors/PRJ1-C-1", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorsPostRequest" }, "example": { "competitor": { "name": "Plan-a-lot", "color": 29647 } } } } } } }, "/api/v1/competitors/{id}": { "get": { "summary": "Get a specific competitor", "description": null, "tags": [ "Competitors" ], "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/CompetitorsGetResponse" }, "example": { "competitor": { "id": "892399625", "name": "360 Tracker", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/competitors/PROD-C-1", "custom_fields": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ], "comments_count": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/competitors/{id}": { "put": { "summary": "Update a competitor", "description": null, "tags": [ "Competitors" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "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/CompetitorsPutResponse" }, "example": { "competitor": { "id": "892399625", "name": "Plan-a-lot", "color": 29647, "subtitle": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/competitors/PROD-C-1", "resource": "http://company.aha.io/competitors/PROD-C-1", "custom_fields": [ { "id": 415795050, "key": "revenue", "name": "Revenue", "updatedAt": "2019-01-01T00:00:00Z", "value": "300.0", "type": "number" } ], "comments_count": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorsPostRequest" }, "example": { "competitor": { "name": "Plan-a-lot" } } } } } }, "delete": { "summary": "Delete a competitor", "description": null, "tags": [ "Competitors" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/creative_briefs": { "post": { "summary": "Create a creative brief", "description": null, "tags": [ "Creative briefs" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/CreativebriefsPostResponse" }, "example": { "creative_brief": { "id": "6776881149490547091", "name": "April launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/6776881149490547091", "resource": "http://company.aha.io/creative_briefs/6776881149490547091", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreativebriefsPostRequest" }, "example": { "creative_brief": { "name": "April launch" } } } } } }, "get": { "summary": "List creative briefs in a product", "description": null, "tags": [ "Creative briefs" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/CreativebriefsGetResponse" }, "example": { "creative_briefs": [ { "id": "91171755", "name": "May launch", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "476477971", "name": "April launch", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "982259096", "name": "June launch", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/creative_briefs/{id}": { "get": { "summary": "Get a specific creative_brief", "description": null, "tags": [ "Creative briefs" ], "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/CreativebriefsGetResponse" }, "example": { "creative_brief": { "id": "476477971", "name": "April launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/476477971", "resource": "http://company.aha.io/creative_briefs/476477971", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/creative_briefs/{id}": { "put": { "summary": "Update a creative brief", "description": null, "tags": [ "Creative briefs" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "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/CreativebriefsPutResponse" }, "example": { "creative_brief": { "id": "476477971", "name": "December launch", "color": 13421772, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/creative_briefs/476477971", "resource": "http://company.aha.io/creative_briefs/476477971", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreativebriefsPostRequest" }, "example": { "creative_brief": { "name": "December launch" } } } } } }, "delete": { "summary": "Delete a creative brief", "description": null, "tags": [ "Creative briefs" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/custom_field_definitions": { "get": { "summary": "List all custom fields", "description": "Custom fields are defined by record type, and are shared\nacross all workspaces across the account. Fields must be\nadded to a layout before they will appear on a record.\n\nFor custom fields that include options, (e.g. tags, choice\nlists), you can also load the list of all available options.", "tags": [ "Custom fields" ], "parameters": [ ], "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/CustomfieldsGetResponse" }, "example": { "custom_field_definitions": [ { "name": "Priority", "id": "581360680", "key": "priority", "type": "CustomFieldDefinitions::SelectConstant", "custom_fieldable_type": "Feature", "internal_name": null } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/custom_field_definitions/{custom_field_definition_id}/options": { "get": { "summary": "List options for a custom field", "description": "Custom fields are defined by record type, and are shared\nacross all workspaces across the account. Fields must be\nadded to a layout before they will appear on a record.\n\nFor custom fields that include options, (e.g. tags, choice\nlists), you can also load the list of all available options.", "tags": [ "Custom fields" ], "parameters": [ { "name": "custom_field_definition_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldDefinitionId 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/CustomfieldsGetResponse" }, "example": { "options": [ { "text": "P1", "value": "486420793", "meta": { "color": "#666666" } }, { "text": "P2", "value": "100098181", "meta": { "color": "#666666" } }, { "text": "P3", "value": "854609942", "meta": { "color": "#666666" } }, { "text": "P4", "value": "747947447", "meta": { "color": "#666666" } }, { "text": "P5", "value": "462681378", "meta": { "color": "#666666" } } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/custom_field_definitions/{custom_field_definition_id}/custom_field_options": { "get": { "summary": "List all custom fields", "description": null, "tags": [ "Custom field options" ], "parameters": [ { "name": "custom_field_definition_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldDefinitionId 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/CustomfieldoptionsGetResponse" }, "example": { "custom_field_options": [ { "id": "100098181", "value": "P2", "color": 6710886, "hidden": false }, { "id": "462681378", "value": "P5", "color": 6710886, "hidden": false }, { "id": "486420793", "value": "P1", "color": 6710886, "hidden": false }, { "id": "747947447", "value": "P4", "color": 6710886, "hidden": false }, { "id": "854609942", "value": "P3", "color": 6710886, "hidden": false } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create a custom field option", "description": null, "tags": [ "Custom field options" ], "parameters": [ { "name": "custom_field_definition_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldDefinitionId 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/CustomfieldoptionsPostResponse" }, "example": { "id": "6776881149485179355", "value": "New option", "color": 6710886, "hidden": false } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomfieldoptionsPostRequest" }, "example": { "custom_field_option": { "value": "New option" } } } } } } }, "/api/v1/custom_field_definitions/{custom_field_definition_id}/custom_field_options/{id}": { "put": { "summary": "Update a custom field option", "description": null, "tags": [ "Custom field options" ], "parameters": [ { "name": "custom_field_definition_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldDefinitionId identifier" }, { "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/CustomfieldoptionsPutResponse" }, "example": { "id": "486420793", "value": "New option2", "color": 6710886, "hidden": false } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomfieldoptionsPostRequest" }, "example": { "custom_field_option": { "value": "New option2" } } } } } }, "delete": { "summary": "Delete a custom field option", "description": null, "tags": [ "Custom field options" ], "parameters": [ { "name": "custom_field_definition_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "CustomFieldDefinitionId identifier" }, { "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/CustomfieldoptionsDeleteResponse" }, "example": { "id": "486420793", "value": "P1", "color": 6710886, "hidden": false } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomfieldoptionsPostRequest" }, "example": { } } } } } }, "/api/v1/products/{id}": { "put": { "summary": "Create a custom table record link associated with a product", "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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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/ProductsPutResponse" }, "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" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomtablerecordlinksPostRequest" }, "example": { "product": { "custom_object_links": { "customers": [ "640362830" ] } } } } } } }, "get": { "summary": "Get a specific product", "description": null, "tags": [ "Products" ], "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/ProductsGetResponse" }, "example": { "product": { "id": "131414752", "reference_prefix": "PRJ1", "name": "Project 1", "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" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/{id}": { "put": { "summary": "Create a custom table record link associated with a release", "description": "*[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": { "release": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" ] } } } } } } }, "get": { "summary": "Get a specific release", "description": null, "tags": [ "Releases" ], "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/ReleasesGetResponse" }, "example": { "release": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ], "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": [ ] } } ], "key_results": [ ], "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": [ ] } ] } }, "/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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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" ] } } } } } } }, "get": { "summary": "Get a specific feature", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "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/FeaturesGetResponse" }, "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": null, "progress_source": "progress_manual", "status_changed_on": null, "created_by_user": { "id": "16338845", "name": "John Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "6776881149487303525", "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": "6776881149485217306", "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": [ ] } ] }, "delete": { "summary": "Delete a feature", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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" ] } } } } } } }, "get": { "summary": "Get a specific requirement", "description": null, "tags": [ "Requirements" ], "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/RequirementsGetResponse" }, "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": 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": [ ] } ] }, "delete": { "summary": "Delete a requirement", "description": null, "tags": [ "Requirements" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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" ] } } } } } } }, "get": { "summary": "Get a specific idea", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "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/IdeasGetResponse" }, "example": { "idea": { "id": "1055237874", "name": "Idea 3 Merged", "reference_num": "PRJ1-I-3", "score": 0, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "votes": 2, "initial_votes": 2, "status_changed_at": null, "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "506957205", "body": "Description of idea 3", "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", "duplicate_of": { "id": "444379319", "reference_num": "PRJ1-I-2", "name": "Idea 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "378547141", "body": "Description of idea 2", "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/ideas/ideas/PRJ1-I-2", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2" }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-3", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3", "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_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "created_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "assigned_to_user": null, "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" }, "endorsements_count": 0, "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "categories": [ ], "custom_fields": [ ], "submitted_idea_portal_record_url": "https://ideas.example.com:8338/ideas/PRJ1-I-3", "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "delete": { "summary": "Delete an idea", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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" ] } } } } } } }, "get": { "summary": "Get a specific initiative", "description": null, "tags": [ "Initiatives" ], "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/InitiativesGetResponse" }, "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": [ ] } } ], "key_results": [ ], "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" } ], "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": [ ] } ] } }, "/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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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" ] } } } } } } }, "get": { "summary": "Get a specific goal", "description": null, "tags": [ "Goals" ], "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/GoalsGetResponse" }, "example": { "goal": { "id": "6776881149493103487", "name": "Goal 001", "reference_num": "PRJ3-G-1", "effort": 10, "value": 70, "color": "#397e82", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "progress": 0, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "description": { "id": "6776881149493796208", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 001", "description": { "id": "6776881149488589993", "body": "", "editor_version": 2, "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" }, "workflow_status_times": [ { "status_id": "396368932", "status_name": "On Track", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "project": { "id": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" }, "parent": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parents": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/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.\nTo use custom table record links you must first add a many-to-many custom field definition to the resource.\nWhen you pass the IDs of custom table records to link to the feature, the existing list of links will be replaced.\n\nExamples of linking custom objects to resources with a many-to-many `customer` field:\n\n- [Products](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_product)\n- [Releases](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_release)\n- [Features](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_feature)\n- [Ideas](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_idea)\n- [Initiatives](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_an_initiative)\n- [Goals](/api/resources/custom_table_record_links/create_a_custom_table_record_link_associated_with_a_goal)\n\n**[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 ] } } } } } } }, "get": { "summary": "Get a specific custom table record", "description": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update_a_custom_table_record),\nor\n[delete](/api/resources/custom_table_records/delete_a_custom_table_record)\nthem on the root custom table records resource.\n\n**[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**", "tags": [ "Custom table records" ], "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/CustomtablerecordsGetResponse" }, "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": [ ] } ], "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": [ ] } ] }, "delete": { "summary": "Delete a custom table record", "description": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update_a_custom_table_record),\nor\n[delete](/api/resources/custom_table_records/delete_a_custom_table_record)\nthem on the root custom table records resource.\n\n**[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**", "tags": [ "Custom table records" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/custom_objects/{key}/records": { "post": { "summary": "Create a custom table record", "description": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update_a_custom_table_record),\nor\n[delete](/api/resources/custom_table_records/delete_a_custom_table_record)\nthem on the root custom table records resource.\n\n**[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**", "tags": [ "Custom table records" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Key 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/CustomtablerecordsPostResponse" }, "example": { "custom_object_record": { "id": "6776881149486714349", "product_id": "131414752", "key": "customers", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "custom_fields": [ { "id": "6776881149493312138", "key": "name", "name": "Name", "updatedAt": "2019-01-01T00:00:00Z", "value": "Major conglomerate", "type": "string" }, { "id": "6776881149489312610", "key": "website", "name": "Website", "updatedAt": "2019-01-01T00:00:00Z", "value": "www.conglom.com", "type": "url" } ], "custom_object_links": [ ], "linked_records": [ ], "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/CustomtablerecordsPostRequest" }, "example": { "custom_object_record": { "custom_fields": { "name": "Major conglomerate", "website": "www.conglom.com" } } } } } } }, "get": { "summary": "List records in a custom table for a product", "description": "Custom tables have a different set of records for each product.\nThis means that if you want to\n[create one](/api/resources/custom_table_records/create_a_custom_table_record)\nor\n[list them](/api/resources/custom_table_records/list_records_in_a_custom_table_for_a_product)\nyou must scope them to a product.\n\nOnce you have the ID of a specific custom table record, you can\n[get](/api/resources/custom_table_records/get_a_specific_custom_table_record),\n[modify](/api/resources/custom_table_records/update_a_custom_table_record),\nor\n[delete](/api/resources/custom_table_records/delete_a_custom_table_record)\nthem on the root custom table records resource.\n\n**[Custom tables](https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-tables) are an Enterprise+ exclusive feature.**", "tags": [ "Custom table records" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Key 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/CustomtablerecordsGetResponse" }, "example": { "custom_object_records": [ { "id": "8397122", "product_id": "131414752", "key": "customers", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "custom_fields": [ { "id": 564906240, "key": "name", "name": "Name", "updatedAt": "2019-01-01T00:00:00Z", "value": "Zane Corp", "type": "string" } ], "custom_object_links": [ { "key": "custom_table_name_link_many", "name": "Custom Table Linked Records", "record_type": "CustomObjectRecord", "record_ids": [ ] }, { "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": [ ] } ], "linked_records": [ ], "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" } }, { "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": [ ] } ], "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" } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/bookmarks/custom_pivots/{report_id}": { "get": { "summary": "Get the list view of a saved report", "description": "The list view responds with a JSON object with three attributes: pagination, columns, and rows.\n\nThe columns attribute is an array of objects that give detailed information\nabout the columns of the list. The objects include the name of the table, the field, and\na human readable title attribute.\n\nThe rows attribute is an of array of arrays. Each object within the inner array contains the value\nof that for a specific column. Each object contains attributes for various representations of the\ndata. The fields are:\n\n - `id`: The unique id of the object\n - `plain_value`: A string representation of the object\n - `html_value`: An HTML representation of the object. This is the same HTML that\n is used in Aha! to represent the value in our reports.\n - `rich_value`: If the object is a reference to another object (such as a tag),\n the, this will be the object representation. For instance, a tag would be\n representated as:\n ```\n {\n id: \"6013053275679792248\",\n name: \"API\"\n }\n ```\n\nThe third attribute is pagination. This works like everywhere else in the Aha! API and is documented [here](/api#pagination).", "tags": [ "Custom pivots" ], "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReportId identifier" }, { "name": "view", "in": "query", "required": false, "schema": { "type": "string" }, "example": "list" } ], "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/CustompivotsGetResponse" }, "example": { "top_level_columns": [ 1, 2, 3 ], "columns": { "1": { "ref": 1, "parent_ref": null, "child_refs": [ ], "id": 131414752, "plain_value": "Project 1", "html_value": "Project 1", "rich_value": "Project 1", "field_definition_ref": 7 }, "2": { "ref": 2, "parent_ref": null, "child_refs": [ ], "id": 517761884, "plain_value": "Project 2", "html_value": "Project 2", "rich_value": "Project 2", "field_definition_ref": 7 }, "3": { "ref": 3, "parent_ref": null, "child_refs": [ ], "id": 702241743, "plain_value": "Project 3", "html_value": "Project 3", "rich_value": "Project 3", "field_definition_ref": 7 } }, "top_level_rows": [ 4, 5, 6 ], "rows": { "4": { "ref": 4, "parent_ref": null, "child_refs": [ ], "id": 278327321, "plain_value": "Release 1", "html_value": "Release 1", "rich_value": "Release 1", "field_definition_ref": 8 }, "5": { "ref": 5, "parent_ref": null, "child_refs": [ ], "id": 1000426269, "plain_value": "Release 2", "html_value": "Release 2", "rich_value": "Release 2", "field_definition_ref": 8 }, "6": { "ref": 6, "parent_ref": null, "child_refs": [ ], "id": 342040612, "plain_value": "Release 3 Project 3", "html_value": "Release 3 Project 3", "rich_value": "Release 3 Project 3", "field_definition_ref": 8 } }, "cells": [ [ [ [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 1055237874, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 1007868956, "plain_value": "PRJ1-1", "html_value": "PRJ1-1", "rich_value": "PRJ1-1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 1007868956, "plain_value": "Feature 1", "html_value": "Feature 1", "rich_value": "Feature 1", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 1007868956, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": 444379319, "plain_value": "John Long (john@long.com)", "html_value": "John Long (john@long.com)", "rich_value": { "id": 1056507375, "name": "John Long (john@long.com)" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 622562724, "plain_value": "PRJ1-2", "html_value": "PRJ1-2", "rich_value": "PRJ1-2", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 622562724, "plain_value": "Another Feature", "html_value": "Another Feature", "rich_value": "Another Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 622562724, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 303873333, "plain_value": "PRJ1-3", "html_value": "PRJ1-3", "rich_value": "PRJ1-3", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 303873333, "plain_value": "Another Third Feature", "html_value": "Another Third Feature", "rich_value": "Another Third Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 303873333, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 209201304, "plain_value": "PRJ1-4", "html_value": "PRJ1-4", "rich_value": "PRJ1-4", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 209201304, "plain_value": "Another Fourth Feature", "html_value": "Another Fourth Feature", "rich_value": "Another Fourth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 209201304, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ], [ { "id": 998184963, "plain_value": "PRJ1-5", "html_value": "PRJ1-5", "rich_value": "PRJ1-5", "row_ref": 4, "column_ref": 1, "field_definition_ref": 9 }, { "id": 998184963, "plain_value": "Another Fifth Feature", "html_value": "Another Fifth Feature", "rich_value": "Another Fifth Feature", "row_ref": 4, "column_ref": 1, "field_definition_ref": 10 }, { "id": 998184963, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 4, "column_ref": 1, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 4, "column_ref": 1, "field_definition_ref": 12 } ] ], [ ], [ ] ], [ [ ], [ [ { "id": 101074039, "plain_value": "PRJ2-1", "html_value": "PRJ2-1", "rich_value": "PRJ2-1", "row_ref": 5, "column_ref": 2, "field_definition_ref": 9 }, { "id": 101074039, "plain_value": "A feature in project 2", "html_value": "A feature in project 2", "rich_value": "A feature in project 2", "row_ref": 5, "column_ref": 2, "field_definition_ref": 10 }, { "id": 101074039, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 5, "column_ref": 2, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 5, "column_ref": 2, "field_definition_ref": 12 } ] ], [ ] ], [ [ ], [ ], [ [ { "id": 229579240, "plain_value": "PRJ3-1", "html_value": "PRJ3-1", "rich_value": "PRJ3-1", "row_ref": 6, "column_ref": 3, "field_definition_ref": 9 }, { "id": 229579240, "plain_value": "Feature without Requirements", "html_value": "Feature without Requirements", "rich_value": "Feature without Requirements", "row_ref": 6, "column_ref": 3, "field_definition_ref": 10 }, { "id": 229579240, "plain_value": "New", "html_value": "New", "rich_value": { "id": 934242751, "name": "New", "color": "dce7c6" }, "row_ref": 6, "column_ref": 3, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 6, "column_ref": 3, "field_definition_ref": 12 } ], [ { "id": 959120953, "plain_value": "PRJ3-2", "html_value": "PRJ3-2", "rich_value": "PRJ3-2", "row_ref": 6, "column_ref": 3, "field_definition_ref": 9 }, { "id": 959120953, "plain_value": "A third Feature", "html_value": "A third Feature", "rich_value": "A third Feature", "row_ref": 6, "column_ref": 3, "field_definition_ref": 10 }, { "id": 959120953, "plain_value": "Designed", "html_value": "Designed", "rich_value": { "id": 962984386, "name": "Designed", "color": "ecdd8f" }, "row_ref": 6, "column_ref": 3, "field_definition_ref": 11 }, { "id": null, "plain_value": null, "html_value": null, "rich_value": null, "row_ref": 6, "column_ref": 3, "field_definition_ref": 12 } ] ] ] ], "field_definitions": { "7": { "ref": 7, "table": "projects", "field": "name", "title": "Workspace name" }, "8": { "ref": 8, "table": "releases", "field": "name", "title": "Release name" }, "9": { "ref": 9, "table": "features", "field": "reference_num", "title": "Feature reference #" }, "10": { "ref": 10, "table": "features", "field": "name", "title": "Feature name" }, "11": { "ref": 11, "table": "features", "field": "status", "title": "Feature status" }, "12": { "ref": 12, "table": "ideas", "field": "created_by_user_id", "title": "Idea created by" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/deletions": { "get": { "summary": "List contents of recycle bin", "description": "The recycle bin contains recently deleted workspaces, teams, and records. It is possible to restore items up to 7 days after they have been deleted.", "tags": [ "Deletions" ], "parameters": [ ], "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/DeletionsGetResponse" }, "example": { "deletions": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/deletions/{id}/restore": { "post": { "summary": "restore a specific record", "description": "The recycle bin contains recently deleted workspaces, teams, and records. It is possible to restore items up to 7 days after they have been deleted.", "tags": [ "Deletions" ], "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/DeletionsPostResponse" }, "example": { "deletion": { "status": "restore_in_progress", "record": { "name": "Feature 1", "type": "Feature", "reference_num": "PRJ1-1" }, "deleted_by": { "id": 1049303076, "name": "George Gently", "email": "no-reply@aha.io" }, "id": "6776881149497698683", "deleted_at": "2019-01-01T00:00:00.000Z" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics": { "get": { "summary": "List epics", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ ], "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/EpicsGetResponse" }, "example": { "epics": [ { "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": "531908612", "reference_num": "PRJ2-E-1", "name": "An epic in project 2", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/epics/PRJ2-E-1", "resource": "http://company.aha.io/api/v1/epics/PRJ2-E-1" }, { "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" } ], "pagination": { "total_records": 5, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/{release_id}/epics": { "get": { "summary": "List epics in a release", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/EpicsGetResponse" }, "example": { "epics": [ { "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" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create an epic", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/EpicsPostResponse" }, "example": { "epic": { "id": "6776881149493644653", "name": "New epics", "reference_num": "PRJ1-E-251", "initiative_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "601067208", "name": "Jeremy Smith", "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" }, "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": "6776881149489925368", "body": "New description", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ1-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-251", "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" } }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "epic_links": [ ], "master_feature_only_original_estimate": 58.0, "master_feature_only_remaining_estimate": 58.0, "master_feature_only_work_done": null, "epic_only_original_estimate": 58.0, "epic_only_remaining_estimate": 58.0, "epic_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpicsPostRequest" }, "example": { "epic": { "name": "New name", "description": "New description", "detailed_estimate_text": "58min" } } } } } } }, "/api/v1/products/{product_id}/epics": { "get": { "summary": "List epics in a product", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/EpicsGetResponse" }, "example": { "epics": [ { "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" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create an epic in the default release", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/EpicsPostResponse" }, "example": { "epic": { "id": "6776881149485403843", "name": "New name", "reference_num": "PRJ1-E-251", "initiative_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_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": "6776881149495498605", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ1-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-251", "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" } }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "epic_links": [ ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpicsPostRequest" }, "example": { "epic": { "name": "New name" } } } } } } }, "/api/v1/goals/{goal_id}/epics": { "get": { "summary": "List epics associated with a goal", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/EpicsGetResponse" }, "example": { "epics": [ { "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" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives/{initiative_id}/epics": { "get": { "summary": "List epics associated with an initiative", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/EpicsGetResponse" }, "example": { "epics": [ { "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" } ], "pagination": { "total_records": 4, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics/{id}": { "get": { "summary": "Get a specific epic", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "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/EpicsGetResponse" }, "example": { "epic": { "id": "999605892", "name": "Epic 1", "reference_num": "PRJ1-E-1", "initiative_reference_num": "PRJ1-S-1", "position": 1, "score": 42, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": "2019-01-01", "due_date": "2019-01-01", "product_id": "131414752", "progress": null, "progress_source": "progress_manual", "duration_source": "duration_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_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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "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", "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" } }, "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 }, "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" } ], "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": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ "Infrastructure" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" } ], "custom_fields": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ], "epic_links": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "delete": { "summary": "Delete an epic", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update an epic", "description": "Epics belong to releases. This means that if you want to create one then you must scope it to a release.\n\nYou can\n[list them all](/api/resources/epics/list_epics)\nat once, or filter by\n[release](/api/resources/epics/list_epics_in_a_release)\nor\n[product](/api/resources/epics/list_epics_in_a_product).\nAll these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific epic, you can\n[inspect](/api/resources/epics/get_a_specific_epic),\n[modify](/api/resources/epics/update_an_epic),\nor\n[delete](/api/resources/epics/delete_an_epic)\nthem on the root epics resource.", "tags": [ "Epics" ], "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/EpicsPutResponse" }, "example": { "epic": { "id": "999605892", "name": "Epic 1", "reference_num": "PRJ1-E-1", "initiative_reference_num": "PRJ1-S-1", "position": 1, "score": 42, "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", "duration_source": "duration_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_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": "4321567", "body": "Body of Epic Description", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ { "id": "790422735", "name": "id", "value": "433333335", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "907392375", "name": "key", "value": "JRA-1222223", "integration_id": 204584239, "service_name": "jira", "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", "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" } }, "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 }, "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" } ], "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": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ "Infrastructure" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" } ], "custom_fields": [ { "id": 1001163083, "key": "epic_custom_date", "name": "Epic custom date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" }, { "id": 1043080183, "key": "priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P2", "type": "string" } ], "epic_links": [ { "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record": { "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", "product_id": "131414752" }, "child_record": { "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", "product_id": "131414752" } } ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpicsPostRequest" }, "example": { "name": "New name", "description": "New description" } } } } } }, "/api/v1/capacity_investments/{id}/estimate_values": { "post": { "summary": "Create estimate values for a capacity investment", "description": "Estimate value objects should include the following keys: `team_id`, `period_start`, and `total`. This endpoint uses an \"upsert\" flow, updating existing records, or creating new ones if they do not exist. Returns all updated and destroyed estimate values, including computed sums and ignored values.", "tags": [ "Capacity estimate values" ], "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/CapacityestimatevaluesPostResponse" }, "example": { "updated": [ { "id": "6776881149487632203", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false }, { "id": "6776881149489311818", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149490125878", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149490529746", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149490943142", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149492175407", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149493726512", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149494705557", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149498133135", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149499236800", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false } ], "destroyed": [ ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityestimatevaluesPostRequest" }, "example": { "estimate_values": [ { "team_id": 949295028, "period_start": "2019-01-01", "total": 5 }, { "team_id": 949295028, "period_start": "2019-01-01", "total": 10 }, { "team_id": 563889676, "period_start": "2019-01-01", "total": 15 }, { "team_id": 563889676, "period_start": "2019-01-01", "total": 20 } ] } } } } }, "get": { "summary": "List estimate values for a capacity investment", "description": null, "tags": [ "Capacity estimate values" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/CapacityestimatevaluesGetResponse" }, "example": { "estimate_values": [ { "id": "6776881149483568838", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": true, "ignored": false }, { "id": "6776881149485225809", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149487362068", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false }, { "id": "6776881149487778568", "team_id": 563889676, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": false, "ignored": false }, { "id": "6776881149494637954", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": true, "ignored": false }, { "id": "6776881149497124166", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 5.0, "computed": false, "ignored": false }, { "id": "6776881149497859029", "team_id": 563889676, "team_membership_id": null, "period_start": null, "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149498218684", "team_id": null, "team_membership_id": null, "period_start": null, "total": 50.0, "computed": true, "ignored": false }, { "id": "6776881149498683658", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149498909376", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 15.0, "computed": true, "ignored": false } ], "pagination": { "total_records": 10, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/estimate_values/{id}": { "put": { "summary": "Update an estimate value", "description": "Returns all updated estimate values, including computed sums and ignored values.", "tags": [ "Capacity estimate values" ], "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/CapacityestimatevaluesPutResponse" }, "example": { "updated": [ { "id": "6776881149487468817", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 25.0, "computed": true, "ignored": false }, { "id": "6776881149490802007", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 35.0, "computed": true, "ignored": false }, { "id": "6776881149491123830", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 20.0, "computed": false, "ignored": false }, { "id": "6776881149492562019", "team_id": null, "team_membership_id": null, "period_start": null, "total": 60.0, "computed": true, "ignored": false } ], "destroyed": [ ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityestimatevaluesPostRequest" }, "example": { "estimate_value": { "total": 20 } } } } } }, "delete": { "summary": "Delete an estimate value", "description": "Returns all updated and destroyed estimate values, including computed sums and ignored values.", "tags": [ "Capacity estimate values" ], "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/CapacityestimatevaluesDeleteResponse" }, "example": { "updated": [ { "id": "6776881149491741642", "team_id": null, "team_membership_id": null, "period_start": null, "total": 40.0, "computed": true, "ignored": false }, { "id": "6776881149493435663", "team_id": null, "team_membership_id": null, "period_start": "2019-01-01", "total": 15.0, "computed": true, "ignored": false }, { "id": "6776881149496255620", "team_id": 949295028, "team_membership_id": null, "period_start": null, "total": 5.0, "computed": true, "ignored": false } ], "destroyed": [ { "id": "6776881149486253923", "team_id": 949295028, "team_membership_id": null, "period_start": "2019-01-01", "total": 10.0, "computed": false, "ignored": false } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapacityestimatevaluesPostRequest" }, "example": { } } } } } }, "/api/v1/releases/{release_id}/features": { "post": { "summary": "Create a feature", "description": "Creates a new feature in a release with full details including assignee and description", "tags": [ "Features" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/FeaturesPostResponse" }, "example": { "feature": { "id": "6776881149496854993", "name": "New feature", "reference_num": "PRJ1-251", "initiative_reference_num": null, "release_reference_num": "PRJ1-R-1", "epic_reference_num": null, "position": 1, "score": 13, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "962984386", "name": "Designed", "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" }, "description": { "id": "6776881149494125544", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/features/PRJ1-251", "resource": "http://company.aha.io/api/v1/features/PRJ1-251", "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" } }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "requirements": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ { "id": "6776881149484679393", "value": 3, "name": "Effort" }, { "id": "6776881149490073185", "value": 10, "name": "Benefit" } ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "feature_links": [ ], "workflow_status_times": [ { "status_id": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "feature_only_original_estimate": null, "feature_only_remaining_estimate": null, "feature_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeaturesPostRequest" }, "example": { "feature": { "name": "New name", "workflow_kind": "new", "workflow_status": { "name": "Designed" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } } } } }, "get": { "summary": "List features in a release", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/FeaturesGetResponse" }, "example": { "features": [ { "id": "209201304", "reference_num": "PRJ1-4", "name": "Another Fourth Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-4", "resource": "http://company.aha.io/api/v1/features/PRJ1-4", "product_id": "131414752" }, { "id": "303873333", "reference_num": "PRJ1-3", "name": "Another Third Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-3", "resource": "http://company.aha.io/api/v1/features/PRJ1-3", "product_id": "131414752" }, { "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" }, { "id": "998184963", "reference_num": "PRJ1-5", "name": "Another Fifth Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-5", "resource": "http://company.aha.io/api/v1/features/PRJ1-5", "product_id": "131414752" }, { "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" } ], "pagination": { "total_records": 5, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features": { "get": { "summary": "List features", "description": "Retrieves a paginated list of all features across the account with optional filtering and field selection", "tags": [ "Features" ], "parameters": [ ], "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/FeaturesGetResponse" }, "example": { "features": [ { "id": "101074039", "reference_num": "PRJ2-1", "name": "A feature in project 2", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ2-1", "resource": "http://company.aha.io/api/v1/features/PRJ2-1", "product_id": "517761884" }, { "id": "209201304", "reference_num": "PRJ1-4", "name": "Another Fourth Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-4", "resource": "http://company.aha.io/api/v1/features/PRJ1-4", "product_id": "131414752" }, { "id": "229579240", "reference_num": "PRJ3-1", "name": "Feature without Requirements", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ3-1", "resource": "http://company.aha.io/api/v1/features/PRJ3-1", "product_id": "702241743" }, { "id": "303873333", "reference_num": "PRJ1-3", "name": "Another Third Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-3", "resource": "http://company.aha.io/api/v1/features/PRJ1-3", "product_id": "131414752" }, { "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" }, { "id": "959120953", "reference_num": "PRJ3-2", "name": "A third Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ3-2", "resource": "http://company.aha.io/api/v1/features/PRJ3-2", "product_id": "702241743" }, { "id": "998184963", "reference_num": "PRJ1-5", "name": "Another Fifth Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-5", "resource": "http://company.aha.io/api/v1/features/PRJ1-5", "product_id": "131414752" }, { "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" } ], "pagination": { "total_records": 8, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics/{epic_id}/features": { "get": { "summary": "List features in an epic", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId 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/FeaturesGetResponse" }, "example": { "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" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/features": { "get": { "summary": "List features in a product", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/FeaturesGetResponse" }, "example": { "features": [ { "id": "209201304", "reference_num": "PRJ1-4", "name": "Another Fourth Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-4", "resource": "http://company.aha.io/api/v1/features/PRJ1-4", "product_id": "131414752" }, { "id": "303873333", "reference_num": "PRJ1-3", "name": "Another Third Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-3", "resource": "http://company.aha.io/api/v1/features/PRJ1-3", "product_id": "131414752" }, { "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" }, { "id": "998184963", "reference_num": "PRJ1-5", "name": "Another Fifth Feature", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/features/PRJ1-5", "resource": "http://company.aha.io/api/v1/features/PRJ1-5", "product_id": "131414752" }, { "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" } ], "pagination": { "total_records": 5, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/goals/{goal_id}/features": { "get": { "summary": "List features associated with a goal", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/FeaturesGetResponse" }, "example": { "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" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives/{initiative_id}/features": { "get": { "summary": "List features associated with an initiative", "description": "Features belong to releases.\nThis means that if you want to\n[create one](/api/resources/features/create_a_feature) then\nyou must scope it to a release.\n\nYou can return a result set which is unfiltered, or filter by\n[release](/api/resources/features/list_features_in_a_release)\n, [product](/api/resources/features/list_features_in_a_product)\n, or [epic](/api/resources/features/list_features_in_an_epic).\nAll these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.\n\nOnce you have the id of a specific feature, you can\n[inspect](/api/resources/features/get_a_specific_feature),\n[modify](/api/resources/features/update_a_feature),\nor\n[delete](/api/resources/features/delete_a_feature)\nthem on the root features resource.", "tags": [ "Features" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/FeaturesGetResponse" }, "example": { "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" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/{id}/convert_to_epic": { "post": { "summary": "Convert a feature to an epic", "description": "Converts an existing feature into an epic, maintaining all relationships and data", "tags": [ "Features" ], "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/FeaturesPostResponse" }, "example": { "": { "id": "6776881149483859492", "name": "A feature in project 2", "reference_num": "PRJ2-E-251", "initiative_reference_num": null, "position": 1000, "score": 0, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "517761884", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_status": { "id": "962984386", "name": "Designed", "position": 2, "complete": false, "color": "#ecdd8f" }, "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" }, "description": { "id": "6776881149487582254", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/epics/PRJ2-E-251", "resource": "http://company.aha.io/api/v1/epics/PRJ2-E-251", "release": { "id": "1000426269", "reference_num": "PRJ2-R-1", "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": "517761884", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ2-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, "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 }, "features": [ ], "goals": [ ], "key_results": [ ], "comments_count": 0, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "_links": [ ], "master_feature_only_original_estimate": null, "master_feature_only_remaining_estimate": null, "master_feature_only_work_done": null, "epic_only_original_estimate": null, "epic_only_remaining_estimate": null, "epic_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/idea_categories": { "get": { "summary": "List idea categories in a product", "description": null, "tags": [ "Idea categories" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/IdeacategoriesGetResponse" }, "example": { "idea_categories": [ { "id": "251347229", "name": "Usability", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "972845454", "name": "Hard disk drive", "parent_id": 552935478, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/idea_comments": { "post": { "summary": "Create an idea comment for an idea", "description": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden.", "tags": [ "Idea comments" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/IdeacommentsPostResponse" }, "example": { "idea_comment": { "id": "6776881149497092049", "idea_id": "58056975", "body": "

This is the comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeacommentsPostRequest" }, "example": { "idea_comment": { "idea_id": "PRJ1-I-1", "body": "

This is the comment body.

" } } } } } }, "get": { "summary": "List idea comments for an idea", "description": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden.", "tags": [ "Idea comments" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/IdeacommentsGetResponse" }, "example": { "idea_comments": [ { "id": "622085811", "idea_id": "58056975", "body": "This is a great idea! We'll get started right away.", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] }, { "id": "6776881149487056351", "idea_id": "58056975", "body": "A reply to a comment", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": 622085811, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] }, { "id": "6776881149491301288", "idea_id": "58056975", "body": "Just us employees", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to creator and employees", "parent_idea_comment_id": null, "idea_commenter_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_comments/{id}": { "put": { "summary": "Mark an idea comment as spam", "description": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden.", "tags": [ "Idea comments" ], "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/IdeacommentsPutResponse" }, "example": { "idea_comment": { "id": "622085811", "idea_id": "58056975", "body": "

Updated comment body.

", "created_at": "2019-01-01T00:00:00.000Z", "visibility": "Visible to all ideas portal users", "parent_idea_comment_id": null, "idea_commenter_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" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, "attachments": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeacommentsPostRequest" }, "example": { "idea_comment": { "spam": "true" } } } } } } }, "/api/v1/ideas/{idea_id}/idea_comments/{id}": { "delete": { "summary": "Delete an idea comment", "description": "Idea comments can appear in ideas portals.\nTo reply to an idea_comment, specify the parent_idea_comment_id. Its visibility\nwill come from its parent idea comment and cannot be overridden.", "tags": [ "Idea comments" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/endorsements": { "post": { "summary": "Create an idea vote", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/IdeavotesPostResponse" }, "example": { "idea_endorsement": { "id": "6776881149485303077", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": "2.0", "link": "https://example.com", "weight": 1, "endorsed_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" }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149495543710", "body": "This is a description", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeavotesPostRequest" }, "example": { "idea_endorsement": { "email": "no-reply@aha.io" } } } } } }, "get": { "summary": "List votes for an idea", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "example": "*,associated_idea_organizations" } ], "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/IdeavotesGetResponse" }, "example": { "idea_endorsements": [ { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_idea_user": { "id": "6776881149489779141", "name": "user@example.com", "email": "user@example.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "associated_idea_organizations": [ { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, { "id": "6776881149495446266", "name": "Widgets", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/6776881149495446266", "resource": "http://company.aha.io/api/v1/idea_organizations/6776881149495446266" } ], "description": { "id": "6776881149484433841", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/endorsements?multiple_endorsements=true": { "post": { "summary": "Create additional idea votes", "description": "Create an additional vote for a user who has already voted on the idea. Only permitted for an ideas portal where users are allowed multiple votes on the same idea.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "multiple_endorsements", "in": "query", "required": false, "schema": { "type": "string" }, "example": "true" } ], "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/IdeavotesPostResponse" }, "example": { "idea_endorsement": { "id": "6776881149490277785", "idea_id": "140490859", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "6776881149497726716", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "6776881149497315738", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ ], "custom_fields": [ ], "idea": { "id": "140490859", "reference_num": "PRJ1-I-8", "name": "Some idea name 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149495006288", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-8", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeavotesPostRequest" }, "example": { "idea_endorsement": { "email": "no-reply@aha.io" } } } } } } }, "/api/v1/ideas/{idea_id}/endorsements?idea_portal_id={idea_portal_id}": { "post": { "summary": "Create an idea vote for a user, using the vote limits of an idea portal", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "name": "idea_portal_id", "in": "query", "required": false, "schema": { "type": "string" }, "example": "747493361" } ], "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/IdeavotesPostResponse" }, "example": { "idea_endorsement": { "id": "6776881149496332684", "idea_id": "140490859", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "6776881149488700322", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "6776881149490328278", "name": "no-reply@aha.io", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ ], "custom_fields": [ ], "idea": { "id": "140490859", "reference_num": "PRJ1-I-8", "name": "Some idea name 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149487885666", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-8", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeavotesPostRequest" }, "example": { "idea_endorsement": { "email": "no-reply@aha.io", "idea_portal_id": 747493361 } } } } } } }, "/api/v1/ideas/endorsements": { "get": { "summary": "List votes for an account", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ ], "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/IdeavotesGetResponse" }, "example": { "idea_endorsements": [ { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, { "id": "260764892", "idea_id": "397084149", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "143214937", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "284648642", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, { "id": "377726308", "idea_id": "245519441", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "143214937", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "284648642", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, { "id": "449162139", "idea_id": "849214356", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, { "id": "562337269", "idea_id": "140490859", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "143214937", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "284648642", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, { "id": "1062165688", "idea_id": "444379319", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } }, { "id": "1071644760", "idea_id": "290908627", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "143214937", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "284648642", "name": "Joe Shmo", "email": "joe@shmo.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null } } ], "pagination": { "total_records": 7, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/endorsements?proxy=true": { "get": { "summary": "List only proxy votes for an idea", "description": "Only returns votes that have an associated organization (proxy votes).", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "proxy", "in": "query", "required": false, "schema": { "type": "string" }, "example": "true" } ], "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/IdeavotesGetResponse" }, "example": { "idea_endorsements": [ { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } }, { "id": "6776881149498445225", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_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" }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/endorsements/{id}": { "get": { "summary": "Get a specific vote for an idea", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "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/IdeavotesGetResponse" }, "example": { "idea_endorsement": { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "idea_users": [ { "id": "670061655", "first_name": "Tim", "last_name": "Smith", "email": "tim@smith.com" }, { "id": "1056507375", "first_name": "John", "last_name": "Long", "email": "john@long.com" } ], "description": { "id": "6776881149490876559", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update an idea vote", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "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/IdeavotesPutResponse" }, "example": { "idea_endorsement": { "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "", "body": "", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "6776881149489855953", "key": "vote_priority", "name": "Priority", "updatedAt": "2019-01-01T00:00:00Z", "value": "P3", "type": "string" } ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeavotesPostRequest" }, "example": { "idea_endorsement": { "value": 123.45 } } } } } }, "delete": { "summary": "Delete an idea vote", "description": "\"Idea votes\" in the web interface are referenced as \"idea endorsements\" from API endpoints.", "tags": [ "Idea votes" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_organizations": { "get": { "summary": "List idea organizations", "description": null, "tags": [ "Idea organizations" ], "parameters": [ ], "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/IdeaorganizationsGetResponse" }, "example": { "idea_organizations": [ { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, { "id": "290305227", "name": "FaceTube", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/290305227", "resource": "http://company.aha.io/api/v1/idea_organizations/290305227" } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create an idea organization", "description": null, "tags": [ "Idea organizations" ], "parameters": [ ], "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/IdeaorganizationsPostResponse" }, "example": { "idea_organization": { "id": "6776881149496968773", "name": "My organization", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/6776881149496968773", "description": { "id": "6776881149489955957", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_by_user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "endorsements_count": 0, "email_domains": "example.com, example.org", "revenue": "55000.0", "custom_fields": [ ], "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeaorganizationsPostRequest" }, "example": { "idea_organization": { "name": "My organization", "email_domains": "example.com, example.org", "revenue": "55000" } } } } } } }, "/api/v1/idea_organizations/{id}": { "get": { "summary": "Get a specific organization", "description": null, "tags": [ "Idea organizations" ], "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/IdeaorganizationsGetResponse" }, "example": { "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "description": { "id": "6776881149484915034", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "endorsements_count": 2, "email_domains": "", "revenue": null, "custom_fields": [ { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ], "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update organization", "description": null, "tags": [ "Idea organizations" ], "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/IdeaorganizationsPutResponse" }, "example": { "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "endorsements_count": 2, "email_domains": "", "revenue": null, "custom_fields": [ { "id": "6776881149493996495", "key": "industry", "name": "Industry", "updatedAt": "2019-01-01T00:00:00Z", "value": "retail", "type": "string" }, { "id": 957991743, "key": "org_equation_field", "name": "Org equation field", "updatedAt": "2019-01-01T00:00:00Z", "value": { "values": { "test": { "value": 10, "name": "a", "display_value": "10.0" } } }, "type": "equation_sheet" } ], "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeaorganizationsPostRequest" }, "example": { "idea_organization": { "name": "A new name" } } } } } }, "delete": { "summary": "Delete organization", "description": null, "tags": [ "Idea organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/idea_portals": { "get": { "summary": "List idea portals in a product", "description": null, "tags": [ "Idea Portals" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/IdeaPortalsGetResponse" }, "example": { "idea_portals": [ { "id": "297813804", "title": "Ideas 3", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal2.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "650606523", "title": "Ideas 2", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal1.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "1070474755", "title": "Ideas 1", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_portals": { "get": { "summary": "List all idea portals in an account", "description": null, "tags": [ "Idea Portals" ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "10" } ], "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/IdeaPortalsGetResponse" }, "example": { "idea_portals": [ { "id": "297813804", "title": "Ideas 3", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal2.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "650606523", "title": "Ideas 2", "portal_enabled": true, "access_type": "public", "external_url": "https://testideaportal1.ideas.aha.io:8338/", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "675900055", "title": "portal with 1 endorsement per idea", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal3.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "747493361", "title": "portal with 2 endorsements per idea", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal4.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "1070474755", "title": "Ideas 1", "portal_enabled": true, "access_type": "submit-only", "external_url": "https://testideaportal.ideas.aha.io:8338/ideas/new", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 5, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/subscriptions": { "post": { "summary": "Create an idea subscription", "description": null, "tags": [ "Idea subscriptions" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/IdeasubscriptionsPostResponse" }, "example": { "idea_subscription": { "id": "6776881149499782711", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "6776881149490241023", "name": "username@example.com", "email": "username@example.com", "created_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeasubscriptionsPostRequest" }, "example": { "idea_subscription": { "email": "username@example.com" } } } } } }, "get": { "summary": "List subscriptions for an idea", "description": null, "tags": [ "Idea subscriptions" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/IdeasubscriptionsGetResponse" }, "example": { "idea_subscriptions": [ { "id": "783147498", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/subscriptions/{id}": { "get": { "summary": "Get a specific subscription for an idea", "description": null, "tags": [ "Idea subscriptions" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "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/IdeasubscriptionsGetResponse" }, "example": { "idea_subscription": { "id": "783147498", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "delete": { "summary": "Delete an idea subscription", "description": null, "tags": [ "Idea subscriptions" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_users": { "post": { "summary": "Create a idea user", "description": null, "tags": [ "Idea users" ], "parameters": [ ], "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/IdeausersPostResponse" }, "example": { "idea_user": { "id": "6776881149489958901", "name": "sam doe", "email": "sam.doe@example.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeausersPostRequest" }, "example": { "idea_user": { "email": "sam.doe@example.com", "first_name": "sam", "last_name": "doe" } } } } } }, "get": { "summary": "List idea users for an account", "description": null, "tags": [ "Idea users" ], "parameters": [ ], "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/IdeausersGetResponse" }, "example": { "idea_users": [ { "id": "55650758", "name": "Sir Mixalot", "email": "spins@example.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "244576613", "name": "Sammy Smith", "email": "sammy@smith.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "284648642", "name": "Joe Shmo", "email": "joe@shmo.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "446386906", "name": "Timmy Smith", "email": "timmy@smith.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "670061655", "name": "Tim Smith", "email": "tim@smith.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "761219305", "name": "Mr Scrooge", "email": "lot@example.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" } ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "870840916", "name": "Bill Billings", "email": "no-reply@aha.io", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "966050294", "name": "John Long", "email": "johnvery@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] }, { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } ], "pagination": { "total_records": 9, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_users/{id}": { "get": { "summary": "Get a specific idea user", "description": null, "tags": [ "Idea users" ], "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/IdeausersGetResponse" }, "example": { "idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ { "id": "6776881149490597073", "key": "text_field", "name": "TextField", "updatedAt": "2019-01-01T00:00:00Z", "value": "the value for the field", "type": "string" } ], "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update an idea user", "description": null, "tags": [ "Idea users" ], "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/IdeausersPutResponse" }, "example": { "idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "discovery_interview_count": 0, "discovery_last_invite": null, "discovery_last_interview": null, "discovery_next_interview": null, "created_at": "2019-01-01T00:00:00.000Z", "idea_organizations": [ ], "custom_fields": [ ], "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeausersPostRequest" }, "example": { "idea_user": { "first_name": "Sarah" } } } } } }, "delete": { "summary": "Delete an idea user", "description": null, "tags": [ "Idea users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/ideas": { "post": { "summary": "Create an idea", "description": "Creates a new idea with basic details including initial vote count", "tags": [ "Ideas" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/IdeasPostResponse" }, "example": { "idea": { "id": "6776881149487483845", "name": "Comprehensive Feature Request", "reference_num": "PRJ1-I-10", "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "votes": 15, "initial_votes": 15, "status_changed_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149489364397", "body": "

Problem Statement

Users need better mobile experience

Proposed Solution

Native mobile app with offline capabilities

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "visibility": "Visible to all ideas portal users", "admin_response": { "id": "6776881149492320383", "body": "Great idea! This aligns with our mobile strategy roadmap. We'll evaluate this for Q3 implementation.", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ], "responded_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" } }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-10", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-10", "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_portal_user": { "id": "384687358", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z" }, "created_by_idea_user": { "id": "244576613", "name": "Sammy Smith", "email": "sammy@smith.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "assigned_to_user": null, "endorsements_count": 0, "comments_count": 0, "score_facts": [ ], "tags": [ "mobile", "offline", "performance", "UX" ], "full_tags": [ { "id": "6776881149483567678", "name": "performance", "color": "#e05298" }, { "id": "6776881149486951248", "name": "UX", "color": "#a952e0" }, { "id": "6776881149488941674", "name": "mobile", "color": "#bae052" }, { "id": "6776881149490298781", "name": "offline", "color": "#9ae052" } ], "categories": [ { "id": "552935478", "name": "Storage", "parent_id": null, "project_id": 131414752, "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "workflow_status_times": [ { "status_id": "3259216", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "submitted_idea_portal_record_url": "https://testideaportal1.ideas.aha.io:8338/ideas/PRJ1-I-10", "integration_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeasPostRequest" }, "example": { "idea": { "name": "New idea", "description": "

This is the description

", "initial_votes": 3 } } } } } }, "get": { "summary": "List ideas for a product", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/IdeasGetResponse" }, "example": { "ideas": [ { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, { "id": "68691224", "reference_num": "PRJ1-I-12", "name": "Idea 5", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149495843340", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-12", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12" }, { "id": "162120796", "reference_num": "PRJ1-I-5", "name": "Idea 4", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "478357480", "body": "Description of idea custom tables", "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/ideas/ideas/PRJ1-I-5", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5" }, { "id": "444379319", "reference_num": "PRJ1-I-2", "name": "Idea 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "378547141", "body": "Description of idea 2", "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/ideas/ideas/PRJ1-I-2", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2" }, { "id": "857675141", "reference_num": "PRJ1-I-11", "name": "Idea 004", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149485861297", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-11", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11" }, { "id": "1055237874", "reference_num": "PRJ1-I-3", "name": "Idea 3 Merged", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "506957205", "body": "Description of idea 3", "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/ideas/ideas/PRJ1-I-3", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3" } ], "pagination": { "total_records": 6, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas": { "get": { "summary": "List ideas", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "parameters": [ ], "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/IdeasGetResponse" }, "example": { "ideas": [ { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" }, { "id": "68691224", "reference_num": "PRJ1-I-12", "name": "Idea 5", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149484500966", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-12", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-12" }, { "id": "140490859", "reference_num": "PRJ1-I-8", "name": "Some idea name 3", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149490665511", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-8", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-8" }, { "id": "162120796", "reference_num": "PRJ1-I-5", "name": "Idea 4", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "478357480", "body": "Description of idea custom tables", "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/ideas/ideas/PRJ1-I-5", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-5" }, { "id": "245519441", "reference_num": "PRJ1-I-7", "name": "Some idea name 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "716451363", "body": "Description of idea endorsement 2", "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/ideas/ideas/PRJ1-I-7", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-7" }, { "id": "290908627", "reference_num": "PRJ1-I-9", "name": "Some idea name 4", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149497367311", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-9", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-9" }, { "id": "397084149", "reference_num": "PRJ1-I-6", "name": "Some idea name 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "868056987", "body": "Description of idea endorsement 1", "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/ideas/ideas/PRJ1-I-6", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-6" }, { "id": "444379319", "reference_num": "PRJ1-I-2", "name": "Idea 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "378547141", "body": "Description of idea 2", "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/ideas/ideas/PRJ1-I-2", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-2" }, { "id": "731163180", "reference_num": "PRJ2-I-2", "name": "Idea 2 project 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "928262307", "body": "Description of idea 2 project2", "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/ideas/ideas/PRJ2-I-2", "resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-2" }, { "id": "849214356", "reference_num": "PRJ2-I-1", "name": "Idea 1 project 2", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ2-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ2-I-1" }, { "id": "857675141", "reference_num": "PRJ1-I-11", "name": "Idea 004", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "6776881149494084357", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-11", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-11" }, { "id": "926598431", "reference_num": "PRJ5-I-1", "name": "Idea 1 Project 5", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "6776881149487190134", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ5-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ5-I-1" }, { "id": "1055237874", "reference_num": "PRJ1-I-3", "name": "Idea 3 Merged", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, "description": { "id": "506957205", "body": "Description of idea 3", "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/ideas/ideas/PRJ1-I-3", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-3" } ], "pagination": { "total_records": 13, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{id}?fields=description,plain_text_body": { "get": { "summary": "Get a specific idea with plain text body", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "example": "description,plain_text_body" } ], "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/IdeasGetResponse" }, "example": { "idea": { "id": "58056975", "product_id": "131414752", "description": { "id": "103757394", "body": "

Description of idea 1

", "plain_text_body": "Description of idea 1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/related": { "get": { "summary": "List ideas related to a particular term", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string" }, "example": "ideas are a dime a dozen" } ], "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/IdeasGetResponse" }, "example": { "ideas": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{id}/promote": { "put": { "summary": "Promote an idea", "description": "When creating an idea where the creator is an idea user we strongly suggest\nto provide the `submitted_idea_portal_id` attribute to the idea\nto ensure that the idea is created in the correct ideas portal and the user\ngets access to the portal.\n\nIf you don't want the idea to be submitted to any portal, you can skip this\nby setting `skip_portal: true` in the request body.", "tags": [ "Ideas" ], "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": "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": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeasPostRequest" }, "example": { "promotable_type": "feature", "release_id": 278327321 } } } } } }, "/api/v1/identity_providers": { "get": { "summary": "List active identity providers that can be used for SSO", "description": null, "tags": [ "Identity providers" ], "parameters": [ ], "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/IdentityprovidersGetResponse" }, "example": { "identity_providers": [ { "id": "483954339", "enabled": true, "name": "notebook", "sso_endpoint": "https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/identity_providers/{id}": { "get": { "summary": "Get a specific identity provider", "description": null, "tags": [ "Identity providers" ], "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/IdentityprovidersGetResponse" }, "example": { "identity_provider": { "id": "483954339", "enabled": true, "name": "notebook", "sso_endpoint": "https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/initiatives": { "post": { "summary": "Create an initiative", "description": null, "tags": [ "Initiatives" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/InitiativesPostResponse" }, "example": { "initiative": { "id": "6776881149487133341", "name": "Assigned Initiative", "reference_num": "PRJ1-S-251", "status": "not_started", "effort": 95, "value": 40, "presented": true, "color": "#397e82", "start_date": null, "end_date": null, "position": 3, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "url": "http://company.aha.io/initiatives/PRJ1-S-251", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-251", "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": "6776881149499189237", "body": "Initiative with assignee", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "assigned_to_user": { "id": "1049303076", "name": "George Gently", "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": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ], "workflow_status_times": [ { "status_id": "53968949", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiativesPostRequest" }, "example": { "initiative": { "name": "Initiative 3", "workflow_status": { "name": "Not Started" }, "description": "Our first big initiative", "time_frame": { "id": 813624702 }, "effort": 15, "value": 5, "presented": true } } } } } }, "get": { "summary": "List initiatives in a product", "description": null, "tags": [ "Initiatives" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/InitiativesGetResponse" }, "example": { "initiatives": [ { "id": "4125886", "name": "Initiative 2", "reference_num": "PRJ1-S-2", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-2", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-2", "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": "824706757", "body": "Description of initiative 2", "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": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ], "created_by_user": { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "219956332", "name": "Initiative 3", "reference_num": "PRJ1-S-3", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-3", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-3", "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": "338250583", "body": "Description of project1_initiative3_no_epoch", "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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "id": "259736534", "name": "Initiative 5", "reference_num": "PRJ1-S-5", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-5", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-5", "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": "1040636124", "body": "Description of project1_initiative5_archived_epoch", "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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "time_frame": { "id": 834757622, "name": "2018" }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "id": "330016191", "name": "Initiative 4", "reference_num": "PRJ1-S-4", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-4", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-4", "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": "999437064", "body": "Description of project1_initiative4_active_epoch", "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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "time_frame": { "id": 273422810, "name": "2017" }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "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": [ ] } } ], "key_results": [ ], "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" } ], "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" } }, { "id": "595848429", "name": "Initiative complete", "reference_num": "PRJ1-S-11", "status": "done", "effort": 10, "value": 70, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 1, "score": 0, "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-11", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-11", "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": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, "description": { "id": "6776881149492436002", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] } ], "pagination": { "total_records": 6, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives": { "get": { "summary": "List initiatives", "description": null, "tags": [ "Initiatives" ], "parameters": [ ], "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/InitiativesGetResponse" }, "example": { "initiatives": [ { "id": "4125886", "name": "Initiative 2", "reference_num": "PRJ1-S-2", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-2", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-2", "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": "824706757", "body": "Description of initiative 2", "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": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ], "created_by_user": { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "219956332", "name": "Initiative 3", "reference_num": "PRJ1-S-3", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-3", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-3", "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": "338250583", "body": "Description of project1_initiative3_no_epoch", "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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "id": "259736534", "name": "Initiative 5", "reference_num": "PRJ1-S-5", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-5", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-5", "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": "1040636124", "body": "Description of project1_initiative5_archived_epoch", "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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "time_frame": { "id": 834757622, "name": "2018" }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "id": "330016191", "name": "Initiative 4", "reference_num": "PRJ1-S-4", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 2, "score": 0, "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-4", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-4", "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": "999437064", "body": "Description of project1_initiative4_active_epoch", "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": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "time_frame": { "id": 273422810, "name": "2017" }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "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": [ ] } } ], "key_results": [ ], "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" } ], "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" } }, { "id": "595848429", "name": "Initiative complete", "reference_num": "PRJ1-S-11", "status": "done", "effort": 10, "value": 70, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 1, "score": 0, "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-11", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-11", "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": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, "description": { "id": "6776881149496245106", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": true }, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] }, { "id": "1042392694", "name": "Workspace line initiative 1", "reference_num": "PL1-S-1", "status": "not_started", "effort": 40, "value": 30, "presented": true, "color": "#bada55", "start_date": null, "end_date": null, "position": 1, "score": 0, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "610602692", "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "url": "http://company.aha.io/initiatives/PL1-S-1", "resource": "http://company.aha.io/api/v1/initiatives/PL1-S-1", "project": { "id": "610602692", "reference_prefix": "PL1", "name": "Product Line 1", "product_line": true, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PL1" }, "workflow_status": { "id": "53968949", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, "description": { "id": "133079347", "body": "Description of product_line1_initiative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "attachments": [ ], "assigned_to_user": null, "comments_count": 0, "goals": [ ], "key_results": [ ], "score_facts": [ ], "integration_fields": [ ] } ], "pagination": { "total_records": 7, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/goals/{goal_id}/initiatives": { "get": { "summary": "List initiatives associated with a goal", "description": null, "tags": [ "Initiatives" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/InitiativesGetResponse" }, "example": { "initiatives": [ { "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": [ ] } } ], "key_results": [ ], "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" } ], "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" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/initiatives/{id}": { "put": { "summary": "Update an initiative", "description": null, "tags": [ "Initiatives" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "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/InitiativesPutResponse" }, "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": 25, "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": [ ] } } ], "key_results": [ ], "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" } ], "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/InitiativesPostRequest" }, "example": { "initiative": { "name": "Smarter initiative" } } } } } }, "delete": { "summary": "Delete an initiative", "description": null, "tags": [ "Initiatives" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/integration_changes": { "post": { "summary": "Send a record to an integration", "description": "This endpoint mimicks the \"Send to integration\" button on a record in the UI.", "tags": [ "Integration changes" ], "parameters": [ ], "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/IntegrationchangesPostResponse" }, "example": { "status": "success" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationchangesPostRequest" }, "example": { "integration_id": 204584239, "model_class": "Feature", "model_id": 1007868956 } } } } } }, "/api/v1/features/{feature_id}/integrations/{integration_id}/fields": { "post": { "summary": "Create an integration field for a feature by integration ID", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId 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/IntegrationfieldsPostResponseArrayInteger" }, "example": [ 728894778, 846945422 ] } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationfieldsPostRequest" }, "example": { "integration_field": { "name": "key", "value": "JRA-34" } } } } } } }, "/api/v1/features/{feature_id}/integrations/{service_name}/fields": { "post": { "summary": "Create an integration field for a feature by service name", "description": "DEPRECATED: provide :integration_id rather than :service_name to identify the integration.", "tags": [ "Integration fields" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId identifier" }, { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ServiceName 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/IntegrationfieldsPostResponseArrayInteger" }, "example": [ 728894778, 846945422 ] } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationfieldsPostRequest" }, "example": { "integration_field": { "name": "key", "value": "JRA-34" } } } } } } }, "/api/v1/epics/{epic_id}/integrations/{integration_id}/fields": { "post": { "summary": "Create an integration field for a epic by integration ID", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId 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/IntegrationfieldsPostResponseArrayInteger" }, "example": [ 907392375, 790422735 ] } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationfieldsPostRequest" }, "example": { "integration_field": { "name": "key", "value": "JRA-34" } } } } } } }, "/api/v1/idea_endorsements/{idea_endorsement_id}/integrations/{integration_id}/fields": { "post": { "summary": "Create an integration field for an idea vote", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "idea_endorsement_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaEndorsementId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId 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/IntegrationfieldsPostResponse" }, "example": { "integration_field": { "id": "975466318", "name": "key", "value": "JRA-34", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z", "integratable": { "url": "http://company.aha.io/ideas/idea_endorsements/53377392", "resource": "http://company.aha.io/api/v1/ideas/idea_endorsements/53377392" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationfieldsPostRequest" }, "example": { "integration_field": { "name": "key", "value": "JRA-34" } } } } } } }, "/api/v1/ideas/{idea_id}/integrations/{integration_id}/fields": { "post": { "summary": "Create an integration field for an idea by integration ID", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId 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/IntegrationfieldsPostResponseArrayString" }, "example": [ "6776881149484343025", "6776881149496067156" ] } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationfieldsPostRequest" }, "example": { "integration_field": { "name": "key", "value": "JRA-34" } } } } } } }, "/api/v1/features/{feature_id}/integrations/{integration_id}/fields/{field_name}": { "get": { "summary": "Get a specific integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId identifier" }, { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName 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/IntegrationfieldsGetResponse" }, "example": { "integration_field": { "id": "728894778", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z", "integratable": { "url": "http://company.aha.io/features/PRJ1-1", "resource": "http://company.aha.io/api/v1/features/PRJ1-1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/integrations/{integration_id}/fields/{field_name}/value/{field_value}": { "get": { "summary": "List records with an associated integration field value", "description": "Possible records are releases, initiatives, features, epics, requirements, ideas or idea votes.", "tags": [ "Integration fields" ], "parameters": [ { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId identifier" }, { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ { "feature": { "integration_id": 204584239, "service_name": "jira", "id": "1007868956", "name": "Feature 1", "reference_num": "PRJ1-1", "initiative_reference_num": "PRJ1-S-1", "release_reference_num": "PRJ1-R-1", "epic_reference_num": "PRJ1-E-1", "position": 1, "score": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": "2019-01-01", "due_date": "2019-01-01", "product_id": "131414752", "progress": null, "progress_source": "progress_manual", "status_changed_on": null, "created_by_user": { "id": "16338845", "name": "John Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "6776881149486698824", "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": "6776881149489728999", "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": [ ] } } ], "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 } }, { "idea_endorsement": { "integration_id": 204584239, "service_name": "jira", "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149497389948", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/fields/{field_name}/value/{field_value}": { "get": { "summary": "List releases with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives/fields/{field_name}/value/{field_value}": { "get": { "summary": "List initiatives with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/fields/{field_name}/value/{field_value}": { "get": { "summary": "List features with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ { "feature": { "integration_id": 204584239, "service_name": "jira", "id": "1007868956", "name": "Feature 1", "reference_num": "PRJ1-1", "initiative_reference_num": "PRJ1-S-1", "release_reference_num": "PRJ1-R-1", "epic_reference_num": "PRJ1-E-1", "position": 1, "score": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": "2019-01-01", "due_date": "2019-01-01", "product_id": "131414752", "progress": null, "progress_source": "progress_manual", "status_changed_on": null, "created_by_user": { "id": "16338845", "name": "John Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "6776881149483513065", "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": "6776881149483817846", "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": [ ] } } ], "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 } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics/fields/{field_name}/value/{field_value}": { "get": { "summary": "List epics with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/requirements/fields/{field_name}/value/{field_value}": { "get": { "summary": "List requirements with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/fields/{field_name}/value/{field_value}": { "get": { "summary": "List ideas with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_endorsements/fields/{field_name}/value/{field_value}": { "get": { "summary": "List idea votes with an associated integration field value", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "field_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldName identifier" }, { "name": "field_value", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FieldValue 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/IntegrationfieldsGetResponse" }, "example": { "records": [ { "idea_endorsement": { "integration_id": 204584239, "service_name": "jira", "id": "53377392", "idea_id": "58056975", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "value": null, "link": null, "weight": 1, "endorsed_by_portal_user": { "id": "646391926", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z" }, "endorsed_by_idea_user": { "id": "1056507375", "name": "John Long", "email": "john@long.com", "created_at": "2019-01-01T00:00:00.000Z", "title": null }, "idea_organization": { "id": "138732915", "name": "Acme", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/ideas/idea_organizations/138732915", "resource": "http://company.aha.io/api/v1/idea_organizations/138732915" }, "description": { "id": "6776881149485668658", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ { "id": "975466318", "name": "key", "value": "JRA-123", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ ], "idea": { "id": "58056975", "reference_num": "PRJ1-I-1", "name": "Idea 1", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "workflow_status": { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": [ ] }, "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1", "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1" } } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/integration_fields/{id}": { "delete": { "summary": "Delete an integration field", "description": null, "tags": [ "Integration fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/integrations": { "post": { "summary": "Create an integration for an account", "description": null, "tags": [ "Integrations" ], "parameters": [ ], "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/IntegrationsPostResponse" }, "example": { "integration": { "id": "6776881149498164474", "service_name": "zendesk", "template_id": null, "name": "Zendesk", "enabled": true, "callback_token": "5e0c51800087c7f9", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/6776881149498164474", "resource": "http://company.aha.io/api/v1/integrations/6776881149498164474", "owner": { "type": "Account", "id": "303742481", "url": "http://company.aha.io/account/303742481", "resource": "http://company.aha.io/account/303742481" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostRequest" }, "example": { "integration": { "service_name": "zendesk", "enabled": true } } } } } }, "get": { "summary": "List integrations for an account", "description": null, "tags": [ "Integrations" ], "parameters": [ ], "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/IntegrationsGetResponse" }, "example": { "integrations": [ { "id": "79015308", "name": "Salesforce", "service_name": "salesforce", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "84619270", "name": "Salesforce V2", "service_name": "salesforce", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "163322775", "name": "Activity webhook", "service_name": "audit_webhook", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "241856910", "name": "Trello", "service_name": "trello", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "390243673", "name": "Zendesk", "service_name": "zendesk", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "578818383", "name": "Aha! (to Slack)", "service_name": "slack", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "828392279", "name": "Security webhook", "service_name": "security_webhook", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "922472543", "name": "Aha! (from Slack)", "service_name": "slack_commands", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "938531265", "name": "Aha! (from Slack)", "service_name": "slack_commands", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 9, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/integrations": { "post": { "summary": "Create an integration for a product", "description": null, "tags": [ "Integrations" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/IntegrationsPostResponse" }, "example": { "integration": { "id": "6776881149497259401", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "5e0c518000b1e19f", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/6776881149497259401", "resource": "http://company.aha.io/api/v1/integrations/6776881149497259401", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostRequest" }, "example": { "integration": { "service_name": "zendesk", "enabled": true } } } } } }, "get": { "summary": "List integrations for a product", "description": null, "tags": [ "Integrations" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/IntegrationsGetResponse" }, "example": { "integrations": [ { "id": "31907509", "name": "Rally", "service_name": "rally", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "36231792", "name": "GitHub Issues", "service_name": "github_issues", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "186281709", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "202598724", "name": "Jira via Connect", "service_name": "jira_connect", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "204584239", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "207648948", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "222276392", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "322044925", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "342659513", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "386928799", "name": "Azure DevOps Services", "service_name": "vsts", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "413207847", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "453754848", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "550349479", "name": "Jira via Connect", "service_name": "jira_connect", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "583937884", "name": "Jira template (visible to all)", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "706216981", "name": "Rally", "service_name": "rally", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "791044582", "name": "Azure DevOps Services", "service_name": "vsts", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "804274302", "name": "Jira V2 Disabled", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "846899991", "name": "Azure DevOps Services", "service_name": "tfs", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "868040294", "name": "Rally", "service_name": "rally", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "945767377", "name": "Trello", "service_name": "trello", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "952935179", "name": "Jira", "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 21, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/integrations/{integration_id}": { "get": { "summary": "Get a specific integration", "description": null, "tags": [ "Integrations" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId 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/IntegrationsGetResponse" }, "example": { "integration": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Enable integration", "description": null, "tags": [ "Integrations" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "integration_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IntegrationId 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/IntegrationsPutResponse" }, "example": { "integration": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsPostRequest" }, "example": { "integration": { "enabled": true } } } } } } }, "/api/v1/products/{product_id}/integrations/{service_name}": { "get": { "summary": "Get a specific integration by service name", "description": "DEPRECATED: provide :integration_id rather than :service_name to identify the integration.", "tags": [ "Integrations" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ServiceName 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/IntegrationsGetResponse" }, "example": { "integration": { "id": "204584239", "service_name": "jira", "template_id": null, "name": "Jira", "enabled": true, "callback_token": "22b7893e7fa1c4c60847090f78fbf0ec", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "last_error_at": null, "last_webhook_request_at": null, "url": "http://company.aha.io/integrations/204584239", "resource": "http://company.aha.io/api/v1/integrations/204584239", "jql_filter": null, "owner": { "type": "Project", "id": "131414752", "url": "http://company.aha.io/projects/PRJ1", "resource": "http://company.aha.io/projects/PRJ1" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/goals/{goal_id}/key_results": { "get": { "summary": "List key results for a goal", "description": null, "tags": [ "Key results" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/KeyresultsGetResponse" }, "example": { "key_results": [ { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "6776881149488268212", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ ] }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null, "description": { "id": "6776881149485267751", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ ] } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create a key result", "description": null, "tags": [ "Key results" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/KeyresultsPostResponse" }, "example": { "key_result": { "id": "6776881149483625245", "name": "New name", "reference_num": "DEMOENT-G-1-KR-1", "position": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": 0, "target_metric": null, "starting_metric": null, "current_metric": null, "description": { "id": "6776881149493544532", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "default_assignee": false }, "workflow_status": { "id": "76947914", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyresultsPostRequest" }, "example": { "key_result": { "name": "New name", "workflow_status": { "name": "On track" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } } } } } }, "/api/v1/key_results/{id}": { "get": { "summary": "Get a specific key result", "description": null, "tags": [ "Key results" ], "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/KeyresultsGetResponse" }, "example": { "key_result": { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "6776881149495921680", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a key result", "description": null, "tags": [ "Key results" ], "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/KeyresultsPutResponse" }, "example": { "key_result": { "id": "631791848", "name": "KR 1", "reference_num": "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%", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "assigned_to_user": null, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "custom_fields": [ { "id": "6776881149496972898", "key": "stretch_goal", "name": "Stretch goal", "updatedAt": "2019-01-01T00:00:00Z", "value": "my metric", "type": "string" } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyresultsPostRequest" }, "example": { "key_result": { "name": "Another name", "workflow_status": { "name": "On track" }, "watchers": [ 689956296 ], "description": "

new description

", "current_metric": "30%" } } } } } }, "delete": { "summary": "Delete a key result", "description": null, "tags": [ "Key results" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/roll_up_releases/{id}": { "get": { "summary": "Get a specific roll up release", "description": null, "tags": [ "Roll up releases" ], "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/RollupreleasesGetResponse" }, "example": { "roll_up_release": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a roll up release", "description": null, "tags": [ "Roll up releases" ], "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/RollupreleasesPutResponse" }, "example": { "roll_up_release": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RollupreleasesPostRequest" }, "example": { "roll_up_release": { "name": "Different release" } } } } } } }, "/api/v1/products/{product_id}/roll_up_releases": { "get": { "summary": "List roll up releases in a product", "description": null, "tags": [ "Roll up releases" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/RollupreleasesGetResponse" }, "example": { "roll_up_releases": [ { "id": "6776881149485843899", "reference_num": "PL1-R-3", "name": "My release 002", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-3", "resource": "http://company.aha.io/api/v1/releases/PL1-R-3" }, { "id": "6776881149489814133", "reference_num": "PL1-R-2", "name": "My release 001", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-2", "resource": "http://company.aha.io/api/v1/releases/PL1-R-2" } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Creates a roll up release", "description": null, "tags": [ "Roll up releases" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/RollupreleasesPostResponse" }, "example": { "roll_up_release": { "id": "6776881149490916934", "reference_num": "PL1-R-2", "name": "Roll up release", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PL1-R-2", "resource": "http://company.aha.io/api/v1/releases/PL1-R-2" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RollupreleasesPostRequest" }, "example": { "roll_up_release": { "name": "Roll up release", "theme": "A roll up release", "release_date": "2019-01-01" } } } } } } }, "/api/v1/me": { "get": { "summary": "Get the current user profile", "description": "Retrieves current user information including account memberships and basic profile data", "tags": [ "Me" ], "parameters": [ { "name": "include", "in": "query", "required": false, "schema": { "type": "string" }, "example": "#" } ], "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/MeGetResponse" }, "example": { "user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": "2019-01-01T00:00:00.000Z", "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" }, { "role": 20, "role_description": "Owner", "product_id": "517761884", "product_name": "Project 2" }, { "role": 20, "role_description": "Owner", "product_id": "610602692", "product_name": "Product Line 1" } ], "preferences": { "current_product_id": 12123897 }, "accounts": [ { "account": { "name": "Account 1", "domain": "company", "logo": null, "alt_logo": null, "enabled": true } } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/me/assigned": { "get": { "summary": "List records assigned to the current user", "description": "The Me API provides access to current user information, assigned records, and pending tasks.\nThis endpoint serves as the primary interface for user-specific data and personal workspace functionality.\n\n**Core Functionality**:\n- **User Profile** - Current user information including accounts and permissions\n- **Assigned Records** - All records assigned to the current user across different types\n- **Task Management** - Pending tasks assigned to the current user\n\n**User Context**:\n- All endpoints return data scoped to the authenticated user\n- Account context is automatically determined from user session\n- Permissions are enforced based on user roles and project access\n\n**Response Structure**:\n- User profile includes account memberships and role information\n- Assigned records include features, epics, requirements, ideas, releases, and tasks\n- Task lists include status information and completion tracking\n\n**Authentication**: Standard API authentication (OAuth, session cookies, HTTP Basic until 2025).\nAll operations require valid authentication and return user-specific data.", "tags": [ "Me" ], "parameters": [ { "name": "record_type", "in": "query", "required": false, "schema": { "type": "string" }, "example": "InvalidType" } ], "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/MeGetResponse" }, "example": { "assigned": [ ] } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "text/html", "schema": { "type": "string" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/me/tasks": { "get": { "summary": "List pending tasks assigned to the current user", "description": "The Me API provides access to current user information, assigned records, and pending tasks.\nThis endpoint serves as the primary interface for user-specific data and personal workspace functionality.\n\n**Core Functionality**:\n- **User Profile** - Current user information including accounts and permissions\n- **Assigned Records** - All records assigned to the current user across different types\n- **Task Management** - Pending tasks assigned to the current user\n\n**User Context**:\n- All endpoints return data scoped to the authenticated user\n- Account context is automatically determined from user session\n- Permissions are enforced based on user roles and project access\n\n**Response Structure**:\n- User profile includes account memberships and role information\n- Assigned records include features, epics, requirements, ideas, releases, and tasks\n- Task lists include status information and completion tracking\n\n**Authentication**: Standard API authentication (OAuth, session cookies, HTTP Basic until 2025).\nAll operations require valid authentication and return user-specific data.", "tags": [ "Me" ], "parameters": [ ], "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/MeGetResponse" }, "example": { "tasks": [ { "id": "6776881149494751081", "name": "Review first widget", "due_date": null, "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/pages": { "post": { "summary": "Create a note", "description": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints.", "tags": [ "Notes" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/NotesPostResponse" }, "example": { "page": { "id": "6776881149490967959", "name": null, "title": "PRJ1-N-11 Untitled", "document_title": "Untitled | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-11", "emoji_value": null, "document_type": 80, "document_type_name": "internal_link", "editor_width": null, "type_name": "internal link", "position": null, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "linked_record_id": 1007868956, "linked_record_type": "Feature", "url": "http://company.aha.io/pages/PRJ1-N-11", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-11", "product_id": "131414752", "description": { "id": "6776881149488431496", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "parent_id": null, "tags": [ ], "full_tags": [ ], "comments_count": 0, "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotesPostRequest" }, "example": { "page": { "name": "Note 3", "description_attributes": { "body": "

An awesome new note

" } } } } } } }, "get": { "summary": "List notes for a product", "description": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints.", "tags": [ "Notes" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/NotesGetResponse" }, "example": { "pages": [ { "id": "123524136", "name": "Title of the meeting note", "title": "PRJ1-N-9 Title of the meeting note", "reference_num": "PRJ1-N-9", "url": "http://company.aha.io/pages/PRJ1-N-9", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-9", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "199011658", "name": "Title of the child note", "title": "PRJ1-N-4 Title of the child note", "reference_num": "PRJ1-N-4", "url": "http://company.aha.io/pages/PRJ1-N-4", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-4", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": 702939369 }, { "id": "249102634", "name": null, "title": "PRJ1-N-7 Untitled", "reference_num": "PRJ1-N-7", "url": "http://company.aha.io/pages/PRJ1-N-7", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-7", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "256116692", "name": "Shared page title", "title": "PRJ1-N-10 Shared page title", "reference_num": "PRJ1-N-10", "url": "http://company.aha.io/pages/PRJ1-N-10", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-10", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "280859787", "name": "External link", "title": "PRJ1-N-6 External link", "reference_num": "PRJ1-N-6", "url": "http://company.aha.io/pages/PRJ1-N-6", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-6", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "549832152", "name": "Title of the second whiteboard", "title": "PRJ1-N-6 Title of the second whiteboard", "reference_num": "PRJ1-N-6", "url": "http://company.aha.io/pages/PRJ1-N-6", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-6", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "666543134", "name": "Title of the second note", "title": "PRJ1-N-2 Title of the second note", "reference_num": "PRJ1-N-2", "url": "http://company.aha.io/pages/PRJ1-N-2", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-2", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "702939369", "name": "Title of the parent note", "title": "PRJ1-N-3 Title of the parent note", "reference_num": "PRJ1-N-3", "url": "http://company.aha.io/pages/PRJ1-N-3", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-3", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "969708644", "name": "Title of the first whiteboard", "title": "PRJ1-N-5 Title of the first whiteboard", "reference_num": "PRJ1-N-5", "url": "http://company.aha.io/pages/PRJ1-N-5", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-5", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "970863041", "name": null, "title": "PRJ1-N-8 Untitled", "reference_num": "PRJ1-N-8", "url": "http://company.aha.io/pages/PRJ1-N-8", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-8", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null }, { "id": "1051981226", "name": "Title of the first note", "title": "PRJ1-N-1 Title of the first note", "reference_num": "PRJ1-N-1", "url": "http://company.aha.io/pages/PRJ1-N-1", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-1", "created_at": "2019-01-01T00:00:00.000Z", "parent_id": null } ], "pagination": { "total_records": 11, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/pages/{id}": { "get": { "summary": "Get a specific note", "description": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints.", "tags": [ "Notes" ], "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/NotesGetResponse" }, "example": { "page": { "id": "1051981226", "name": "Title of the first note", "title": "PRJ1-N-1 Title of the first note", "document_title": "Title of the first note | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-1", "emoji_value": null, "document_type": 10, "document_type_name": "note", "editor_width": "FULL", "type_name": "note", "position": 100000, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "url": "http://company.aha.io/pages/PRJ1-N-1", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-1", "product_id": "131414752", "description": { "id": "669149001", "body": "Description of note 1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "parent_id": null, "tags": [ "Infrastructure", "Sales" ], "full_tags": [ { "id": 775582684, "name": "Infrastructure", "color": "#7552e0" }, { "id": 926098016, "name": "Sales", "color": "#e0da52" } ], "comments_count": 0, "custom_fields": [ { "id": 416524155, "key": "review_date", "name": "Review date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a note", "description": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints.", "tags": [ "Notes" ], "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/NotesPutResponse" }, "example": { "page": { "id": "280859787", "name": "Build products customers love", "title": "PRJ1-N-6 Build products customers love", "document_title": "Build products customers love | Aha!", "updated_at": "2019-01-01T00:00:00.000Z", "reference_num": "PRJ1-N-6", "emoji_value": null, "document_type": 70, "document_type_name": "external_link", "editor_width": null, "type_name": "external link", "position": 500000, "created_at": "2019-01-01T00:00:00.000Z", "location": null, "edit_locked": false, "external_url": "https://www.aha.io/solutions/product", "url": "http://company.aha.io/pages/PRJ1-N-6", "resource": "http://company.aha.io/api/v1/pages/PRJ1-N-6", "product_id": "131414752", "description": { "id": "", "body": "#", "editor_version": 2, "created_at": null, "updated_at": null, "attachments": [ ] }, "parent_id": null, "tags": [ ], "full_tags": [ ], "comments_count": 0, "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotesPostRequest" }, "example": { "page": { "name": "New name for the note", "description_attributes": { "body": "

An awesome new note

" } } } } } } }, "delete": { "summary": "Delete a note", "description": "\"Notes\" in the web interface are referenced as \"pages\" from API endpoints.", "tags": [ "Notes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/paid_seat_groups": { "get": { "summary": "List the administered paid seat groups", "description": null, "tags": [ "Paid Seat Groups" ], "parameters": [ ], "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/PaidSeatGroupsGetResponse" }, "example": { "paid_seat_groups": [ { "id": "354640896", "name": "Group 3", "administrators": [ ], "capacity": 2, "allocated_seats": 0, "description": { "id": "6776881149498351732", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 20, "allocated_seats": 2, "description": { "id": "6776881149487500319", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "id": "992805589", "name": "Group 1", "administrators": [ { "id": "373433676", "name": "Jim Jingles", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 21, "allocated_seats": 1, "description": { "id": "6776881149492142258", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/paid_seat_groups/{id}": { "put": { "summary": "Updates the paid seat group", "description": null, "tags": [ "Paid Seat Groups" ], "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/PaidSeatGroupsPutResponse" }, "example": { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 3, "allocated_seats": 2, "description": { "id": "6776881149486533886", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "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/PaidSeatGroupsPostRequest" }, "example": { "name": "Group 2", "capacity": 3 } } } } } }, "/api/v1/paid_seat_groups/{id}/modify_user": { "post": { "summary": "Adds the user to the paid seat group", "description": null, "tags": [ "Paid Seat Groups" ], "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/PaidSeatGroupsPostResponse" }, "example": { "id": "572805993", "name": "Group 2", "administrators": [ { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } ], "capacity": 20, "allocated_seats": 2, "description": { "id": "6776881149483785369", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "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/PaidSeatGroupsPostRequest" }, "example": { "user_id": 1049303076, "remove": null } } } } } }, "/api/v1/products/{product_id}/personas": { "post": { "summary": "Create a persona", "description": null, "tags": [ "Personas" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/PersonasPostResponse" }, "example": { "persona": { "id": "6776881149484114529", "name": "John", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PRJ1-P-1", "resource": "http://company.aha.io/personas/PRJ1-P-1", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonasPostRequest" }, "example": { "persona": { "name": "John" } } } } } }, "get": { "summary": "List personas in a product", "description": null, "tags": [ "Personas" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/PersonasGetResponse" }, "example": { "personas": [ { "id": "227222789", "name": "Jim the cyclist", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "344093881", "name": "Jane the athlete", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "982259096", "name": "Tim the repairer", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/personas/{id}": { "get": { "summary": "Get a specific persona", "description": null, "tags": [ "Personas" ], "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/PersonasGetResponse" }, "example": { "persona": { "id": "344093881", "name": "Jane the athlete", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PROD-P-1", "resource": "http://company.aha.io/personas/PROD-P-1", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/personas/{id}": { "put": { "summary": "Update a persona", "description": null, "tags": [ "Personas" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "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/PersonasPutResponse" }, "example": { "persona": { "id": "344093881", "name": "Julie", "color": 13421772, "occupation": null, "quote": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/personas/PROD-P-1", "resource": "http://company.aha.io/personas/PROD-P-1", "custom_fields": [ ], "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonasPostRequest" }, "example": { "persona": { "name": "Julie" } } } } } }, "delete": { "summary": "Delete a persona", "description": null, "tags": [ "Personas" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_portals/{idea_portal_id}/portal_users/{portal_user_id}/portal_user_subscriptions": { "get": { "summary": "List a portal user's preferences for the portal summary email", "description": null, "tags": [ "Ideas portal user subscriptions" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "name": "portal_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "PortalUserId 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/IdeasportalusersubscriptionsGetResponse" }, "example": { "portal_user_subscriptions": { "preferences": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Set a portal user's preferences to specific project and category updates", "description": null, "tags": [ "Ideas portal user subscriptions" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "name": "portal_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "PortalUserId 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/IdeasportalusersubscriptionsPostResponse" }, "example": { "portal_user_subscriptions": { "preferences": [ { "type": "category", "id": 251347229 }, { "type": "category", "id": 552935478 } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeasportalusersubscriptionsPostRequest" }, "example": { "portal_user_subscriptions": { "preferences": [ { "type": "project", "id": 131414752 }, { "type": "category", "id": 251347229 } ] } } } } } } }, "/api/v1/idea_portals/{idea_portal_id}/portal_users/{portal_user_id}/portal_user_subscriptions/subscribe_to_all": { "post": { "summary": "Subscribe a portal user to updates from all projects and categories", "description": null, "tags": [ "Ideas portal user subscriptions" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "name": "portal_user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "PortalUserId identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_portals/{idea_portal_id}/portal_users": { "post": { "summary": "Create a portal user", "description": null, "tags": [ "Ideas portal users" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId 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/IdeasportalusersPostResponse" }, "example": { "portal_user": { "id": "6776881149497060074", "email": "sam.doe@example.com", "first_name": "sam", "last_name": "doe", "enabled": true, "verified": false, "employee": true, "max_endorsements_override": null, "idea_user_id": "6776881149491801214", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeasportalusersPostRequest" }, "example": { "portal_user": { "email": "sam.doe@example.com", "first_name": "sam", "last_name": "doe" } } } } } }, "get": { "summary": "List portal users for an ideas portal", "description": null, "tags": [ "Ideas portal users" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId 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/IdeasportalusersGetResponse" }, "example": { "portal_users": [ { "id": "144817500", "email": "timmy@smith.com", "first_name": "Timmy", "last_name": "Smith", "enabled": true, "verified": true, "employee": true, "max_endorsements_override": null, "idea_user_id": "446386906", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null }, { "id": "477635308", "email": "no-reply@aha.io", "first_name": "Bill", "last_name": "Billings", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "870840916", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null }, { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null }, { "id": "1066301902", "email": "tim@smith.com", "first_name": "Tim", "last_name": "Smith", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "670061655", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } ], "pagination": { "total_records": 4, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/idea_portals/{idea_portal_id}/portal_users/{id}": { "get": { "summary": "Get a specific portal user", "description": null, "tags": [ "Ideas portal users" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "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/IdeasportalusersGetResponse" }, "example": { "portal_user": { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": false, "unsubscribed_from_weekly_emails": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a portal user", "description": null, "tags": [ "Ideas portal users" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "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/IdeasportalusersPutResponse" }, "example": { "portal_user": { "id": "646391926", "email": "john@long.com", "first_name": "John", "last_name": "Long", "enabled": true, "verified": false, "employee": false, "max_endorsements_override": null, "idea_user_id": "1056507375", "created_at": "2019-01-01T00:00:00.000Z", "unsubscribed": true, "unsubscribed_from_weekly_emails": true } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdeasportalusersPostRequest" }, "example": { "portal_user": { "first_name": "Sarah" } } } } } }, "delete": { "summary": "Delete a portal user", "description": null, "tags": [ "Ideas portal users" ], "parameters": [ { "name": "idea_portal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaPortalId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products": { "post": { "summary": "Create a product", "description": null, "tags": [ "Products" ], "parameters": [ ], "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/ProductsPostResponse" }, "example": { "product": { "id": "6776881149497073946", "reference_prefix": "NEWPRODUCT", "name": "New Product Line", "product_line": true, "product_line_type": "a new product line type", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": { "id": "6776881149488051949", "body": "An amazing new product line", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/projects/NEWPRODUCT", "resource": "http://company.aha.io/projects/NEWPRODUCT", "children": [ ], "custom_fields": [ ], "screen_definition_ids": { }, "screen_definitions": [ ], "has_ideas": false, "has_master_features": true, "has_epics": true, "release_workflow": { "id": 717623509, "name": "Account product release workflow", "statusable_type": "Release", "workflow_type": "release" }, "requirement_workflow": { "id": 845522269, "name": "Example product feature workflow", "statusable_type": "Feature", "workflow_type": "requirement" }, "feature_workflow": { "id": 845522269, "name": "Example 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": 845522269, "name": "Example 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": 883066232, "name": "Account goal workflow", "statusable_type": "StrategicImperative", "workflow_type": "key_result" }, "capacity_planning_enabled": false, "default_capacity_units": 10, "enhanced_capacity_planning_enabled": false, "workspace_type": "product_workspace" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsPostRequest" }, "example": { "product": { "name": "New Product", "description": "An amazing new product", "prefix": "NEWPRODUCT" } } } } } }, "get": { "summary": "List products in the account", "description": null, "tags": [ "Products" ], "parameters": [ { "name": "include_teams", "in": "query", "required": false, "schema": { "type": "string" }, "example": "true" }, { "name": "with_idea_portals", "in": "query", "required": false, "schema": { "type": "string" }, "example": "true" } ], "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/ProductsGetResponse" }, "example": { "products": [ { "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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" }, { "id": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/{id}/record_links": { "get": { "summary": "List record links for a feature", "description": null, "tags": [ "Record links" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "parent_and_child_links", "in": "query", "required": false, "schema": { "type": "string" }, "example": "true" } ], "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/RecordlinksGetResponse" }, "example": { "record_links": [ { "id": 170959948, "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record_type": "feature", "parent_record_id": 1007868956, "child_record_type": "feature", "child_record_id": 622562724, "parent": true, "parent_record": { "record_type": "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" }, "child_record": { "record_type": "feature", "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" } }, { "id": "6776881149496786945", "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record_type": "master_feature", "parent_record_id": 999605892, "child_record_type": "feature", "child_record_id": 1007868956, "parent": false, "parent_record": { "record_type": "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" }, "child_record": { "record_type": "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" } } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/record_links/{id}": { "get": { "summary": "Get a specific record link", "description": null, "tags": [ "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/RecordlinksGetResponse" }, "example": { "record_link": { "id": 170959948, "link_type": "Depends on", "link_type_id": 20, "created_at": "2019-01-01T00:00:00.000Z", "parent_record_type": "feature", "parent_record_id": 1007868956, "child_record_type": "feature", "child_record_id": 622562724, "parent": true, "parent_record": { "record_type": "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" }, "child_record": { "record_type": "feature", "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" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "delete": { "summary": "Delete a record link", "description": null, "tags": [ "Record links" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/{record_type}/{id}/record_links": { "post": { "summary": "Create a record link for a feature", "description": null, "tags": [ "Record links" ], "parameters": [ { "name": "record_type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "RecordType identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordlinksPostRequest" }, "example": { "record_link": { "record_type": "feature", "record_id": 303873333, "link_type": 10 } } } } } } }, "/api/v1/releases/{id}/release_phases": { "get": { "summary": "List release phases for a release", "description": null, "tags": [ "Release phases" ], "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/ReleasephasesGetResponse" }, "example": { "release_phases": [ { "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": [ ] } }, { "id": "405824017", "name": "Beta", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "965145324", "body": "Description of release phase 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "792154778", "name": "Beta [2]", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149494153311", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "827574075", "name": "Gamma", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149486508174", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "pagination": { "total_records": 4, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/release_phases/{id}": { "get": { "summary": "Get a specific release phase", "description": null, "tags": [ "Release phases" ], "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/ReleasephasesGetResponse" }, "example": { "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": [ ] } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a release phase", "description": null, "tags": [ "Release phases" ], "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/ReleasephasesPutResponse" }, "example": { "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": 25, "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": [ ] } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasephasesPostRequest" }, "example": { "release_phase": { "name": "Another name", "description": "

new description

", "phase_type": "milestone" } } } } } }, "delete": { "summary": "Delete a release phase", "description": null, "tags": [ "Release phases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/release_phases": { "get": { "summary": "List release phases in the account", "description": null, "tags": [ "Release phases" ], "parameters": [ ], "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/ReleasephasesGetResponse" }, "example": { "release_phases": [ { "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": [ ] } }, { "id": "405824017", "name": "Beta", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "965145324", "body": "Description of release phase 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "792154778", "name": "Beta [2]", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149487000230", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, { "id": "827574075", "name": "Gamma", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "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": "6776881149494371573", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "pagination": { "total_records": 4, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create a release phase", "description": null, "tags": [ "Release phases" ], "parameters": [ ], "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/ReleasephasesPostResponse" }, "example": { "release_phase": { "id": "6776881149493480488", "name": "New release milestone", "start_on": "2019-01-01", "end_on": "2019-01-01", "type": "milestone", "release_id": 278327321, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": 0, "progress_source": "progress_manual", "duration_source": "duration_manual", "description": { "id": "6776881149492778822", "body": "

This is the description

", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasephasesPostRequest" }, "example": { "release_phase": { "name": "New release phase", "phase_type": "phase", "release_id": 278327321, "start_on": "2019-01-01", "end_on": "2019-01-01", "description": "

This is the description

" } } } } } } }, "/api/v1/products/{product_id}/releases": { "post": { "summary": "Create a release", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/ReleasesPostResponse" }, "example": { "release": { "id": "6776881149495764123", "product_id": "131414752", "reference_num": "PRJ1-R-5", "name": "Release 3", "start_date": null, "end_date": null, "development_started_on": null, "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Oct 4, 2025", "external_date_resolution": "sync", "released": false, "parking_lot": false, "master_release": false, "released_on": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": 1, "progress": 0, "progress_source": "progress_from_features_completed", "duration_source": "duration_manual", "status_changed_on": "2019-01-01", "theme": { "id": "6776881149493840411", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "url": "http://company.aha.io/releases/PRJ1-R-5", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-5", "integration_fields": [ ], "custom_fields": [ ], "comments_count": 0, "workflow_status": { "id": "738862546", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "owner": { "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" }, "goals": [ ], "key_results": [ ], "initiatives": [ { "id": "4125886", "reference_num": "PRJ1-S-2", "name": "Initiative 2", "url": "http://company.aha.io/initiatives/PRJ1-S-2", "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-2", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "824706757", "body": "Description of initiative 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "integration_fields": [ ] }, { "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" }, "workflow_status_times": [ { "status_id": "738862546", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasesPostRequest" }, "example": { "release": { "owner": "no-reply@aha.io", "initiatives": "Initiative 1", "name": "Release 3", "status": "New", "theme": "Our first big release", "external_date_resolution": "month" } } } } } }, "get": { "summary": "List releases in a product", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/ReleasesGetResponse" }, "example": { "releases": [ { "id": "141021264", "reference_num": "PRJ1-MR-2", "name": "Roll-up 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/master_releases/PRJ1-MR-2", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-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": "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" } }, { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up 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": [ ], "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-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" } }, { "id": "325518644", "reference_num": "PRJ1-R-4", "name": "Sub 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": [ ], "url": "http://company.aha.io/releases/PRJ1-R-4", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-4", "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" }, "parent": { "id": "141021264", "reference_num": "PRJ1-MR-2", "name": "Roll-up Release 2", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-2", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-2" } }, { "id": "1050186040", "reference_num": "PRJ1-R-3", "name": "Release 3", "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": "453734818", "name": "id", "value": "4221", "integration_id": 342659513, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "url": "http://company.aha.io/releases/PRJ1-R-3", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-3", "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" } } ], "pagination": { "total_records": 6, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/goals/{goal_id}/releases": { "get": { "summary": "List releases associated with a goal", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "goal_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "GoalId 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/ReleasesGetResponse" }, "example": { "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" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives/{initiative_id}/releases": { "get": { "summary": "List releases associated with an initiative", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/ReleasesGetResponse" }, "example": { "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" } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/{release_id}/releases": { "get": { "summary": "List releases under a roll-up release", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/ReleasesGetResponse" }, "example": { "releases": [ { "id": "325518644", "reference_num": "PRJ1-R-4", "name": "Sub 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": [ ], "url": "http://company.aha.io/releases/PRJ1-R-4", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-4", "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" }, "parent": { "id": "141021264", "reference_num": "PRJ1-MR-2", "name": "Roll-up Release 2", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-2", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-2" } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/roll_up_releases/{release_id}/releases": { "get": { "summary": "List releases under a roll-up release", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/ReleasesGetResponse" }, "example": { "releases": [ { "id": "85510963", "reference_num": "PRJ4-R-4", "name": "Parking lot for Project 4", "parking_lot": true, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "935317104", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ4-R-4", "resource": "http://company.aha.io/api/v1/releases/PRJ4-R-4", "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": "935317104", "reference_prefix": "PRJ4", "name": "Project 4", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ4" } }, { "id": "141021264", "reference_num": "PRJ1-MR-2", "name": "Roll-up 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/master_releases/PRJ1-MR-2", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-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": "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" } }, { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up 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": [ ], "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-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" } }, { "id": "325518644", "reference_num": "PRJ1-R-4", "name": "Sub 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": [ ], "url": "http://company.aha.io/releases/PRJ1-R-4", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-4", "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" }, "parent": { "id": "141021264", "reference_num": "PRJ1-MR-2", "name": "Roll-up Release 2", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-2", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-2" } }, { "id": "342040612", "reference_num": "PRJ3-R-1", "name": "Release 3 Project 3", "start_date": "2019-01-01", "release_date": "2019-01-01", "parking_lot": false, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ3-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ3-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": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" } }, { "id": "414276209", "reference_num": "PRJ4-R-3", "name": "Release month old (shipped)", "start_date": "2019-01-01", "release_date": "2019-01-01", "parking_lot": false, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "935317104", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ4-R-3", "resource": "http://company.aha.io/api/v1/releases/PRJ4-R-3", "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": "935317104", "reference_prefix": "PRJ4", "name": "Project 4", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ4" } }, { "id": "637342960", "reference_num": "PRJ2-R-2", "name": "Parking lot for Project 2", "parking_lot": true, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "517761884", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ2-R-2", "resource": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, { "id": "800484072", "reference_num": "PRJ4-R-2", "name": "Release week old (shipped)", "start_date": "2019-01-01", "release_date": "2019-01-01", "parking_lot": false, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "935317104", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ4-R-2", "resource": "http://company.aha.io/api/v1/releases/PRJ4-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": "935317104", "reference_prefix": "PRJ4", "name": "Project 4", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ4" } }, { "id": "918502240", "reference_num": "PRJ4-R-1", "name": "Release 4", "start_date": "2019-01-01", "release_date": "2019-01-01", "parking_lot": false, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "935317104", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ4-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ4-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": "935317104", "reference_prefix": "PRJ4", "name": "Project 4", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ4" } }, { "id": "946589036", "reference_num": "PRJe-R-4", "name": "Parking lot", "parking_lot": true, "created_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJe-R-4", "resource": "http://company.aha.io/api/v1/releases/PRJe-R-4", "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": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" } }, { "id": "1000426269", "reference_num": "PRJ2-R-1", "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": "517761884", "integration_fields": [ ], "url": "http://company.aha.io/releases/PRJ2-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ2-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": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, { "id": "1050186040", "reference_num": "PRJ1-R-3", "name": "Release 3", "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": "453734818", "name": "id", "value": "4221", "integration_id": 342659513, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "url": "http://company.aha.io/releases/PRJ1-R-3", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-3", "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" } } ], "pagination": { "total_records": 14, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/{id}/duplicate": { "post": { "summary": "Duplicate a release", "description": null, "tags": [ "Releases" ], "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/ReleasesPostResponse" }, "example": { "release": { "id": "6776881149492110971", "name": "[Copy] Release 1" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/releases/{id}": { "put": { "summary": "Update a release", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "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/ReleasesPutResponse" }, "example": { "release": { "id": "278327321", "product_id": "131414752", "reference_num": "PRJ1-R-1", "name": "Release 1", "start_date": "2019-01-01", "end_date": null, "development_started_on": "2019-01-01", "release_date": "2019-01-01", "external_release_date": "2019-01-01", "external_release_date_description": "Sep 11, 2025", "external_date_resolution": "exact", "released": false, "parking_lot": false, "master_release": false, "released_on": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "position": null, "progress": null, "progress_source": "progress_manual", "duration_source": "duration_manual", "status_changed_on": null, "theme": { "id": "522610666", "body": "Theme of the release", "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/releases/PRJ1-R-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1", "integration_fields": [ { "id": "68217473", "name": "id", "value": "777", "integration_id": 204584239, "service_name": "jira", "created_at": "2019-01-01T00:00:00.000Z" } ], "custom_fields": [ { "id": "432637490", "key": "note", "name": "Note", "updatedAt": "2019-01-01T00:00:00Z", "body": "

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" } ], "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": [ ] } } ], "key_results": [ ], "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" }, "parent": { "id": "292454904", "reference_num": "PRJ1-MR-1", "name": "Roll-up Release 1", "start_date": "2019-01-01", "release_date": "2019-01-01", "created_at": "2019-01-01T00:00:00.000Z", "url": "http://company.aha.io/master_releases/PRJ1-MR-1", "resource": "http://company.aha.io/api/v1/releases/PRJ1-MR-1" }, "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/ReleasesPostRequest" }, "example": { "release": { "initiatives": [ ], "name": "Smarter release" } } } } } }, "delete": { "summary": "Delete a release", "description": null, "tags": [ "Releases" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/{feature_id}/requirements": { "get": { "summary": "List requirements for a feature", "description": null, "tags": [ "Requirements" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId identifier" }, { "name": "updated_since", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2019-01-01T00:00:00Z" } ], "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/RequirementsGetResponse" }, "example": { "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": "6776881149488866340", "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": "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": "6776881149498326874", "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 } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Create a requirement", "description": null, "tags": [ "Requirements" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId 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/RequirementsPostResponse" }, "example": { "requirement": { "id": "6776881149495309190", "name": "New name", "reference_num": "PRJ1-1-4", "position": 4, "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": "962984386", "name": "Designed", "position": 2, "complete": false, "color": "#ecdd8f" }, "url": "http://company.aha.io/requirements/PRJ1-1-4", "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-4", "description": { "id": "6776881149498089069", "body": "

This is the description

", "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": "689956296", "name": "Henry Humpty", "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, "workflow_status_times": [ { "status_id": "962984386", "status_name": "Designed", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementsPostRequest" }, "example": { "requirement": { "name": "New name", "workflow_status": { "name": "Designed" }, "description": "

This is the description

", "assigned_to_user": { "email": "no-reply@aha.io" } } } } } } } }, "/api/v1/requirements/{id}/convert_to_feature": { "post": { "summary": "Convert a requirement to a feature", "description": null, "tags": [ "Requirements" ], "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/RequirementsPostResponse" }, "example": { "feature": { "id": "6776881149487717549", "name": "Body of requirement 1", "reference_num": "PRJ1-251", "initiative_reference_num": null, "release_reference_num": "PRJ1-R-1", "epic_reference_num": null, "position": 1, "score": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "start_date": null, "due_date": null, "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "status_changed_on": "2019-01-01", "created_by_user": { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, "workflow_kind": { "id": "98484309", "name": "New" }, "workflow_status": { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, "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": "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": [ ] }, "attachments": [ ], "integration_fields": [ ], "url": "http://company.aha.io/features/PRJ1-251", "resource": "http://company.aha.io/api/v1/features/PRJ1-251", "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" } }, "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": [ ], "goals": [ ], "comments_count": 1, "score_facts": [ ], "tags": [ ], "full_tags": [ ], "custom_fields": [ { "id": "6776881149495350529", "key": "expected_completion_date", "name": "Expected completion date", "updatedAt": "2019-01-01T00:00:00Z", "value": "2019-01-01", "type": "date" } ], "feature_links": [ { "link_type": "Relates to", "link_type_id": 10, "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": "6776881149487717549", "reference_num": "PRJ1-251", "name": "Body of requirement 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" } } ], "workflow_status_times": [ { "status_id": "934242751", "status_name": "New", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ], "feature_only_original_estimate": null, "feature_only_remaining_estimate": null, "feature_only_work_done": null } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/schedulable_changes": { "post": { "summary": "Create a schedulable change", "description": null, "tags": [ "Schedulable changes" ], "parameters": [ ], "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/SchedulablechangesPostResponse" }, "example": { "schedulable_change": { "id": "6776881149488722242", "effective_start_date": "2019-01-01", "team_members_count": 5, "hourly_rate": "155.0", "color": 6710886, "schedule": { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulablechangesPostRequest" }, "example": { "schedulable_change": { "effective_start_date": "2019-01-01", "schedule_id": 54870801, "team_member_count": 4, "hourly_rate": 155.0 }, "team_id": 949295028 } } } } }, "get": { "summary": "List schedulable changes", "description": null, "tags": [ "Schedulable changes" ], "parameters": [ { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/SchedulablechangesGetResponse" }, "example": { "schedulable_changes": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/schedulable_changes/{id}": { "put": { "summary": "Update a schedulable change", "description": null, "tags": [ "Schedulable changes" ], "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/SchedulablechangesPutResponse" }, "example": { "schedulable_change": { "id": "711001786", "effective_start_date": "2019-01-01", "team_members_count": 4, "hourly_rate": "155.0", "color": 16711680, "schedule": { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulablechangesPostRequest" }, "example": { "team_id": 949295028, "schedulable_change": { "effective_start_date": "2019-01-01", "schedule_id": 54870801, "team_members_count": 4, "hourly_rate": 155.0, "color": "#ff0000" } } } } } }, "delete": { "summary": "Delete a schedulable change", "description": null, "tags": [ "Schedulable changes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulablechangesPostRequest" }, "example": { } } } } } }, "/api/v1/schedulable_changes/{schedulable_change_id}/update_team_memberships": { "put": { "summary": "Update a scheduled change's team memberships", "description": "Adds, updates, or removes users via a scheduled change using the Team Membership relation. The schedulable change must be in the future", "tags": [ "Schedulable changes" ], "parameters": [ { "name": "schedulable_change_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "SchedulableChangeId 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/SchedulablechangesPutResponse" }, "example": { "schedulable_change": { "id": "711001786", "effective_start_date": "2019-01-01", "team_members_count": 5, "hourly_rate": "100.0", "color": 6710886, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "team_memberships": [ { "id": "202266373", "name": "John Johnson", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } }, { "id": "646482528", "name": "Mary Humpty", "new_user": false, "deleted": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5", "monday": true, "tuesday": true, "wednesday": true, "thursday": true, "friday": true, "saturday": false, "sunday": false } } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchedulablechangesPostRequest" }, "example": { "team_membership_id": 202266373, "team_membership": { "schedule": { "hours_per_day": 5.0, "story_points_per_day": 4.0, "monday": false, "tuesday": true, "wednesday": true, "thursday": true, "friday": false, "saturday": false, "sunday": false } } } } } } } }, "/api/v1/schedules": { "get": { "summary": "List schedules", "description": "Retrieves schedules for capacity planning, showing working hours, velocity, and weekly patterns", "tags": [ "Schedules" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "example": "name,hours_per_day,story_points_per_day,velocity,monday,tuesday,wednesday,thursday,friday,saturday,sunday" } ], "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/SchedulesGetResponse" }, "example": { "schedules": [ { "id": "54870801", "name": "Another schedule", "hours_per_day": "10.0", "story_points_per_day": "5.0", "velocity": "10.0" }, { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, { "id": "876770204", "name": "Child schedule", "hours_per_day": "19.0", "story_points_per_day": "28.0", "velocity": null } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/screen_definitions": { "get": { "summary": "List all custom layouts", "description": "Custom layouts in Aha! Roadmaps help you define the information that you want your teammates to see at two important times: when they create a record and when they view a record's details. You must be a configuration administrator to view custom layouts on your account through the API.\n\nFor more information about custom layouts, consult our support documentation: https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-layouts", "tags": [ "Custom Layouts" ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "string" }, "example": "50" } ], "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/CustomLayoutsGetResponse" }, "example": { "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": 105082880, "screenable_type": "Project", "name": "Screen Definition 2", "custom_field_definitions": [ ] }, { "id": 117022249, "screenable_type": "StrategicImperative", "name": "Screen Definition 13", "custom_field_definitions": [ ] }, { "id": 202819082, "screenable_type": "Feature", "name": "Screen Definition Feature 2", "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": 412945294, "screenable_type": null, "name": "Screen Definition 14 - Idea with attachment custom field", "custom_field_definitions": [ ] }, { "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": 798636831, "screenable_type": "ReleasePhase", "name": "Screen Definition 15 - Release phase custom field", "custom_field_definitions": [ { "id": 43847680, "key": "text_field", "position": 1, "name": "TextField1", "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 } ] }, { "id": 915630759, "screenable_type": "KeyResult", "name": "Screen Definition 16 - Key result custom field", "custom_field_definitions": [ { "id": 909163750, "key": "stretch_goal", "position": 1, "name": "Stretch goal", "type": "CustomFieldDefinitions::TextField", "api_type": "string", "required": false } ] } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/screen_definitions/{id}": { "get": { "summary": "Get a custom layout by ID", "description": "Custom layouts in Aha! Roadmaps help you define the information that you want your teammates to see at two important times: when they create a record and when they view a record's details. You must be a configuration administrator to view custom layouts on your account through the API.\n\nFor more information about custom layouts, consult our support documentation: https://www.aha.io/support/roadmaps/strategic-roadmaps/customizations/custom-layouts", "tags": [ "Custom Layouts" ], "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/CustomLayoutsGetResponse" }, "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 } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/goals": { "post": { "summary": "Create a goal", "description": null, "tags": [ "Goals" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/GoalsPostResponse" }, "example": { "goal": { "id": "6776881149493942444", "name": "Goal 3", "reference_num": "PRJ1-G-1", "effort": 95, "value": 54, "color": "#397e82", "position": 6, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "131414752", "progress": 0, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ1-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ1-G-1", "description": { "id": "6776881149500114967", "body": "", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "FooBar", "description": { "id": "6776881149483601587", "body": "Foo Bar", "editor_version": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "workflow_status": { "id": "412273758", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, "workflow_status_times": [ { "status_id": "412273758", "status_name": "Not Started", "started_at": "2019-01-01T00:00:00.000Z", "ended_at": null } ] }, "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": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ], "watchers": [ { "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" }, { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" }, { "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/GoalsPostRequest" }, "example": { "goal": { "name": "Goal 3", "success_metric": { "name": "FooBar", "description": "Foo Bar", "workflow_status": "Not Started" }, "time_frame": { "name": "2015" }, "description": "Our first big goal", "effort": 15, "value": 5 } } } } } }, "get": { "summary": "List goals in a product", "description": null, "tags": [ "Goals" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/GoalsGetResponse" }, "example": { "goals": [ { "id": "111739083", "name": "Goal 5", "reference_num": "DEMOENT-G-5", "effort": 40, "value": 30, "color": "#bada55", "position": 5, "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-5", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-5", "description": { "id": "996214770", "body": "Description of project1_strategic_imperative5_archived_epoch", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 5", "description": { "id": "429990377", "body": "Description of project1_strategic_imperative5_archived_epoch_strategic_imperative_metric", "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" }, "time_frame": { "id": 834757622, "name": "2018" }, "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "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" } ] } ], "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "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": [ ] }, { "id": "712130641", "name": "Goal 3", "reference_num": "DEMOENT-G-3", "effort": 40, "value": 30, "color": "#bada55", "position": 2, "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-3", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-3", "description": { "id": "568840458", "body": "Description of project1_strategic_imperative3_no_epoch", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 3", "description": { "id": "668008103", "body": "Description of project1_strategic_imperative3_no_epoch_strategic_imperative_metric", "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": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "926116263", "name": "Goal 4", "reference_num": "DEMOENT-G-4", "effort": 40, "value": 30, "color": "#bada55", "position": 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", "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-4", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-4", "description": { "id": "308494954", "body": "Description of project1_strategic_imperative4_active_epoch", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 4", "description": { "id": "330355042", "body": "Description of project1_strategic_imperative4_active_epoch_strategic_imperative_metric", "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" }, "time_frame": { "id": 273422810, "name": "2017" }, "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "988418543", "name": "Goal 2", "reference_num": "DEMOENT-G-2", "effort": 40, "value": 30, "color": "#bada55", "position": 3, "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-2", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-2", "description": { "id": "1055602421", "body": "Description of goal 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 2", "description": { "id": "394826695", "body": "Description of goal 2", "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": [ ], "key_results": [ { "id": "195428809", "name": "KR 3", "reference_num": "DEMOENT-G-1-KR-3", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-3", "position": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] } ], "pagination": { "total_records": 5, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/goals": { "get": { "summary": "List goals", "description": null, "tags": [ "Goals" ], "parameters": [ ], "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/GoalsGetResponse" }, "example": { "goals": [ { "id": "111739083", "name": "Goal 5", "reference_num": "DEMOENT-G-5", "effort": 40, "value": 30, "color": "#bada55", "position": 5, "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-5", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-5", "description": { "id": "996214770", "body": "Description of project1_strategic_imperative5_archived_epoch", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 5", "description": { "id": "429990377", "body": "Description of project1_strategic_imperative5_archived_epoch_strategic_imperative_metric", "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" }, "time_frame": { "id": 834757622, "name": "2018" }, "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "242586561", "name": "Goal 3", "reference_num": "PRJ3-G-1", "effort": 40, "value": 30, "color": "#bada55", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "progress": null, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "description": { "id": "186725916", "body": "Description of project3_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 4", "description": { "id": "646872120", "body": "Description of project3_strategic_imperative1_strategic_imperative_metric", "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": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" }, "parent": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parents": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "352745835", "name": "Product Line Goal 1", "reference_num": "PL1-G-1", "effort": 40, "value": 30, "color": "#bada55", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "610602692", "progress": null, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/strategic_imperatives/PL1-G-1", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 3", "description": { "id": "909973229", "body": "Description of project2_strategic_imperative1_strategic_imperative_metric", "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": "610602692", "reference_prefix": "PL1", "name": "Product Line 1", "product_line": true, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PL1" }, "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "394052101", "name": "Goal 4", "reference_num": "PRJ3-G-1", "effort": 40, "value": 30, "color": "#bada55", "position": 2, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "progress": null, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ3-G-1", "description": { "id": "921393880", "body": "Description of project3_strategic_imperative2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 5", "description": { "id": "96979861", "body": "Description of project3_strategic_imperative2_strategic_imperative_metric", "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": "702241743", "reference_prefix": "PRJ3", "name": "Project 3", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ3" }, "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "599777734", "name": "Goal 6", "reference_num": "PRJ5-G-1", "effort": 40, "value": 30, "color": "#bada55", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "12123897", "progress": null, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ5-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ5-G-1", "description": { "id": "133581930", "body": "Description of project5_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 7", "description": { "id": "508822721", "body": "Description of project5_strategic_imperative1_strategic_imperative_metric", "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": "12123897", "reference_prefix": "PRJ5", "name": "Project 5", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ5" }, "parent": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parents": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "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" } ] } ], "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "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": [ ] }, { "id": "712130641", "name": "Goal 3", "reference_num": "DEMOENT-G-3", "effort": 40, "value": 30, "color": "#bada55", "position": 2, "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-3", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-3", "description": { "id": "568840458", "body": "Description of project1_strategic_imperative3_no_epoch", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 3", "description": { "id": "668008103", "body": "Description of project1_strategic_imperative3_no_epoch_strategic_imperative_metric", "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": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "926116263", "name": "Goal 4", "reference_num": "DEMOENT-G-4", "effort": 40, "value": 30, "color": "#bada55", "position": 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", "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-4", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-4", "description": { "id": "308494954", "body": "Description of project1_strategic_imperative4_active_epoch", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 4", "description": { "id": "330355042", "body": "Description of project1_strategic_imperative4_active_epoch_strategic_imperative_metric", "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" }, "time_frame": { "id": 273422810, "name": "2017" }, "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "952896276", "name": "Goal 5", "reference_num": "PRJ4-G-1", "effort": 40, "value": 30, "color": "#bada55", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "935317104", "progress": null, "progress_source": "progress_manual", "url": "http://company.aha.io/strategic_imperatives/PRJ4-G-1", "resource": "http://company.aha.io/strategic_imperatives/PRJ4-G-1", "description": { "id": "141056933", "body": "Description of project4_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 6", "description": { "id": "250048102", "body": "Description of project4_strategic_imperative1_strategic_imperative_metric", "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": "935317104", "reference_prefix": "PRJ4", "name": "Project 4", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ4" }, "parent": { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } }, "parents": [ { "id": "352745835", "name": "Product Line Goal 1", "url": "http://company.aha.io/strategic_imperatives/PL1-G-1", "resource": "http://company.aha.io/api/v1/goals/PL1-G-1", "created_at": "2019-01-01T00:00:00.000Z", "description": { "id": "79634897", "body": "Description of project2_strategic_imperative1", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] } } ], "initiatives": [ ], "key_results": [ ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] }, { "id": "988418543", "name": "Goal 2", "reference_num": "DEMOENT-G-2", "effort": 40, "value": 30, "color": "#bada55", "position": 3, "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-2", "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-2", "description": { "id": "1055602421", "body": "Description of goal 2", "editor_version": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "attachments": [ ] }, "success_metric": { "name": "Metric 2", "description": { "id": "394826695", "body": "Description of goal 2", "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": [ ], "key_results": [ { "id": "195428809", "name": "KR 3", "reference_num": "DEMOENT-G-1-KR-3", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-3", "position": 3, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "comments_count": 0, "features": [ ], "releases": [ ], "custom_fields": [ ] } ], "pagination": { "total_records": 10, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/initiatives/{initiative_id}/goals": { "get": { "summary": "List goals associated with an initiative", "description": null, "tags": [ "Goals" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/GoalsGetResponse" }, "example": { "goals": [ { "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" } ] } ], "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "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": [ ] } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/goals/{id}": { "put": { "summary": "Update a goal", "description": null, "tags": [ "Goals" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "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/GoalsPutResponse" }, "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": 25, "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" } ] } ], "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%" }, { "id": "1017196896", "name": "KR 2", "reference_num": "DEMOENT-G-1-KR-2", "url": "http://company.aha.io/key_results/DEMOENT-G-1-KR-2", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "progress": null, "target_metric": null, "starting_metric": null, "current_metric": null } ], "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": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoalsPostRequest" }, "example": { "goal": { "description": "An even smarter goal.", "workflow_status": "On Track" } } } } } }, "delete": { "summary": "Delete a goal", "description": null, "tags": [ "Goals" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/strategy_models": { "get": { "summary": "List strategic models", "description": null, "tags": [ "Strategic models" ], "parameters": [ ], "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/StrategicmodelsGetResponse" }, "example": { "strategy_models": [ { "id": "111251416", "name": "Aha! business model canvas", "kind": "Business", "components": [ { "id": 62803905, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/111251416", "resource": "http://company.aha.io/business_models/111251416", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, { "id": "356242517", "name": "Aha! business model canvas", "kind": "Business", "components": [ { "id": 310750587, "name": "Value Proposition", "description": "" } ], "url": "http://company.aha.io/business_models/356242517", "resource": "http://company.aha.io/business_models/356242517", "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" } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/strategy_models/{id}": { "get": { "summary": "Get a specific strategic model", "description": null, "tags": [ "Strategic models" ], "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/StrategicmodelsGetResponse" }, "example": { "strategy_model": { "id": "111251416", "name": "Aha! business model canvas", "kind": "Business", "components": [ { "id": 62803905, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/111251416", "resource": "http://company.aha.io/business_models/111251416", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/strategy_positions": { "get": { "summary": "List strategic positionings", "description": null, "tags": [ "Strategic positionings" ], "parameters": [ ], "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/StrategicpositioningsGetResponse" }, "example": { "strategy_positions": [ { "id": "51832287", "name": "Aha! strategic positioning model canvas", "kind": "Positioning", "components": [ { "id": 260808894, "name": "Value Proposition", "description": "" } ], "url": "http://company.aha.io/business_models/51832287", "resource": "http://company.aha.io/business_models/51832287", "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": "453528824", "name": "Aha! strategic positioning model canvas", "kind": "Positioning", "components": [ { "id": 37485938, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/453528824", "resource": "http://company.aha.io/business_models/453528824", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/strategy_positions/{id}": { "get": { "summary": "Get a specific strategic positioning", "description": null, "tags": [ "Strategic positionings" ], "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/StrategicpositioningsGetResponse" }, "example": { "strategy_positioning": { "id": "453528824", "name": "Aha! strategic positioning model canvas", "kind": "Positioning", "components": [ { "id": 37485938, "name": "Growth opportunity", "description": "" } ], "url": "http://company.aha.io/business_models/453528824", "resource": "http://company.aha.io/business_models/453528824", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/strategy_visions": { "get": { "summary": "List strategic visions", "description": null, "tags": [ "Strategic visions" ], "parameters": [ ], "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/StrategicvisionsGetResponse" }, "example": { "strategy_visions": [ { "id": "262392474", "name": "Project 2 Strategy", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": null, "strategy_vision_components": [ ], "url": "http://company.aha.io/project_strategies/262392474", "resource": "http://company.aha.io/project_strategies/262392474", "project": { "id": "517761884", "reference_prefix": "PRJ2", "name": "Project 2", "product_line": false, "created_at": "2019-01-01T00:00:00.000Z", "workspace_type": "product_workspace", "url": "http://company.aha.io/projects/PRJ2" } }, { "id": "613708188", "name": "Project 1 Strategy", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": null, "strategy_vision_components": [ { "id": 669674847, "name": "Our market", "title": null }, { "id": 1055079655, "name": "Our strengths", "title": null } ], "url": "http://company.aha.io/project_strategies/613708188", "resource": "http://company.aha.io/project_strategies/613708188", "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" } } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/strategy_visions/{id}": { "get": { "summary": "Get a specific strategic vision", "description": null, "tags": [ "Strategic visions" ], "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/StrategicvisionsGetResponse" }, "example": { "strategy_vision": { "id": "613708188", "name": "Project 1 Strategy", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "description": null, "strategy_vision_components": [ { "id": 669674847, "name": "Our market", "title": null }, { "id": 1055079655, "name": "Our strengths", "title": null } ], "url": "http://company.aha.io/project_strategies/613708188", "resource": "http://company.aha.io/project_strategies/613708188", "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" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/tasks": { "post": { "summary": "Create a task", "description": null, "tags": [ "To-dos" ], "parameters": [ ], "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/To-dosPostResponse" }, "example": { "task": { "id": "6776881149495424765", "name": "Review press release", "body": "

Can you please review the press release

", "due_date": null, "status": "pending", "position": null, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "", "assigned_to_users": [ { "id": "6776881149484955852", "status": "pending", "user": { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "6776881149486559736", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/6776881149495424765", "resource": "http://company.aha.io/api/v1/tasks/6776881149495424765", "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/To-dosPostRequest" }, "example": { "task": { "name": "Review press release", "body": "

Can you please review the press release

", "assigned_to_users": [ { "email": "no-reply@aha.io" } ] } } } } } }, "get": { "summary": "List to-dos", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "updated_since", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2019-01-01T00:00:00Z" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Approval" } ], "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/To-dosGetResponse" }, "example": { "tasks": [ { "id": "568474467", "name": "Task name", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/features/{feature_id}/tasks": { "get": { "summary": "List to-dos associated with a feature", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId 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/To-dosGetResponse" }, "example": { "tasks": [ { "id": "748715293", "name": "Task name", "due_date": "2019-01-01", "status": "completed", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/epics/{epic_id}/tasks": { "get": { "summary": "List to-dos associated with an epic", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "epic_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "EpicId 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/To-dosGetResponse" }, "example": { "tasks": [ { "id": "486361616", "name": "Task name", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/releases/{release_id}/tasks": { "get": { "summary": "List to-dos associated with a release", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ReleaseId 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/To-dosGetResponse" }, "example": { "tasks": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/ideas/{idea_id}/tasks": { "get": { "summary": "List to-dos associated with an idea", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "idea_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "IdeaId 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/To-dosGetResponse" }, "example": { "tasks": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/requirements/{requirement_id}/tasks": { "get": { "summary": "List to-dos associated with a requirement", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "requirement_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "RequirementId 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/To-dosGetResponse" }, "example": { "tasks": [ { "id": "270131066", "name": "Do this thing.", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/tasks": { "get": { "summary": "List to-dos associated with a product", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/To-dosGetResponse" }, "example": { "tasks": [ { "id": "270131066", "name": "Do this thing.", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "486361616", "name": "Task name", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "491284354", "name": "Task name", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "644916258", "name": "Task name 1", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "742756265", "name": "Get it done", "due_date": "2019-01-01", "status": "partially_complete", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "748715293", "name": "Task name", "due_date": "2019-01-01", "status": "completed", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "785584324", "name": "Task name", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "896534432", "name": "Annotations task", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "937465541", "name": "Task name 2", "due_date": "2019-01-01", "status": "pending", "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 9, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/users/{user_id}/tasks": { "get": { "summary": "List to-dos assigned to a user", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "UserId 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/To-dosGetResponse" }, "example": { "tasks": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/tasks/{id}": { "get": { "summary": "Get a specific to-do", "description": null, "tags": [ "To-dos" ], "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/To-dosGetResponse" }, "example": { "task": { "id": "1041191038", "name": "Task name", "body": "Task body", "due_date": "2019-01-01", "status": "partially_complete", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "", "assigned_to_users": [ { "id": "1061194521", "status": "completed", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "id": "642374309", "status": "pending", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/1041191038", "resource": "http://company.aha.io/api/v1/tasks/1041191038", "comments_count": 0 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a to-do", "description": null, "tags": [ "To-dos" ], "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/To-dosPutResponse" }, "example": { "task": { "id": "568474467", "name": "Task name", "body": "Task body", "due_date": "2019-01-01", "status": "completed", "position": 1, "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "product_id": "702241743", "assigned_to_users": [ { "id": "938180846", "status": "completed", "completed_date": "2019-01-01T00:00:00.000Z", "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" } } ], "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" }, "attachments": [ ], "url": "http://company.aha.io/tasks/568474467", "resource": "http://company.aha.io/api/v1/tasks/568474467", "comments_count": 0, "taskable": { "type": "Feature", "id": "959120953", "reference_num": "PRJ3-2", "name": "A third Feature", "url": "http://company.aha.io/features/PRJ3-2", "resource": "http://company.aha.io/api/v1/features/PRJ3-2" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/To-dosPostRequest" }, "example": { "task": { "body": "

Can you please review this press release

" } } } } } }, "delete": { "summary": "Delete a to-do", "description": null, "tags": [ "To-dos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/team_members": { "post": { "summary": "Create a virtual user", "description": "Manage virtual users used in capacity planning", "tags": [ "Team members" ], "parameters": [ ], "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/TeammembersPostResponse" }, "example": { "team_member": { "id": "6776881149494512236", "name": "Sam Doe", "email": "sam.doe@example.com", "user_id": null, "virtual": true } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeammembersPostRequest" }, "example": { "team_member": { "first_name": "Sam", "last_name": "Doe", "email": "sam.doe@example.com" } } } } } }, "get": { "summary": "List virtual team members", "description": "Manage virtual users used in capacity planning", "tags": [ "Team members" ], "parameters": [ { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/TeammembersGetResponse" }, "example": { "team_members": [ { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/team_members/{id}": { "delete": { "summary": "Delete a virtual team member", "description": "Manage virtual users used in capacity planning", "tags": [ "Team members" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeammembersPostRequest" }, "example": { } } } } } }, "/api/v1/teams/{team_id}/team_memberships": { "post": { "summary": "Add user to a team", "description": "Team memberships for capacity planning teams. Users can be either Aha! users or virtual users", "tags": [ "Team memberships" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "TeamId identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeammembershipsPostRequest" }, "example": { "team_membership": { "user_id": 689956296 } } } } } }, "get": { "summary": "List team memberships for a team", "description": "Team memberships for capacity planning teams. Users can be either Aha! users or virtual users", "tags": [ "Team memberships" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "TeamId identifier" }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "example": "team_member,team,created_at" } ], "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/TeammembershipsGetResponse" }, "example": { "team_memberships": [ { "id": "202266373", "team_member": { "id": "540018633", "name": "John Johnson", "email": "john.johnson@corporation.com", "user_id": null, "virtual": true }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" }, { "id": "646482528", "team_member": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false }, "team": { "id": "949295028", "name": "Default team" }, "created_at": "2019-01-01T00:00:00.000Z" } ], "pagination": { "total_records": 2, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/teams/{team_id}/team_memberships/{id}": { "delete": { "summary": "Remove a user from a team", "description": "Team memberships for capacity planning teams. Users can be either Aha! users or virtual users", "tags": [ "Team memberships" ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "TeamId identifier" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeammembershipsPostRequest" }, "example": { } } } } } }, "/api/v1/teams": { "post": { "summary": "Create a team", "description": null, "tags": [ "Teams" ], "parameters": [ ], "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/TeamsPostResponse" }, "example": { "team": { "id": "6776881149488280595", "name": "Account team", "team_members_count": 0, "automatically_calculate_team_members_count": true, "capacity": 0, "hourly_rate": null, "color": "#666666", "start_date": null, "end_date": null, "project": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsPostRequest" }, "example": { "team": { "name": "Account team" } } } } } }, "get": { "summary": "List teams", "description": null, "tags": [ "Teams" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "schema": { "type": "string" }, "example": "name,team_members_count,automatically_calculate_team_members_count,capacity,hourly_rate,color,start_date,end_date,project,schedule,custom_fields,team_members" } ], "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/TeamsGetResponse" }, "example": { "teams": [ { "id": "134558347", "name": "Project team", "team_members_count": 0, "automatically_calculate_team_members_count": false, "capacity": "0.0", "hourly_rate": "250.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "project": { "id": "131414752", "reference_prefix": "PRJ1", "name": "Project 1", "product_line": false, "workspace_type": "product_workspace" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "730311797", "name": "Peter Parker", "email": null, "user_id": null, "virtual": true } }, { "id": "563889676", "name": "Another team", "team_members_count": 0, "automatically_calculate_team_members_count": false, "capacity": "0.0", "hourly_rate": "150.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "project": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } }, { "id": "949295028", "name": "Default team", "team_members_count": 5, "automatically_calculate_team_members_count": false, "capacity": "205.0", "hourly_rate": "100.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "project": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } } ], "pagination": { "total_records": 3, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/teams": { "post": { "summary": "Create a team associated with a product", "description": null, "tags": [ "Teams" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/TeamsPostResponse" }, "example": { "team": { "id": "6776881149489987892", "name": "Product team", "team_members_count": 0, "automatically_calculate_team_members_count": true, "capacity": 0, "hourly_rate": null, "color": "#666666", "start_date": null, "end_date": null, "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" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsPostRequest" }, "example": { "team": { "product_id": "PRJ1", "name": "Product team" } } } } } }, "get": { "summary": "List teams in a product", "description": null, "tags": [ "Teams" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/TeamsGetResponse" }, "example": { "teams": [ ], "pagination": { "total_records": 0, "total_pages": 0, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/teams/{id}": { "get": { "summary": "Get a specific team", "description": null, "tags": [ "Teams" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "{}", "in": "query", "required": false, "schema": { "type": "string" }, "example": null } ], "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/TeamsGetResponse" }, "example": { "team": { "id": "949295028", "name": "Default team", "team_members_count": 5, "automatically_calculate_team_members_count": false, "capacity": "205.0", "hourly_rate": "100.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "project": null, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "960059005", "name": "Mary Humpty", "email": "no-reply@aha.io", "user_id": "1020675218", "virtual": false } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a team's product", "description": null, "tags": [ "Teams" ], "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/TeamsPutResponse" }, "example": { "team": { "id": "134558347", "name": "Project team", "team_members_count": 1, "automatically_calculate_team_members_count": true, "capacity": "41.0", "hourly_rate": "250.0", "color": "#666666", "start_date": "2019-01-01", "end_date": "2019-01-01", "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" }, "schedule": { "id": "441193141", "name": "Default schedule", "hours_per_day": "8.2", "story_points_per_day": "1.0", "velocity": "10.5" }, "custom_fields": [ ], "team_members": { "id": "730311797", "name": "Peter Parker", "email": null, "user_id": null, "virtual": true } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsPostRequest" }, "example": { "team": { "name": "Product 2 team", "product_id": "PRJ2" } } } } } }, "delete": { "summary": "Delete a team", "description": null, "tags": [ "Teams" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamsPostRequest" }, "example": { } } } } } }, "/api/v1/features/{feature_id}/time_tracking_events": { "post": { "summary": "Create a time tracking event for a feature with remaining estimate", "description": null, "tags": [ "Time tracking events" ], "parameters": [ { "name": "feature_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "FeatureId 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/TimetrackingeventsPostResponse" }, "example": { "time_tracking_event": { "id": "6776881149487861795", "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" }, "occurred_on": "2019-01-01", "work_done": 5.0, "work_units": 20 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimetrackingeventsPostRequest" }, "example": { "time_tracking_event": { "user_id": 689956296, "work_done_text": "1h 30min", "remaining_estimate_text": "2h" } } } } } } }, "/api/v1/requirements/{requirement_id}/time_tracking_events": { "post": { "summary": "Create a time tracking event for a requirement", "description": null, "tags": [ "Time tracking events" ], "parameters": [ { "name": "requirement_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "RequirementId 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/TimetrackingeventsPostResponse" }, "example": { "time_tracking_event": { "id": "6776881149499571657", "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" }, "occurred_on": "2019-01-01", "work_done": 120.0, "work_units": 10 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimetrackingeventsPostRequest" }, "example": { "time_tracking_event": { "user_id": 689956296, "work_done_text": "2h" } } } } } } }, "/api/v1/initiatives/{initiative_id}/time_tracking_events": { "post": { "summary": "Create a time tracking event for an initiative", "description": null, "tags": [ "Time tracking events" ], "parameters": [ { "name": "initiative_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "InitiativeId 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/TimetrackingeventsPostResponse" }, "example": { "time_tracking_event": { "id": "6776881149484363523", "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" }, "occurred_on": "2019-01-01", "work_done": 120.0, "work_units": 10 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimetrackingeventsPostRequest" }, "example": { "time_tracking_event": { "user_id": 689956296, "work_done_text": "2h" } } } } } } }, "/api/v1/time_tracking_events/{id}": { "delete": { "summary": "Delete a time tracking event", "description": null, "tags": [ "Time tracking events" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/users": { "post": { "summary": "Create a user", "description": null, "tags": [ "Users" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/UsersPostResponse" }, "example": { "role": 20, "role_description": "Owner", "user": { "id": "6776881149496250378", "name": "sam doe", "email": "sam.doe@example.com", "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/UsersPostRequest" }, "example": { "user": { "email": "sam.doe@example.com", "first_name": "sam", "last_name": "doe", "role": "product_owner" } } } } } }, "get": { "summary": "List users associated with a product", "description": null, "tags": [ "Users" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/UsersGetResponse" }, "example": { "project_users": [ { "role": 50, "role_description": "Viewer", "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" } }, { "role": 20, "role_description": "Owner", "user": { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 30, "role_description": "Contributor", "user": { "id": "289520357", "name": "John Doe", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 30, "role_description": "Contributor", "user": { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 35, "role_description": "Developer", "user": { "id": "375285024", "name": "Gregory McSmith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 50, "role_description": "Viewer", "user": { "id": "435166761", "name": "Jane Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 40, "role_description": "Reviewer", "user": { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 30, "role_description": "Contributor", "user": { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 20, "role_description": "Owner", "user": { "id": "871344824", "name": "Joan Smith", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } }, { "role": 20, "role_description": "Owner", "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" } }, { "role": 20, "role_description": "Owner", "user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z" } } ], "pagination": { "total_records": 11, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/users": { "get": { "summary": "List users", "description": "**[Custom roles](https://www.aha.io/support/roadmaps/account/billing-and-users/custom-user-permission-roles) are an Enterprise+ exclusive feature.**", "tags": [ "Users" ], "parameters": [ ], "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/UsersGetResponse" }, "example": { "users": [ { "id": "16338845", "name": "John Smith", "email": "no-reply@aha.io", "timezone": "Pacific/Auckland", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 50, "role_description": "Viewer", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "37063167", "name": "No Projects", "email": "no-reply@aha.io", "timezone": "America/Mexico_City", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "identity_provider": { "type": "password" } }, { "id": "82352673", "name": "Bob Smith", "email": "no-reply@aha.io", "timezone": "Asia/Istanbul", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" }, { "role": 20, "role_description": "Owner", "product_id": "517761884", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "610602692", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "787060436", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "682804944", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "774939364", "product_name": null } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": false, "administer_configuration": true }, "paid_seat_group": { "id": 572805993, "name": "Group 2" }, "identity_provider": { "type": "password" } }, { "id": "126225962", "name": "Multi Account", "email": "mulit-account@trial-account.com", "timezone": "Asia/Kolkata", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "identity_provider": { "type": "password" } }, { "id": "267654265", "name": "John's First (\"name\") 私 Smith", "email": "no-reply@aha.io", "timezone": "America/Indiana/Knox", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "268195287", "name": "Super Admin", "email": "admin@aha.io", "timezone": "America/New_York", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "289520357", "name": "John Doe", "email": "no-reply@aha.io", "timezone": "America/Mexico_City", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 30, "role_description": "Contributor", "product_id": "131414752", "product_name": "Project 1" }, { "role": 50, "role_description": "Viewer", "product_id": "517761884", "product_name": null } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "349538572", "name": "Sally Sane", "email": "sally.sane@account2.com", "timezone": "Europe/London", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 30, "role_description": "Contributor", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "373433676", "name": "Jim Jingles", "email": "no-reply@aha.io", "timezone": "Pacific Time (US & Canada)", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "paid_seat_group": { "id": 992805589, "name": "Group 1" }, "identity_provider": { "type": "password" } }, { "id": "375285024", "name": "Gregory McSmith", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 35, "role_description": "Developer", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "435166761", "name": "Jane Smith", "email": "no-reply@aha.io", "timezone": "Antarctica/McMurdo", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 50, "role_description": "Viewer", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "501775768", "name": "Frank Sane", "email": "frank.sane@account2.com", "timezone": "Europe/Lisbon", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "530313708", "name": "Bill Billings", "email": "no-reply@aha.io", "timezone": "Pacific Time (US & Canada)", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": false, "administer_billing": true, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "601067208", "name": "Jeremy Smith", "email": "no-reply@aha.io", "timezone": "America/Indiana/Indianapolis", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 40, "role_description": "Reviewer", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "689956296", "name": "Henry Humpty", "email": "no-reply@aha.io", "timezone": "Asia/Tokyo", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": "2019-01-01T00:00:00.000Z", "product_roles": [ { "role": 30, "role_description": "Contributor", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "733218216", "name": "Everso Gently", "email": "no-reply@aha.io", "timezone": "Asia/Kathmandu", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "identity_provider": { "type": "password" } }, { "id": "787951284", "name": "Jeremy Thompson", "email": "no-reply@aha.io", "timezone": "America/Regina", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 50, "role_description": "Viewer", "product_id": "1040810565", "product_name": null } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "869174989", "name": "Dirk Gently", "email": "no-reply@aha.io", "timezone": "America/Havana", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "identity_provider": { "type": "password" } }, { "id": "871344824", "name": "Joan Smith", "email": "no-reply@aha.io", "timezone": "Asia/Istanbul", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": false, "administer_configuration": true }, "paid_seat_group": { "id": 572805993, "name": "Group 2" }, "identity_provider": { "type": "password" } }, { "id": "1020675218", "name": "Mary Humpty", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": "2019-01-01T00:00:00.000Z", "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" }, { "role": 20, "role_description": "Owner", "product_id": "517761884", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "610602692", "product_name": null } ], "user_roles": [ ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } }, { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" } ], "user_roles": [ { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Account 1", "id": 303742481 } } ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "identity_provider": { "type": "password" } } ], "pagination": { "total_records": 21, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/users/{id}": { "get": { "summary": "Get a specific user", "description": null, "tags": [ "Users" ], "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/UsersGetResponse" }, "example": { "user": { "id": "1049303076", "name": "George Gently", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": null, "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" } ], "enabled": true, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": true, "administrator_roles": { "administer_account": true, "administer_billing": true, "administer_configuration": true }, "identity_provider": { "type": "password" } } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "put": { "summary": "Update a user", "description": null, "tags": [ "Users" ], "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/UsersPutResponse" }, "example": { "id": "1020675218", "name": "Sarah Humpty", "email": "no-reply@aha.io", "timezone": "America/Los_Angeles", "created_at": "2019-01-01T00:00:00.000Z", "updated_at": "2019-01-01T00:00:00.000Z", "accessed_at": "2019-01-01T00:00:00.000Z", "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" }, { "role": 20, "role_description": "Owner", "product_id": "517761884", "product_name": null }, { "role": 20, "role_description": "Owner", "product_id": "610602692", "product_name": null } ], "enabled": false, "paid_seat": true, "roadmaps_seat": true, "develop_seat": false, "teamwork_seat": false, "administrator": false, "administrator_roles": { "administer_account": false, "administer_billing": false, "administer_configuration": false }, "identity_provider": { "type": "password" } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersPostRequest" }, "example": { "user": { "first_name": "Sarah", "enabled": false } } } } } } }, "/api/v1/users/{id}/product_roles": { "get": { "summary": "List a user's product roles", "description": null, "tags": [ "Users" ], "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/UsersGetResponse" }, "example": { "product_roles": [ { "role": 20, "role_description": "Owner", "product_id": "131414752", "product_name": "Project 1" } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Update a user's product roles", "description": null, "tags": [ "Users" ], "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/UsersPostResponse" }, "example": { "role": 20, "role_description": "Owner", "product_id": "702241743", "product_name": null } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersPostRequest" }, "example": { "product_role": { "role": "product_owner", "product_id": "PRJ3" } } } } } } }, "/api/v1/users/{id}/product_roles/{product_id}": { "delete": { "summary": "Delete a user's product role", "description": null, "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/users/{id}/user_roles": { "get": { "summary": "List a user's custom roles", "description": null, "tags": [ "Users" ], "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/UsersGetResponse" }, "example": { "user_roles": [ { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Project 1", "id": 131414752 } } ], "pagination": { "total_records": 1, "total_pages": 1, "current_page": 1 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "post": { "summary": "Update a user's custom roles", "description": null, "tags": [ "Users" ], "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/UsersPostResponse" }, "example": { "role_id": 409541421, "name": "Project scoped role 1", "scope": { "type": "project", "name": "Project 1", "id": 131414752 } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersPostRequest" }, "example": { "user_role": { "custom_role_id": 409541421, "product_id": 131414752 } } } } } } }, "/api/v1/users/{id}/user_roles/{product_id}": { "delete": { "summary": "Delete a user's custom role", "description": null, "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Id identifier" }, { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId identifier" } ], "responses": { "204": { "description": "No content - operation successful" } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/webhooks/{token}": { "post": { "summary": "Process a Jira webhook", "description": "Receives and processes a webhook from Jira when an issue is updated.\n\nTypical Jira webhook payload includes:\n- issue: { id: \"12345\", key: \"PROJ-123\", fields: { summary: \"Feature name\", status: { name: \"In Progress\" } } }\n- webhookEvent: \"jira:issue_updated\"\n- timestamp: \"2019-01-01T00:00:00Z\"", "tags": [ "Webhooks" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Token identifier" } ], "responses": { "200": { "description": "Successful operation", "headers": { "Content-Type": { "description": "application/json", "schema": { "type": "string" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] }, "get": { "summary": "Validate webhook endpoint", "description": "This endpoint allows integration services to validate that the webhook URL \nis accessible and properly configured without triggering actual webhook processing.\nUseful for testing webhook connectivity during integration setup.", "tags": [ "Webhooks" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Token identifier" } ], "responses": { "200": { "description": "Successful operation", "headers": { "Content-Type": { "description": "text/plain; charset=utf-8", "schema": { "type": "string" } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/products/{product_id}/workflows": { "get": { "summary": "List workflows", "description": null, "tags": [ "Workflows" ], "parameters": [ { "name": "product_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ProductId 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/WorkflowsGetResponse" }, "example": { "workflows": [ { "id": 61191651, "name": "Account initiative workflow", "statusable_type": "Initiative", "transitions_only": false, "workflow_statuses": [ { "id": "53968949", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "851912549", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, { "id": "398063383401136128", "name": "Sample 15", "position": 17, "complete": false, "color": "#ecdd8f" }, { "id": "398063383401136148", "name": "Sample 3", "position": 5, "complete": false, "color": "#ecdd8f" }, { "id": "398063383401136158", "name": "Sample 1", "position": 3, "complete": false, "color": "#ecdd8f" }, { "id": "398063383401136168", "name": "Sample 2", "position": 4, "complete": false, "color": "#ecdd8f" }, { "id": "398063383401136178", "name": "Sample 14", "position": 16, "complete": false, "color": "#ecdd8f" }, { "id": "420001850772881408", "name": "Sample 12", "position": 14, "complete": false, "color": "#ecdd8f" }, { "id": "420001850772881428", "name": "Sample 7", "position": 9, "complete": false, "color": "#ecdd8f" }, { "id": "420001850772881438", "name": "Sample 5", "position": 7, "complete": false, "color": "#ecdd8f" }, { "id": "420001850772881448", "name": "Sample 4", "position": 6, "complete": false, "color": "#ecdd8f" }, { "id": "6001166979456424024", "name": "Sample 19", "position": 21, "complete": false, "color": "#ecdd8f" }, { "id": "6001166979457568121", "name": "Sample 16", "position": 18, "complete": false, "color": "#ecdd8f" }, { "id": "6001166983749861123", "name": "Sample 18", "position": 20, "complete": false, "color": "#ecdd8f" }, { "id": "6001166983750348036", "name": "Sample 20", "position": 22, "complete": false, "color": "#ecdd8f" }, { "id": "6001166983752519805", "name": "Sample 17", "position": 19, "complete": false, "color": "#ecdd8f" }, { "id": "6001166983754160302", "name": "Sample 21", "position": 23, "complete": false, "color": "#ecdd8f" }, { "id": "6013053275675082840", "name": "Sample 13", "position": 15, "complete": false, "color": "#ecdd8f" }, { "id": "6013053275678580297", "name": "Sample 11", "position": 13, "complete": false, "color": "#ecdd8f" }, { "id": "6013053275679470036", "name": "Sample 10", "position": 12, "complete": false, "color": "#ecdd8f" }, { "id": "6013053275679792248", "name": "Sample 9", "position": 11, "complete": false, "color": "#ecdd8f" }, { "id": "6013053284264084983", "name": "Sample 8", "position": 10, "complete": false, "color": "#ecdd8f" }, { "id": "6013053284269398016", "name": "Sample 6", "position": 8, "complete": false, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "196299900", "name": "Improvement" }, { "id": "654498607", "name": "New" } ] }, { "id": 80245244, "name": "Account product idea workflow", "statusable_type": "Idea", "transitions_only": false, "workflow_statuses": [ { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "349486678", "name": "Shipped", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "1809278", "name": "Improvement" }, { "id": "787053401", "name": "New" } ] }, { "id": 499195972, "name": "Account product feature workflow", "statusable_type": "Feature", "transitions_only": false, "workflow_statuses": [ { "id": "118531893", "name": "Already Exists", "position": 7, "complete": true, "color": "#ecdd8f" }, { "id": "327385593", "name": "In progress", "position": 3, "complete": false, "color": "#ecdd8f" }, { "id": "348961883", "name": "Won't Do", "position": 6, "complete": false, "color": "#ecdd8f" }, { "id": "597153450", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "922838743", "name": "Not started", "position": 8, "complete": false, "color": "#dce790" }, { "id": "934242751", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "962984386", "name": "Designed", "position": 2, "complete": false, "color": "#ecdd8f" }, { "id": "1025247908", "name": "Shipped", "position": 5, "complete": true, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "98484309", "name": "New" }, { "id": "714950177", "name": "Improvement" } ] }, { "id": 717623509, "name": "Account product release workflow", "statusable_type": "Release", "transitions_only": false, "workflow_statuses": [ { "id": "738862546", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "920959666", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" }, { "id": "1040256814", "name": "Shipped", "position": 3, "complete": true, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "97513727", "name": "Improvement" }, { "id": "706521964", "name": "New" }, { "id": "6053108729101086872", "name": "Sample 1" } ] }, { "id": 883066232, "name": "Account goal workflow", "statusable_type": "StrategicImperative", "transitions_only": false, "workflow_statuses": [ { "id": "396368932", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, { "id": "412273758", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" } ], "workflow_kinds": [ { "id": "146845716", "name": "New" }, { "id": "618789532", "name": "Improvement" } ] }, { "id": 934299270, "name": "Account document workflow", "statusable_type": "Page", "transitions_only": false, "workflow_statuses": [ { "id": "353277314", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, { "id": "369936966", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "783316433", "name": "In Review", "position": 3, "complete": false, "color": "#ecdcb8" } ], "workflow_kinds": [ ] }, { "id": 1024772447, "name": "Account product key result workflow", "statusable_type": "KeyResult", "transitions_only": false, "workflow_statuses": [ { "id": "76947914", "name": "On Track", "position": 2, "complete": false, "color": "#ecdd8f" }, { "id": "496533981", "name": "Not Started", "position": 1, "complete": false, "color": "#dce7c6" } ], "workflow_kinds": [ { "id": "318525598", "name": "New" }, { "id": "941130642", "name": "Improvement" } ] } ] } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } }, "/api/v1/workflows/{id}": { "get": { "summary": "Get a specific workflow", "description": null, "tags": [ "Workflows" ], "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/WorkflowsGetResponse" }, "example": { "workflow": { "id": 80245244, "name": "Account product idea workflow", "statusable_type": "Idea", "transitions_only": false, "workflow_statuses": [ { "id": "3259216", "name": "New", "position": 1, "complete": false, "color": "#dce7c6" }, { "id": "349486678", "name": "Shipped", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "509459046", "name": "Done", "position": 4, "complete": true, "color": "#ecdd8f" }, { "id": "1009437757", "name": "In progress", "position": 2, "complete": false, "color": "#ecdd8f" } ], "workflow_kinds": [ { "id": "1809278", "name": "Improvement" }, { "id": "787053401", "name": "New" } ] } } } } } }, "security": [ { "OAuth2": [ ] }, { "ApiKeyAuth": [ ] }, { "CookieAuth": [ ] } ] } } } }