Oracle Hospitality · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for OPERA Cloud Activity Management API
26 actions
26 updates
phrasing
extends
openapi/oracle-hospitality-activitymanagement-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Oracle Hospitality's API. It is a proposal applied on top of the contract, not a document Oracle Hospitality publishes.
What the actions change
x-apievangelist-phrasing
Targets 26 · first 16 shown; the file carries all of them
$.info
$.paths['/activityResults'].get
$.paths['/activityResults'].post
$.paths['/activityResults/{activityResultCode}'].put
$.paths['/activityResults/{activityResultCode}'].delete
$.paths['/autoTraceCodes'].get
$.paths['/autoTraceCodes'].post
$.paths['/autoTraceCodes/{autoTraceCode}'].put
$.paths['/autoTraceCodes/{autoTraceCode}'].delete
$.paths['/autoTraceDefinitions/{autoTraceDefinitionId}'].delete
$.paths['/autoTraceOwnerAssignments/{autoTraceOwnerAssignmentID}'].delete
$.paths['/copyActivityTypes/sourceHotel/{hotelId}'].post
$.paths['/copyAutoTraceDefinitions/sourceHotel/{hotelId}'].post
$.paths['/hotels/{hotelId}/activityTypes'].get
$.paths['/hotels/{hotelId}/activityTypes'].post
$.paths['/hotels/{hotelId}/activityTypes/{activityTypeCode}'].put
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 OPERA Cloud Activity Management API
version: 1.0.0
extends: openapi/oracle-hospitality-activitymanagement-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: 25
- target: $.paths['/activityResults'].get
update:
x-apievangelist-phrasing:
intent: List configured activity result codes
effect: read
questions:
- Which activity result codes, like SUCCESS or CALLAGAIN, are set up in OPERA Cloud?
- Can I include inactive activity result codes when listing them?
instructions:
- text: List all activity result codes.
- text: Find activity result codes matching {wildcard}.
slots:
wildcard: query.wildCard
method: generated
generated: '2026-09-26'
- target: $.paths['/activityResults'].post
update:
x-apievangelist-phrasing:
intent: Create an activity result code
effect: write
questions:
- How do I add a new result code that sales staff pick when completing an activity?
- Can I create an activity result code such as END or CALLAGAIN?
instructions:
- text: Create activity result code {result}.
slots:
result: requestBody.activityResultsConfiguration
- text: Add a new activity outcome code for completed sales calls.
method: generated
generated: '2026-09-26'
- target: $.paths['/activityResults/{activityResultCode}'].put
update:
x-apievangelist-phrasing:
intent: Update an activity result code
effect: write
questions:
- How do I change the description of an existing activity result code?
- Can I edit an activity result code that is already configured?
instructions:
- text: Update activity result code {code}.
slots:
code: path.activityResultCode
- text: Change activity result code {code} to {config}.
slots:
code: path.activityResultCode
config: requestBody.activityResultsConfiguration
method: generated
generated: '2026-09-26'
- target: $.paths['/activityResults/{activityResultCode}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an activity result code
effect: destructive
questions:
- How do I remove an activity result code from OPERA Cloud?
- Can I delete an activity outcome code we no longer use?
instructions:
- text: Delete activity result code {code}.
slots:
code: path.activityResultCode
- text: Remove the activity outcome code {code} from configuration.
slots:
code: path.activityResultCode
method: generated
generated: '2026-09-26'
- target: $.paths['/autoTraceCodes'].get
update:
x-apievangelist-phrasing:
intent: List auto trace codes
effect: read
questions:
- What auto trace codes are configured for our property?
- Can I filter auto trace codes by their auto trace group?
instructions:
- text: List the auto trace codes.
- text: Show auto trace codes in group {group}.
slots:
group: query.autoTraceGroups
method: generated
generated: '2026-09-26'
- target: $.paths['/autoTraceCodes'].post
update:
x-apievangelist-phrasing:
intent: Create an auto trace code
effect: write
questions:
- How do I add a new auto trace code?
- Can I set up an auto trace code before building auto trace definitions?
instructions:
- text: Create auto trace code {code_config}.
slots:
code_config: requestBody.autoTraceCodesConfig
- text: Add a new auto trace code to the configuration.
method: generated
generated: '2026-09-26'
- target: $.paths['/autoTraceCodes/{autoTraceCode}'].put
update:
x-apievangelist-phrasing:
intent: Update an auto trace code
effect: write
questions:
- How do I edit an auto trace code that already exists?
- Can I change the description of an auto trace code?
instructions:
- text: Update auto trace code {code}.
slots:
code: path.autoTraceCode
- text: Change auto trace code {code} to {code_config}.
slots:
code: path.autoTraceCode
code_config: requestBody.autoTraceCodesConfig
method: generated
generated: '2026-09-26'
- target: $.paths['/autoTraceCodes/{autoTraceCode}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an auto trace code
effect: destructive
questions:
- How do I remove an auto trace code we no longer need?
- Can I delete a single auto trace code by its code?
instructions:
- text: Delete auto trace code {code}.
slots:
code: path.autoTraceCode
- text: Remove the auto trace code {code} from configuration.
slots:
code: path.autoTraceCode
method: generated
generated: '2026-09-26'
- target: $.paths['/autoTraceDefinitions/{autoTraceDefinitionId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an auto trace definition
effect: destructive
questions:
- How do I delete an auto trace definition that creates activities automatically?
- Can I remove an auto trace definition by its ID?
instructions:
- text: Delete auto trace definition {definition}.
slots:
definition: path.autoTraceDefinitionId
- text: Remove auto trace definition {definition} so it stops generating activities.
slots:
definition: path.autoTraceDefinitionId
method: generated
generated: '2026-09-26'
- target: $.paths['/autoTraceOwnerAssignments/{autoTraceOwnerAssignmentID}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an auto trace owner assignment
effect: destructive
questions:
- How do I remove the owner assigned to an auto trace?
- Can I delete a trace owner mapping configured for a property?
instructions:
- text: Delete auto trace owner assignment {assignment}.
slots:
assignment: path.autoTraceOwnerAssignmentID
- text: Remove trace owner mapping {assignment}.
slots:
assignment: path.autoTraceOwnerAssignmentID
method: generated
generated: '2026-09-26'
- target: $.paths['/copyActivityTypes/sourceHotel/{hotelId}'].post
update:
x-apievangelist-phrasing:
intent: Copy activity types to another property
effect: write
questions:
- Can I copy activity type codes from one hotel to another instead of recreating them?
- How do I roll out our activity types to a new property?
instructions:
- text: Copy activity types from source hotel {hotel} to the target properties {criteria}.
slots:
hotel: path.hotelId
criteria: requestBody.criteria
- text: Replicate the activity type codes from hotel {hotel} to our other property.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/copyAutoTraceDefinitions/sourceHotel/{hotelId}'].post
update:
x-apievangelist-phrasing:
intent: Copy auto trace definitions to another property
effect: write
questions:
- Can I copy an auto trace definition from one hotel to another?
- How do I reuse our auto trace setup at a second property?
instructions:
- text: Copy auto trace definitions from source hotel {hotel} using {criteria}.
slots:
hotel: path.hotelId
criteria: requestBody.criteria
- text: Replicate hotel {hotel}'s auto trace definitions to another property.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/activityTypes'].get
update:
x-apievangelist-phrasing:
intent: List activity types for a hotel
effect: read
questions:
- Which activity types, like MEETING or LUNCH, are configured at a hotel?
- Can I include inactive activity types when listing them?
instructions:
- text: List activity types at hotel {hotel}.
slots:
hotel: path.hotelId
- text: Find activity type {type} at hotel {hotel}.
slots:
type: query.activityType
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/activityTypes'].post
update:
x-apievangelist-phrasing:
intent: Create an activity type
effect: write
questions:
- How do I add a new activity type such as EXTMEETING for a hotel?
- Can I define custom activity types for sales and catering staff?
instructions:
- text: Create activity type {activity_type} at hotel {hotel}.
slots:
activity_type: requestBody.activityConfigTypes
hotel: path.hotelId
- text: Add a new activity type for site visits at hotel {hotel}.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/activityTypes/{activityTypeCode}'].put
update:
x-apievangelist-phrasing:
intent: Update an activity type
effect: write
questions:
- How do I change the details of an existing activity type?
- Can I rename an activity type's description at a property?
instructions:
- text: Update activity type {type} at hotel {hotel}.
slots:
type: path.activityTypeCode
hotel: path.hotelId
- text: Change activity type {type} at hotel {hotel} to {config}.
slots:
type: path.activityTypeCode
hotel: path.hotelId
config: requestBody.activityConfigTypes
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/activityTypes/{activityTypeCode}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an activity type
effect: destructive
questions:
- How do I remove an activity type from a hotel's configuration?
- Can I delete an activity type code we stopped using?
instructions:
- text: Delete activity type {type} at hotel {hotel}.
slots:
type: path.activityTypeCode
hotel: path.hotelId
- text: Remove activity type code {type} from hotel {hotel}.
slots:
type: path.activityTypeCode
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTraceDefinitions'].get
update:
x-apievangelist-phrasing:
intent: List auto trace definitions for a hotel
effect: read
questions:
- What auto trace definitions are set up for a property?
- Can I list auto trace definitions by code or group, including inactive ones?
instructions:
- text: List auto trace definitions at hotel {hotel}.
slots:
hotel: path.hotelId
- text: Show auto trace definitions in group {group} at hotel {hotel}.
slots:
group: query.autoTraceGroups
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTraceDefinitions'].post
update:
x-apievangelist-phrasing:
intent: Create an auto trace definition
effect: write
questions:
- How do I create a new auto trace definition for a property?
- Can I define the conditions under which activities are traced automatically?
instructions:
- text: Create auto trace definition {definition} at hotel {hotel}.
slots:
definition: requestBody.autoTraceDefinitions
hotel: path.hotelId
- text: Add a brand-new auto trace definition at hotel {hotel}.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTraceDefinitions/{autoTraceDefinitionId}'].put
update:
x-apievangelist-phrasing:
intent: Update an auto trace definition
effect: write
questions:
- How do I change an existing auto trace definition by its ID?
- Can I edit one specific auto trace definition at a property?
instructions:
- text: Update auto trace definition {definition} at hotel {hotel}.
slots:
definition: path.autoTraceDefinitionId
hotel: path.hotelId
- text: Change auto trace definition {definition} at hotel {hotel} to {details}.
slots:
definition: path.autoTraceDefinitionId
hotel: path.hotelId
details: requestBody.autoTraceDefinitions
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTraceOwnerAssignments'].get
update:
x-apievangelist-phrasing:
intent: List auto trace owner assignments
effect: read
questions:
- Who is assigned as owner for each auto trace at a hotel?
- Can I filter auto trace owner mappings by trace owner code?
instructions:
- text: List auto trace owner assignments at hotel {hotel}.
slots:
hotel: path.hotelId
- text: Show trace owner mappings for owner {owner} at hotel {hotel}.
slots:
owner: query.traceOwnerCodes
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTraceOwnerAssignments'].post
update:
x-apievangelist-phrasing:
intent: Create an auto trace owner assignment
effect: write
questions:
- How do I assign an owner so auto-created trace activities go to the right person?
- What must be configured before I can create an auto trace owner assignment?
instructions:
- text: Create auto trace owner assignment {assignment} at hotel {hotel}.
slots:
assignment: requestBody.autoTraceOwnerAssignments
hotel: path.hotelId
- text: Assign a new trace owner for automatic activities at hotel {hotel}.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/hotels/{hotelId}/autoTraceOwnerAssignments/{autoTraceOwnerAssignmentID}'].put
update:
x-apievangelist-phrasing:
intent: Update an auto trace owner assignment
effect: write
questions:
- How do I change who owns an existing auto trace assignment?
- Can I edit one trace owner assignment by its ID?
instructions:
- text: Update auto trace owner assignment {assignment} at hotel {hotel}.
slots:
assignment: path.autoTraceOwnerAssignmentID
hotel: path.hotelId
- text: Reassign trace owner assignment {assignment} at hotel {hotel} to {details}.
slots:
assignment: path.autoTraceOwnerAssignmentID
hotel: path.hotelId
details: requestBody.autoTraceOwnerAssignments
method: generated
generated: '2026-09-26'
- target: $.paths['/services/activityManagement/status'].get
update:
x-apievangelist-phrasing:
intent: Check the activity management service status
effect: read
questions:
- Is the OPERA Cloud activity management service responding?
- How do I health-check the activity configuration service?
instructions:
- text: Ping the activity management service.
- text: Check activity management service availability for hotel {hotel}.
slots:
hotel: header.x-hotelid
method: generated
generated: '2026-09-26'
- target: $.paths['/upsert/hotels/{hotelId}/autoTraceDefinitions'].put
update:
x-apievangelist-phrasing:
intent: Create or update auto trace definitions
effect: write
questions:
- Can I create or update auto trace definitions in one call without knowing if they exist?
- Is there an upsert for a hotel's auto trace definitions?
instructions:
- text: Upsert auto trace definitions {definitions} at hotel {hotel}.
slots:
definitions: requestBody.autoTraceDefinitions
hotel: path.hotelId
- text: Create or change the auto trace definitions at hotel {hotel} in one go.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'
- target: $.paths['/upsert/hotels/{hotelId}/autoTraceOwnerAssignments'].put
update:
x-apievangelist-phrasing:
intent: Create or update auto trace owner assignments
effect: write
questions:
- Can I upsert trace owner assignments so new ones are created and existing ones changed?
- Is there a single call to sync a hotel's auto trace owner mappings?
instructions:
- text: Upsert trace owner assignments {assignments} at hotel {hotel}.
slots:
assignments: requestBody.autoTraceOwnerAssignments
hotel: path.hotelId
- text: Create or change the auto trace owner mappings at hotel {hotel} in one call.
slots:
hotel: path.hotelId
method: generated
generated: '2026-09-26'