Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Device Control Bulk Operations API

6 actions 6 updates phrasing extends openapi/cumulocity-bulk-operations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cumulocity's API. It is a proposal applied on top of the contract, not a document Cumulocity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/devicecontrol/bulkoperations'].get

$.paths['/devicecontrol/bulkoperations'].post

$.paths['/devicecontrol/bulkoperations/{id}'].get

$.paths['/devicecontrol/bulkoperations/{id}'].put

$.paths['/devicecontrol/bulkoperations/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Device Control Bulk Operations API
  version: 1.0.0
extends: openapi/cumulocity-bulk-operations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/devicecontrol/bulkoperations'].get
  update:
    x-apievangelist-phrasing:
      intent: List bulk device operations
      effect: read
      questions:
      - Which bulk operations have been scheduled across device groups?
      - What is the progress of my running bulk operations?
      instructions:
      - text: List all bulk operations.
      - text: Show every bulk operation and its progress.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/bulkoperations'].post
  update:
    x-apievangelist-phrasing:
      intent: Send one operation to a whole device group
      effect: write
      questions:
      - How do I send the same command to every device in a group?
      - Can I ramp up a bulk operation so devices receive it gradually?
      instructions:
      - text: Create a bulk operation for group {groupId} using prototype {operationPrototype}.
        slots:
          groupId: requestBody.groupId
          operationPrototype: requestBody.operationPrototype
      - text: Start a bulk operation on group {groupId} at {startDate} with a {creationRamp}-second ramp.
        slots:
          groupId: requestBody.groupId
          startDate: requestBody.startDate
          creationRamp: requestBody.creationRamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/bulkoperations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one bulk operation
      effect: read
      questions:
      - How do I check the progress of a single bulk operation?
      - Which device group is a given bulk operation targeting?
      instructions:
      - text: Show me bulk operation {id}.
        slots:
          id: path.id
      - text: Get the status and progress of bulk operation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/bulkoperations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Reschedule or change a bulk operation
      effect: write
      questions:
      - Can I change the start date of a bulk operation that hasn't run yet?
      - How do I adjust the creation ramp on a scheduled bulk operation?
      instructions:
      - text: Move the start of bulk operation {id} to {startDate}.
        slots:
          id: path.id
          startDate: requestBody.startDate
      - text: Set the creation ramp of bulk operation {id} to {creationRamp} seconds.
        slots:
          id: path.id
          creationRamp: requestBody.creationRamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/bulkoperations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bulk operation
      effect: destructive
      questions:
      - How do I cancel and remove a scheduled bulk operation?
      - Can I delete a bulk operation I created by mistake?
      instructions:
      - text: Delete bulk operation {id}.
        slots:
          id: path.id
      - text: Remove the bulk operation with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'