generated: '2026-09-14' method: derived source: derived from components.schemas $ref graph and *Id reference fields across the 40 harvested OpenAPI documents in openapi/ summary: schemas: 535 relationships: 665 root_entities: - Account - User - Agent - Queue - Engagement - Subscription - Profile - Interaction - WorkflowSession tenancy: Nearly every path is rooted at /accounts/{accountId} — the Avaya account (tenant) is the top of the object graph on both platforms. entities: - entity: UpdateUserRequest fields: 78 description: 'Request body for updating an existing user. All fields are optional, however at least one must be included. **Merge Behavior:** Fields use different update strategies. Most scala' sources: - openapi/avaya-infinity-user-management-openapi.yml - entity: CreateUserRequest fields: 66 description: Request body for creating a new user sources: - openapi/avaya-infinity-user-management-openapi.yml - entity: Profile fields: 56 description: Unique ID of User Profile like Basic, Core, Power, Trial, etc. sources: - openapi/avaya-axp-admin-account-openapi.yml - openapi/avaya-axp-admin-user-openapi.yml - openapi/avaya-infinity-profile-management-openapi.yml - entity: UserListItem fields: 53 description: '' sources: - openapi/avaya-infinity-user-management-openapi.yml - entity: UserDetail fields: 53 description: Detailed user object returned by the single-user GET endpoint. Extends the list item with optional enriched data controlled by query parameters. sources: - openapi/avaya-infinity-user-management-openapi.yml - entity: QueueResponse fields: 52 description: Full queue object returned by create, get, and update operations. sources: - openapi/avaya-infinity-queue-management-openapi.yml - entity: QueueBase fields: 50 description: Base schema for queue configuration. sources: - openapi/avaya-infinity-queue-management-openapi.yml - entity: CreateProfileRequest fields: 37 description: Request body for creating a new profile with license-type-based defaults sources: - openapi/avaya-infinity-profile-management-openapi.yml - entity: UpdateProfileRequest fields: 37 description: Request body for updating an existing profile. All fields are optional - only provided fields will be updated. sources: - openapi/avaya-infinity-profile-management-openapi.yml - entity: AsyncMessage fields: 29 description: A conversation message sources: - openapi/avaya-axp-digital-custom-messaging-openapi.yml - openapi/avaya-infinity-messaging-openapi.yml - entity: Message fields: 27 description: A conversation message sources: - openapi/avaya-axp-digital-custom-chat-openapi.yml - openapi/avaya-axp-digital-notification-openapi.yml - openapi/avaya-axp-transcript-retrieval-openapi.yml - entity: ProfileListItem fields: 21 description: Profile item in list response sources: - openapi/avaya-infinity-profile-management-openapi.yml - entity: Account fields: 18 description: 'An Account represents the following * A customer that subscribes to an Avaya service. * An Avaya customer can manage the Account. These customers use a share of resources and featu' sources: - openapi/avaya-axp-admin-account-openapi.yml - entity: Transfer fields: 17 description: The Transfer details part of an engagement. sources: - openapi/avaya-axp-customer-journey-openapi.yml - entity: GroupUser fields: 17 description: Data about an individual user in a group. sources: - openapi/avaya-infinity-groups-management-openapi.yml - entity: User fields: 16 description: A User can be an Agent, Supervisor or an Administrator. sources: - openapi/avaya-axp-admin-user-openapi.yml - entity: SendAsyncMessage fields: 16 description: '' sources: - openapi/avaya-axp-digital-custom-messaging-openapi.yml - entity: AccountFeatureStatus fields: 15 description: Status of all features sources: - openapi/avaya-axp-admin-account-openapi.yml - entity: MessageHeaders fields: 15 description: The header of the message sources: - openapi/avaya-axp-digital-custom-chat-openapi.yml - openapi/avaya-axp-digital-custom-messaging-openapi.yml - openapi/avaya-axp-digital-notification-openapi.yml - entity: MessageDraft fields: 15 description: Message Draft sources: - openapi/avaya-axp-draft-retrieval-openapi.yml - openapi/avaya-axp-draft-save-openapi.yml - entity: AccountFeatures fields: 14 description: Features associated to the account sources: - openapi/avaya-axp-admin-account-openapi.yml - entity: CommunicationManagerResponse fields: 14 description: Represents the model used to get details of a single Communication Manager. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: ParticipantResponse fields: 14 description: Any External, Agent or Treatment participant as returned by a query for a customer journey sources: - openapi/avaya-axp-customer-journey-openapi.yml - entity: CommunicationManager fields: 13 description: Represents the model used to create or update a Communication Manager element. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: EngagementCreated fields: 13 description: Response payload indicating that engagement has been created sources: - openapi/avaya-axp-digital-custom-chat-openapi.yml - openapi/avaya-axp-digital-notification-openapi.yml - entity: TypingEventData fields: 13 description: Typing event sources: - openapi/avaya-axp-digital-notification-openapi.yml - entity: GroupData fields: 13 description: Returned data about a group. sources: - openapi/avaya-infinity-groups-management-openapi.yml - entity: UserFeatureStatus fields: 12 description: Status of all features sources: - openapi/avaya-axp-admin-user-openapi.yml - entity: SipTrunk fields: 12 description: SIP Trunks Element Model sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: ParticipantEventData fields: 12 description: Notification for participant added or removed from the dialog of the engagement sources: - openapi/avaya-axp-digital-notification-openapi.yml - entity: MetricsResponse fields: 12 description: Real-time metrics snapshot for the requested queue and channel. sources: - openapi/avaya-infinity-queue-metrics-openapi.yml - entity: Address fields: 11 description: A real address and phone number for an Account. sources: - openapi/avaya-axp-admin-account-openapi.yml - openapi/avaya-axp-admin-user-openapi.yml - entity: CloudSwitchVoiceUserFeature fields: 11 description: This model is used to populate voice feature data on UI while editing user sources: - openapi/avaya-axp-admin-user-openapi.yml - entity: HybridCloudGatewayResponse fields: 11 description: Represents the model used to get details of a single Avaya Hybrid Cloud Gateway. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: SystemManagerResponse fields: 11 description: Represents the model used to get details of a single System Manager. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: ACOElement fields: 11 description: 'Avaya Cloud Office Element Details ' sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: Session fields: 11 description: Client session of a customer sources: - openapi/avaya-axp-digital-custom-chat-openapi.yml - entity: SendMessage fields: 11 description: '' sources: - openapi/avaya-axp-digital-custom-chat-openapi.yml - entity: CrmConfiguration fields: 11 description: Full CRM configuration object. sources: - openapi/avaya-infinity-profile-management-openapi.yml - entity: Queue fields: 10 description: A Queue is used to identify a pool of contact center agents for which Customer engagements can be matched and routed. sources: - openapi/avaya-axp-admin-match-openapi.yml - openapi/avaya-axp-customer-journey-openapi.yml - entity: UserFeatures fields: 10 description: Features enabled in user sources: - openapi/avaya-axp-admin-user-openapi.yml - entity: ProfileFeatures fields: 10 description: Features present in profile sources: - openapi/avaya-axp-admin-user-openapi.yml - entity: PasswordPolicy fields: 10 description: This model represent the password policy rules sources: - openapi/avaya-axp-admin-user-openapi.yml - entity: VoicePlan fields: 10 description: Represents ranges of entities for configured Communication Manager. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: HybridCloudGateway fields: 10 description: Avaya Hybrid Cloud Gateway acts as a gateway to Avaya Aura clients and applications utilizing WebRTC signaling and media. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: SystemManager fields: 10 description: System Manager is a central management system that delivers a set of shared management services and provides a common console for the Avaya Aura applications and systems. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: MSTeamsElement fields: 10 description: MS Teams Element Model sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: MSTeamsSIPTrunkResponse fields: 10 description: Microsoft Teams SIP Trunk Element Model sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: ACOSIPTrunkResponse fields: 10 description: Avaya Cloud Office(ACO) SIP Trunk Element Response Model sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: PhoneNumber fields: 10 description: PhoneNumber of an Account. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: BulkUpdateOutboundRoutingRule fields: 10 description: Outbound Routing Rule Model. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: UpdateOutboundRoutingRule fields: 10 description: Outbound Routing Rule Model. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: OutboundRoutingRule fields: 10 description: Outbound Routing Rule Model. sources: - openapi/avaya-axp-admin-voice-openapi.yml - entity: TranscriptMessage fields: 10 description: 'A transcript message returned by the GET endpoint. Contains a sanitized subset of channel message fields — internal and sensitive fields are excluded. Note that the `message` fiel' sources: - openapi/avaya-infinity-transcription-interactions-openapi.yml - openapi/avaya-infinity-transcripts-openapi.yml - entity: Problem fields: 9 description: Problem Detail as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs