Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Digital Twin Manager Asset Instances API

6 actions 6 updates phrasing extends openapi/cumulocity-asset-instances-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['/service/dtm/asset-instances'].get
$.paths['/service/dtm/asset-instances'].post
$.paths['/service/dtm/asset-instances/{id}'].get
$.paths['/service/dtm/asset-instances/{id}'].put
$.paths['/service/dtm/asset-instances/{id}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Digital Twin Manager Asset Instances API
  version: 1.0.0
extends: openapi/cumulocity-asset-instances-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['/service/dtm/asset-instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List digital twin asset instances
      effect: read
      questions:
      - Which asset instances exist in my digital twin model?
      - Can I list only the assets built from one asset model?
      instructions:
      - text: List all asset instances.
      - text: Show asset instances created from model {model}.
        slots:
          model: query.model
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an asset instance from a model
      effect: write
      questions:
      - How do I create a new asset from an asset model in the digital twin manager?
      - Can I link a new asset instance to an existing managed object and parent?
      instructions:
      - text: Create an asset instance named {name} from model {modelId}.
        slots:
          name: requestBody.name
          modelId: requestBody.modelId
      - text: Add asset {name} under parent {parent} linked to managed object {managedObjectId}.
        slots:
          name: requestBody.name
          parent: requestBody.parent
          managedObjectId: requestBody.managedObjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-instances/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one asset instance
      effect: read
      questions:
      - How do I see the properties and children of a single asset instance?
      - What model is a given asset instance based on?
      instructions:
      - text: Show me asset instance {id}.
        slots:
          id: path.id
      - text: Get the properties and child assets of asset instance {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-instances/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an asset instance
      effect: write
      questions:
      - Can I rename an asset instance or move it under a different parent?
      - How do I change the property values on an existing asset?
      instructions:
      - text: Rename asset instance {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move asset instance {id} under parent {parent}.
        slots:
          id: path.id
          parent: requestBody.parent
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-instances/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an asset instance
      effect: destructive
      questions:
      - How do I remove an asset instance from the digital twin?
      - Can I delete a single asset without deleting its model?
      instructions:
      - text: Delete asset instance {id}.
        slots:
          id: path.id
      - text: Remove the asset instance with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'