API ServiceOrdering — cancelServiceOrder

naftiko: 1.0.0-alpha2
info:
  label: API ServiceOrdering — cancelServiceOrder
  description: 'API ServiceOrdering — cancelServiceOrder. 3 operations. Lead operation: List or find CancelServiceOrder objects.
    Self-contained Naftiko capability covering one Tm Forum business surface.'
  tags:
  - Tm Forum
  - cancelServiceOrder
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TM_FORUM_API_KEY: TM_FORUM_API_KEY
capability:
  consumes:
  - type: http
    namespace: tmf641-service-ordering-cancelserviceorder
    baseUri: https://serverRoot/tmf-api/serviceOrdering/v4
    description: API ServiceOrdering — cancelServiceOrder business capability. Self-contained, no shared references.
    resources:
    - name: cancelServiceOrder
      path: /cancelServiceOrder
      operations:
      - name: listcancelserviceorder
        method: GET
        description: List or find CancelServiceOrder objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to be provided in response
        - name: offset
          in: query
          type: integer
          description: Requested index for start of resources to be provided in response
        - name: limit
          in: query
          type: integer
          description: Requested number of resources to be provided in response
      - name: createcancelserviceorder
        method: POST
        description: Creates a CancelServiceOrder
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cancelServiceOrder
          in: body
          type: string
          description: The CancelServiceOrder to be created
          required: true
    - name: cancelServiceOrder-id
      path: /cancelServiceOrder/{id}
      operations:
      - name: retrievecancelserviceorder
        method: GET
        description: Retrieves a CancelServiceOrder by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the CancelServiceOrder
          required: true
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to provide in response
  exposes:
  - type: rest
    namespace: tmf641-service-ordering-cancelserviceorder-rest
    port: 8080
    description: REST adapter for API ServiceOrdering — cancelServiceOrder. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/cancelserviceorder
      name: cancelserviceorder
      description: REST surface for cancelServiceOrder.
      operations:
      - method: GET
        name: listcancelserviceorder
        description: List or find CancelServiceOrder objects
        call: tmf641-service-ordering-cancelserviceorder.listcancelserviceorder
        with:
          fields: rest.fields
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcancelserviceorder
        description: Creates a CancelServiceOrder
        call: tmf641-service-ordering-cancelserviceorder.createcancelserviceorder
        with:
          cancelServiceOrder: rest.cancelServiceOrder
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/cancelserviceorder/{id}
      name: cancelserviceorder-id
      description: REST surface for cancelServiceOrder-id.
      operations:
      - method: GET
        name: retrievecancelserviceorder
        description: Retrieves a CancelServiceOrder by ID
        call: tmf641-service-ordering-cancelserviceorder.retrievecancelserviceorder
        with:
          id: rest.id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tmf641-service-ordering-cancelserviceorder-mcp
    port: 9090
    transport: http
    description: MCP adapter for API ServiceOrdering — cancelServiceOrder. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-find-cancelserviceorder-objects
      description: List or find CancelServiceOrder objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf641-service-ordering-cancelserviceorder.listcancelserviceorder
      with:
        fields: tools.fields
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-cancelserviceorder
      description: Creates a CancelServiceOrder
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tmf641-service-ordering-cancelserviceorder.createcancelserviceorder
      with:
        cancelServiceOrder: tools.cancelServiceOrder
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-cancelserviceorder-id
      description: Retrieves a CancelServiceOrder by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf641-service-ordering-cancelserviceorder.retrievecancelserviceorder
      with:
        id: tools.id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.