Navis N4 Terminal Operating System REST API — Units

naftiko: 1.0.0-alpha2
info:
  label: Navis N4 Terminal Operating System REST API — Units
  description: 'Navis N4 Terminal Operating System REST API — Units. 2 operations. Lead operation: Search container units.
    Self-contained Naftiko capability covering one Navis business surface.'
  tags:
  - Navis
  - Units
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NAVIS_API_KEY: NAVIS_API_KEY
capability:
  consumes:
  - type: http
    namespace: n4-units
    baseUri: https://{terminal}.navis.example.com/apex/n4/api/v2
    description: Navis N4 Terminal Operating System REST API — Units business capability. Self-contained, no shared references.
    resources:
    - name: units
      path: /units
      operations:
      - name: searchunits
        method: GET
        description: Search container units
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitNbr
          in: query
          type: string
          description: Container number (ISO 6346 format, e.g., MSCU1234567)
        - name: equipmentType
          in: query
          type: string
        - name: category
          in: query
          type: string
        - name: freightKind
          in: query
          type: string
        - name: positionLocType
          in: query
          type: string
        - name: lineOperator
          in: query
          type: string
          description: Shipping line SCAC code
        - name: vesselVisit
          in: query
          type: string
          description: Vessel visit identifier
        - name: limit
          in: query
          type: integer
        - name: offset
          in: query
          type: integer
    - name: units-unitId
      path: /units/{unitId}
      operations:
      - name: getunit
        method: GET
        description: Get container unit details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          description: N4 unit identifier or ISO 6346 container number
          required: true
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.NAVIS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: n4-units-rest
    port: 8080
    description: REST adapter for Navis N4 Terminal Operating System REST API — Units. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/units
      name: units
      description: REST surface for units.
      operations:
      - method: GET
        name: searchunits
        description: Search container units
        call: n4-units.searchunits
        with:
          unitNbr: rest.unitNbr
          equipmentType: rest.equipmentType
          category: rest.category
          freightKind: rest.freightKind
          positionLocType: rest.positionLocType
          lineOperator: rest.lineOperator
          vesselVisit: rest.vesselVisit
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/units/{unitid}
      name: units-unitid
      description: REST surface for units-unitId.
      operations:
      - method: GET
        name: getunit
        description: Get container unit details
        call: n4-units.getunit
        with:
          unitId: rest.unitId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: n4-units-mcp
    port: 9090
    transport: http
    description: MCP adapter for Navis N4 Terminal Operating System REST API — Units. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: search-container-units
      description: Search container units
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: n4-units.searchunits
      with:
        unitNbr: tools.unitNbr
        equipmentType: tools.equipmentType
        category: tools.category
        freightKind: tools.freightKind
        positionLocType: tools.positionLocType
        lineOperator: tools.lineOperator
        vesselVisit: tools.vesselVisit
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: get-container-unit-details
      description: Get container unit details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: n4-units.getunit
      with:
        unitId: tools.unitId
      outputParameters:
      - type: object
        mapping: $.