IFS Cloud ERP API — Work Orders

naftiko: 1.0.0-alpha2
info:
  label: IFS Cloud ERP API — Work Orders
  description: 'IFS Cloud ERP API — Work Orders. 2 operations. Lead operation: List work orders. Self-contained Naftiko capability
    covering one Ifs business surface.'
  tags:
  - Ifs
  - Work Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    IFS_API_KEY: IFS_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-erp-work-orders
    baseUri: https://{tenant}.ifs.cloud/main/ifsapp/data
    description: IFS Cloud ERP API — Work Orders business capability. Self-contained, no shared references.
    resources:
    - name: WORK_ORDER_API
      path: /WORK_ORDER_API
      operations:
      - name: listworkorders
        method: GET
        description: List work orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: $filter
          in: query
          type: string
          description: OData filter (e.g., "WoStatus eq 'Released' and ContractId eq 'SITE1'")
        - name: $top
          in: query
          type: integer
        - name: $skip
          in: query
          type: integer
    - name: WORK_ORDER_API(WoNo={woNo})
      path: /WORK_ORDER_API(WoNo={woNo})
      operations:
      - name: getworkorder
        method: GET
        description: Get work order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: woNo
          in: path
          type: integer
          description: Work order number
          required: true
    authentication:
      type: bearer
      token: '{{env.IFS_API_KEY}}'
  exposes:
  - type: rest
    namespace: cloud-erp-work-orders-rest
    port: 8080
    description: REST adapter for IFS Cloud ERP API — Work Orders. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/work-order-api
      name: work-order-api
      description: REST surface for WORK_ORDER_API.
      operations:
      - method: GET
        name: listworkorders
        description: List work orders
        call: cloud-erp-work-orders.listworkorders
        with:
          $filter: rest.$filter
          $top: rest.$top
          $skip: rest.$skip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/work-order-api-wono-wono
      name: work-order-api-wono-wono
      description: REST surface for WORK_ORDER_API(WoNo={woNo}).
      operations:
      - method: GET
        name: getworkorder
        description: Get work order
        call: cloud-erp-work-orders.getworkorder
        with:
          woNo: rest.woNo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cloud-erp-work-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for IFS Cloud ERP API — Work Orders. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-work-orders
      description: List work orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-erp-work-orders.listworkorders
      with:
        $filter: tools.$filter
        $top: tools.$top
        $skip: tools.$skip
      outputParameters:
      - type: object
        mapping: $.
    - name: get-work-order
      description: Get work order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cloud-erp-work-orders.getworkorder
      with:
        woNo: tools.woNo
      outputParameters:
      - type: object
        mapping: $.