Sisense REST API — Dashboards

naftiko: 1.0.0-alpha2
info:
  label: Sisense REST API — Dashboards
  description: 'Sisense REST API — Dashboards. 5 operations. Lead operation: List Dashboards. Self-contained Naftiko capability
    covering one Sisense business surface.'
  tags:
  - Sisense
  - Dashboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SISENSE_API_KEY: SISENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-dashboards
    baseUri: https://{host}/api/v1
    description: Sisense REST API — Dashboards business capability. Self-contained, no shared references.
    resources:
    - name: dashboards
      path: /dashboards
      operations:
      - name: listdashboards
        method: GET
        description: List Dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Comma-separated list of fields to include in response
        - name: sort
          in: query
          type: string
          description: Field to sort by (prefix with - for descending)
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return
        - name: skip
          in: query
          type: integer
          description: Number of results to skip for pagination
        - name: expand
          in: query
          type: string
          description: Replace foreign key IDs with full entity objects
      - name: createdashboard
        method: POST
        description: Create Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: dashboards-admin
      path: /dashboards/admin
      operations:
      - name: listalldashboards
        method: GET
        description: List All Dashboards (Admin)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
        - name: skip
          in: query
          type: integer
    - name: dashboards-id
      path: /dashboards/{id}
      operations:
      - name: getdashboard
        method: GET
        description: Get Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Dashboard identifier
          required: true
        - name: fields
          in: query
          type: string
          description: Fields to include in response
      - name: deletedashboard
        method: DELETE
        description: Delete Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Dashboard identifier
          required: true
    authentication:
      type: bearer
      token: '{{env.SISENSE_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-dashboards-rest
    port: 8080
    description: REST adapter for Sisense REST API — Dashboards. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/dashboards
      name: dashboards
      description: REST surface for dashboards.
      operations:
      - method: GET
        name: listdashboards
        description: List Dashboards
        call: rest-dashboards.listdashboards
        with:
          fields: rest.fields
          sort: rest.sort
          limit: rest.limit
          skip: rest.skip
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdashboard
        description: Create Dashboard
        call: rest-dashboards.createdashboard
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/admin
      name: dashboards-admin
      description: REST surface for dashboards-admin.
      operations:
      - method: GET
        name: listalldashboards
        description: List All Dashboards (Admin)
        call: rest-dashboards.listalldashboards
        with:
          limit: rest.limit
          skip: rest.skip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{id}
      name: dashboards-id
      description: REST surface for dashboards-id.
      operations:
      - method: GET
        name: getdashboard
        description: Get Dashboard
        call: rest-dashboards.getdashboard
        with:
          id: rest.id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedashboard
        description: Delete Dashboard
        call: rest-dashboards.deletedashboard
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-dashboards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sisense REST API — Dashboards. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-dashboards
      description: List Dashboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-dashboards.listdashboards
      with:
        fields: tools.fields
        sort: tools.sort
        limit: tools.limit
        skip: tools.skip
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: create-dashboard
      description: Create Dashboard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-dashboards.createdashboard
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-dashboards-admin
      description: List All Dashboards (Admin)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-dashboards.listalldashboards
      with:
        limit: tools.limit
        skip: tools.skip
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dashboard
      description: Get Dashboard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-dashboards.getdashboard
      with:
        id: tools.id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-dashboard
      description: Delete Dashboard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-dashboards.deletedashboard
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.