Aha.io Strategic models API

The Strategic models API from Aha.io — 2 operation(s) for strategic models.

OpenAPI Specification

aha-strategic-models-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Aha! Account backups Strategic models 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
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Strategic models
paths:
  /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: []
components:
  schemas:
    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
  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