Navis N4 Terminal Operating System REST API — Holds

naftiko: 1.0.0-alpha2
info:
  label: Navis N4 Terminal Operating System REST API — Holds
  description: 'Navis N4 Terminal Operating System REST API — Holds. 1 operations. Lead operation: List active holds on units.
    Self-contained Naftiko capability covering one Navis business surface.'
  tags:
  - Navis
  - Holds
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NAVIS_API_KEY: NAVIS_API_KEY
capability:
  consumes:
  - type: http
    namespace: n4-holds
    baseUri: https://{terminal}.navis.example.com/apex/n4/api/v2
    description: Navis N4 Terminal Operating System REST API — Holds business capability. Self-contained, no shared references.
    resources:
    - name: holds
      path: /holds
      operations:
      - name: listholds
        method: GET
        description: List active holds on units
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitNbr
          in: query
          type: string
        - name: holdType
          in: query
          type: string
        - name: limit
          in: query
          type: integer
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.NAVIS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: n4-holds-rest
    port: 8080
    description: REST adapter for Navis N4 Terminal Operating System REST API — Holds. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/holds
      name: holds
      description: REST surface for holds.
      operations:
      - method: GET
        name: listholds
        description: List active holds on units
        call: n4-holds.listholds
        with:
          unitNbr: rest.unitNbr
          holdType: rest.holdType
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: n4-holds-mcp
    port: 9090
    transport: http
    description: MCP adapter for Navis N4 Terminal Operating System REST API — Holds. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-active-holds-units
      description: List active holds on units
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: n4-holds.listholds
      with:
        unitNbr: tools.unitNbr
        holdType: tools.holdType
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.