# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: 'API Evangelist conversational phrasing for Converis Legacy Legacy API: get Info Object API'
  version: 1.0.0
extends: openapi/clarivate-legacy-api-get-info-object-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: 7
- target: $.paths['/public/infoobject/filterids'].get
  update:
    x-apievangelist-phrasing:
      intent: Filter public info objects to IDs
      effect: read
      questions:
      - How do I get only the IDs of public Converis objects matching a filter?
      - Can the legacy API return matching object IDs without the full records?
      instructions:
      - text: Return the IDs of info objects matching filter {content}.
        slots:
          content: query.content
      - text: Filter public objects by {content} and give me just their IDs.
        slots:
          content: query.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/infoobject/getfiltered'].put
  update:
    x-apievangelist-phrasing:
      intent: Get all filtered public info objects
      effect: read
      questions:
      - How do I retrieve every public info object that matches a filter in one call?
      - Can I get filtered Converis objects without specifying a start position?
      instructions:
      - text: Get all filtered info objects from the legacy API.
      - text: Return every public object that matches my filter, unpaged.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/infoobject/getfiltered/{start}'].put
  update:
    x-apievangelist-phrasing:
      intent: Get filtered info objects from an offset
      effect: read
      questions:
      - Can I skip the first results and fetch filtered info objects from a given position?
      - How do I resume a filtered info object listing at a start index?
      instructions:
      - text: Skip ahead and list filtered info objects from index {start} to the end.
        slots:
          start: path.start
      - text: Continue the filtered object listing from offset {start} onward.
        slots:
          start: path.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/infoobject/get/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a public info object by type and ID
      effect: read
      questions:
      - How do I read one public Converis object when I know its type and ID?
      - Can I get a public person or publication record by its ID?
      instructions:
      - text: Get the {type} info object with ID {id}.
        slots:
          type: path.type
          id: path.id
      - text: Show public {type} record {id}.
        slots:
          type: path.type
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/infoobject/getfiltered/{start}/{count}'].put
  update:
    x-apievangelist-phrasing:
      intent: Page through filtered info objects
      effect: read
      questions:
      - How do I page filtered info objects with both a start and a page size?
      - Can I cap how many filtered objects come back per request?
      instructions:
      - text: Get {count} filtered info objects starting at {start}.
        slots:
          start: path.start
          count: path.count
      - text: Return a page of {count} filtered records beginning at position {start}.
        slots:
          start: path.start
          count: path.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/infoobject/detail/{type}/{lang}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get localized detail of a public info object
      effect: read
      questions:
      - How do I get the detailed view of a public Converis object in a specific language?
      - Can I read a publication's detail representation in German instead of English?
      instructions:
      - text: Get details of {type} object {id} in language {lang}.
        slots:
          type: path.type
          lang: path.lang
          id: path.id
      - text: Show the {lang} detail representation of {type} record {id}.
        slots:
          type: path.type
          lang: path.lang
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/infoobject/filterlist/{lang}/{start}/{count}'].get
  update:
    x-apievangelist-phrasing:
      intent: List filtered info objects in a language
      effect: read
      questions:
      - How do I list filtered public objects with their values in a chosen language?
      - Can I page a localized list of filtered Converis records?
      instructions:
      - text: List {count} filtered objects in {lang} starting at {start}.
        slots:
          lang: path.lang
          start: path.start
          count: path.count
      - text: Give me {count} {lang} records matching {content} from position {start}.
        slots:
          lang: path.lang
          start: path.start
          count: path.count
          content: query.content
      method: generated
      generated: '2026-09-26'