Skip to content

docs(api): add use-case examples for cmdb.external identifier endpoints - #1360

Merged
MichaelOv merged 1 commit into
mainfrom
docs/api-external-use-cases
Jul 31, 2026
Merged

docs(api): add use-case examples for cmdb.external identifier endpoints#1360
MichaelOv merged 1 commit into
mainfrom
docs/api-external-use-cases

Conversation

@MichaelOv

@MichaelOv MichaelOv commented Jul 31, 2026

Copy link
Copy Markdown
Member

Add use-case examples for the cmdb.external identifier endpoints (EN + DE)

The cmdb.external page documented push and pull, but had no example for cmdb.external.link.v2 and no use-case-driven walkthrough. This adds a Use cases section that follows one consistent flow: link an existing object, add data to it, create-and-fill in one call, and read it back.

Added

  • Use cases / Anwendungsfälle section on the cmdb.external page (EN + DE) with collapsible examples for cmdb.external.link.v2, cmdb.external.push.v2 (add data to a connected object, and create-and-fill), and cmdb.external.pull.v2
  • Note that objectId is a number without quotes and the JSON-RPC id belongs at the top level of the request

Changed

  • Translated leftover German comments (object Ebene, Category Ebene, Und ganz wichtig:) in the English push example

Conditions

By sending this pull request I have read and accept the following conditions:

@MichaelOv
MichaelOv requested a review from a team as a code owner July 31, 2026 06:33
@MichaelOv MichaelOv self-assigned this Jul 31, 2026
Add a Use cases section to the cmdb.external page (EN + DE) with collapsible
examples for link.v2 (connect an existing object), push.v2 (add data to a
connected object, and create-and-fill in one call) and pull.v2 (look up what is
connected), including a parameter table for link.v2.

Also on the same page:
- translate the English examples' placeholder from 'datenquelle' to 'datasource'
- add the required 'data' parameter to the push parameter table
- correct the pull parameter table: 'extId' is optional, not required
- translate leftover German comments in the English push example
- remove the now-unused 'DQ' abbreviation
@MichaelOv
MichaelOv force-pushed the docs/api-external-use-cases branch from bf28249 to b0d3f8f Compare July 31, 2026 07:32
@MichaelOv
MichaelOv requested review from ljuergenliemke and removed request for a team July 31, 2026 07:34
@MichaelOv
MichaelOv merged commit 2aef443 into main Jul 31, 2026
7 checks passed
@MichaelOv
MichaelOv deleted the docs/api-external-use-cases branch July 31, 2026 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants