Generated by API Evangelist
Written by API Evangelist tooling for Clarivate's API. It is a proposal applied on top of the contract, not a document Clarivate publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Converis CUD Data Entities API
version: 1.0.0
extends: openapi/clarivate-data-entities-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/{version}/dataobject/dataentities'].put
update:
x-apievangelist-phrasing:
intent: Update existing Converis data entities
effect: write
questions:
- How do I modify records that already exist in Converis in bulk?
- Can I change several existing data entities like publications or projects in one request?
instructions:
- text: Update these existing data entities {entities} on API version {version}.
slots:
version: path.version
entities: requestBody.entities
- text: Apply changes to already-stored Converis records {entities} using version {version}.
slots:
version: path.version
entities: requestBody.entities
method: generated
generated: '2026-09-26'
- target: $.paths['/{version}/dataobject/dataentities'].post
update:
x-apievangelist-phrasing:
intent: Create new Converis data entities
effect: write
questions:
- How do I add new records such as publications to Converis programmatically?
- Can I create several brand-new data entities in a single call?
instructions:
- text: Create new data entities {entities} in Converis on API version {version}.
slots:
version: path.version
entities: requestBody.entities
- text: Add these new records {entities} to Converis using version {version}.
slots:
version: path.version
entities: requestBody.entities
method: generated
generated: '2026-09-26'
- target: $.paths['/{version}/dataobject/dataentities'].delete
update:
x-apievangelist-phrasing:
intent: Delete Converis data entities
effect: destructive
questions:
- How do I remove data entity records from Converis?
- Is there a bulk delete for Converis data objects?
instructions:
- text: Delete the specified data entities from Converis on API version {version}.
slots:
version: path.version
- text: Remove data entity records via the CUD API, version {version}.
slots:
version: path.version
method: generated
generated: '2026-09-26'
- target: $.paths['/{version}/dataobject/dataentities'].options
update:
x-apievangelist-phrasing:
intent: Describe supported data entity actions
effect: read
questions:
- Which actions and request structure does the Converis data entities endpoint support?
- What does a valid create or update payload for data entities look like?
instructions:
- text: Show the supported actions and request structure for data entities on version {version}.
slots:
version: path.version
- text: Describe the allowed operations for the data entities endpoint, API version {version}.
slots:
version: path.version
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.