Oracle Siebel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Oracle Siebel REST Accounts API

9 actions 9 updates phrasing extends openapi/oracle-siebel-accounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Oracle Siebel's API. It is a proposal applied on top of the contract, not a document Oracle Siebel publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/data/Account/Account'].get
$.paths['/data/Account/Account'].post
$.paths['/data/Account/Account/{AccountId}'].get
$.paths['/data/Account/Account/{AccountId}'].put
$.paths['/data/Account/Account/{AccountId}'].delete
$.paths['/data/Account/Account/{AccountId}/Contact'].get
$.paths['/data/Account/Account/{AccountId}/Contact'].put
$.paths['/data/Account/Account/{AccountId}/Opportunity'].get

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 Oracle Siebel REST Accounts API
  version: 1.0.0
extends: openapi/oracle-siebel-accounts-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: 8
- target: $.paths['/data/Account/Account'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts
      effect: read
      questions:
      - How can I pull a list of all customer accounts out of Siebel CRM?
      - Can I filter the account list with a search spec, like only accounts in a certain location?
      - Is there a way to page through thousands of accounts a chunk at a time?
      instructions:
      - text: List all accounts.
      - text: List accounts matching {searchspec}, returning only {fields}.
        slots:
          searchspec: query.searchspec
          fields: query.fields
      - text: Show {page_size} accounts starting at row {start_row}.
        slots:
          page_size: query.PageSize
          start_row: query.StartRowNum
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new account
      effect: write
      questions:
      - How do I add a brand-new customer account to the CRM?
      - What fields do I need to supply when inserting a new account record?
      - Can I set the industry and account type when I first create an account?
      instructions:
      - text: Create a new account named {name}.
        slots:
          name: requestBody.Name
      - text: Add a new account {name} in {location} with main phone {phone}.
        slots:
          name: requestBody.Name
          location: requestBody.Location
          phone: requestBody.Main Phone Number
      - text: Insert account {name} as industry {industry}, type {account_type}.
        slots:
          name: requestBody.Name
          industry: requestBody.Industry
          account_type: requestBody.Account Type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one account by its ID
      effect: read
      questions:
      - How do I look up a single account when I already have its row ID?
      - Can I fetch one account along with links to its contacts and opportunities?
      instructions:
      - text: Get account {account_id}.
        slots:
          account_id: path.AccountId
      - text: Show only the {fields} fields of account {account_id}.
        slots:
          fields: query.fields
          account_id: path.AccountId
      - text: Fetch account {account_id} with child links to {child_links}.
        slots:
          account_id: path.AccountId
          child_links: query.ChildLinks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or insert an account by ID
      effect: write
      questions:
      - How do I change the status of an existing account?
      - What happens if I send an update for an account ID that doesn't exist yet?
      - Can I update an account's email address and home page in one call?
      instructions:
      - text: Set account {account_id} status to {status}, keeping name {name}.
        slots:
          account_id: path.AccountId
          status: requestBody.Account Status
          name: requestBody.Name
      - text: Upsert account {account_id} named {name} with email {email}.
        slots:
          account_id: path.AccountId
          name: requestBody.Name
          email: requestBody.Email Address
      - text: Change the location of account {account_id} ({name}) to {location}.
        slots:
          account_id: path.AccountId
          name: requestBody.Name
          location: requestBody.Location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account
      effect: destructive
      questions:
      - How do I permanently remove an account from the Siebel database?
      - Is deleting an account record reversible?
      instructions:
      - text: Delete account {account_id}.
        slots:
          account_id: path.AccountId
      - text: Permanently remove the account with row ID {account_id}.
        slots:
          account_id: path.AccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}/Contact'].get
  update:
    x-apievangelist-phrasing:
      intent: List the contacts under an account
      effect: read
      questions:
      - Who are the people linked to a particular customer account?
      - Can I get the email and job title of every contact at one account?
      - Is it possible to search only within one account's contacts?
      instructions:
      - text: List the contacts at account {account_id}.
        slots:
          account_id: path.AccountId
      - text: Find contacts under account {account_id} matching {searchspec}.
        slots:
          account_id: path.AccountId
          searchspec: query.searchspec
      - text: Show {page_size} contacts from account {account_id}.
        slots:
          page_size: query.PageSize
          account_id: path.AccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}/Contact'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update a contact under an account
      effect: write
      questions:
      - How do I attach a new person to an existing customer account?
      - Can I add several contacts to one account in a single batch?
      - What's required to insert a contact as a child of an account?
      instructions:
      - text: Add {first_name} {last_name} as a contact on account {account_id}.
        slots:
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          account_id: path.AccountId
      - text: Add {first_name} {last_name}, {job_title}, to account {account_id} with email {email}.
        slots:
          first_name: requestBody.First Name
          last_name: requestBody.Last Name
          job_title: requestBody.Job Title
          account_id: path.AccountId
          email: requestBody.Email Address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/Account/Account/{AccountId}/Opportunity'].get
  update:
    x-apievangelist-phrasing:
      intent: List the opportunities under an account
      effect: read
      questions:
      - What deals are open for a specific customer account?
      - Can I see the sales stage and close date of each opportunity tied to one account?
      - Is there a way to filter just one account's opportunities by search spec?
      instructions:
      - text: List the opportunities for account {account_id}.
        slots:
          account_id: path.AccountId
      - text: Show opportunities on account {account_id} matching {searchspec}.
        slots:
          account_id: path.AccountId
          searchspec: query.searchspec
      method: generated
      generated: '2026-09-26'