Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Identity External IDs API

5 actions 5 updates phrasing extends openapi/cumulocity-external-ids-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 5

$.info

$.paths['/identity/externalIds/{type}/{externalId}'].get

$.paths['/identity/externalIds/{type}/{externalId}'].delete

$.paths['/identity/globalIds/{id}/externalIds'].get

$.paths['/identity/globalIds/{id}/externalIds'].post

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 Identity External IDs API
  version: 1.0.0
extends: openapi/cumulocity-external-ids-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: 4
- target: $.paths['/identity/externalIds/{type}/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find a device by its external ID
      effect: read
      questions:
      - How do I find a device using its serial number or IMEI?
      - Which managed object does an external ID point to?
      instructions:
      - text: Find the device with {type} external ID {externalId}.
        slots:
          type: path.type
          externalId: path.externalId
      - text: Look up external ID {externalId} of type {type}.
        slots:
          externalId: path.externalId
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/externalIds/{type}/{externalId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an external ID mapping
      effect: destructive
      questions:
      - How do I unlink a serial number from a device?
      - Can I delete an external ID without deleting the device?
      instructions:
      - text: Delete external ID {externalId} of type {type}.
        slots:
          externalId: path.externalId
          type: path.type
      - text: Unlink the {type} identifier {externalId} from its device.
        slots:
          type: path.type
          externalId: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/globalIds/{id}/externalIds'].get
  update:
    x-apievangelist-phrasing:
      intent: List all external IDs of a device
      effect: read
      questions:
      - What serial numbers and other identifiers are linked to one device?
      - How do I see every external ID for a managed object?
      instructions:
      - text: List the external IDs of managed object {id}.
        slots:
          id: path.id
      - text: Show all identifiers mapped to global ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/globalIds/{id}/externalIds'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an external ID to a device
      effect: write
      questions:
      - How do I register a device's serial number as an external ID?
      - Can I give a managed object more than one external identifier?
      instructions:
      - text: Link external ID {externalId} of type {type} to managed object {id}.
        slots:
          externalId: requestBody.externalId
          type: requestBody.type
          id: path.id
      - text: Add serial {externalId} as a {type} identifier for device {id}.
        slots:
          externalId: requestBody.externalId
          type: requestBody.type
          id: path.id
      method: generated
      generated: '2026-10-01'