Oracle Live Experience REST APIs

Resources

path methods description
  • /v1/applications/{tenant}
  • POST
Live Experience REST APIs. URI: /v1/*
  • /v1/audit/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/auth/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/dp/tenant
  • POST
Live Experience REST APIs. URI: /v1/*
  • /v1/dp/tenant/{tenant}
  • DELETE PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}
  • GET POST
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}/reorder
  • PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}/{scenarioName}
  • DELETE GET PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagement-scenarios/{tenant}/{scenarioName}/enable/{enable}
  • PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/engagements/count/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/engagements/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/engagements/{tenant}/{id}
  • DELETE
Live Experience REST APIs. URI: /v1/*
  • /v1/integration/{tenant}/sc
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/meetings/{tenant}
  • POST
Live Experience Meetings REST endpoint.
  • /v1/meetings/{tenant}/{code}
  • GET
Live Experience Meetings REST endpoint.
  • /v1/metrics/{tenant}
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/saml/{tenant}/idp
  • POST
Live Experience REST APIs. URI: /v1/*
  • /v1/saml/{tenant}/idp/{entity}
  • PUT
Live Experience REST APIs. URI: /v1/*
  • /v1/saml/{tenant}/sp
  • GET
Live Experience REST APIs. URI: /v1/*
  • /v1/users/{tenant}
  • GET POST
Live Experience REST APIs. URI: /v1/*
  • /v1/users/{tenant}/{email}
  • DELETE GET PUT
Live Experience REST APIs. URI: /v1/*

Data Types

JSON

type description
AccessTokenResponseV1 Model class for access token response.
ApiResponseV1 Model class for a generic response from the LX REST API.
AppRecordingV1 Model class for recording.
ApplicationFinalResponseV1 model class to send clientId and clientSecret.
ApplicationRecodringV1 model class to update tenant SI application.
ApplicationResponseV1 Model class for the response.
ApplicationV1 Model class for creating tenant application.
AuditRecordV1
BaseModel
BehavioursV1 Model class for engagement scenario behaviours.
ConfigurationV1 Model class for engagement scenario message.
ContextMetricsV1 Model class for Context Metric.
ECConfigV1 Model class for Engagement Cloud integration configuration.
Enable Model class for recording.
EngagementListV1 Model class for Engagements List.
EngagementScenarioConditionV1 Model calss for engagement scenario condition.
EngagementScenarioConfigurationV1 Model class for engagement scenario configuation.
EngagementScenarioListV1 Model class for EngagementScenario list.
EngagementScenarioRuleV1 Model class for engagement scenario rule.
EngagementScenarioV1 Model class for EngagementScenario.
EngagementUserV1 Model class for engagement user.
EngagementV1 Model class for engagement.
Entitlement Model sub class for entitlement.
InternalSku Valid Live Experience internal sku names for mapping feature sets.
MediaOption Enum of Media Option.
MeetingV1 Model class for meeting.
MessageV1 Model class for engagement scenario message.
MetricsListV1 Model class for Metrics List.
MetricsV1 Model class for report metrics.
Operation Operation enum.
PerUserMetricsV1 A user (associate) uri and associated metrics.
QualityMetricsV1 Model class for Quality Metric.
RecordingV1 Model class for recording data contained within an engagement.
RuleType enum RuleType.
SIContextV1 Model class for service instance context required for tenant provisioning.
SIParametersV1 Model class for service instance parameters required to provision a tenant.
SIPropertiesV1 Model class for properties of service instance provisioned tenant.
SIServiceV1 Model class for retrieving provisioned service instance.
SSOConfigV1 Model class for SSO configuration.
SeatType Valid Live Experience seat license types.
ServiceComponentId Recognized service component ids (B-Part numbers).
ServiceInstanceV1 Model class for service instance provisioning.
ServiceState Possible service states.
State Possible status states.
StatusResponseV1 Model class for Status Response.
SubTenantLimitsV1 Model class for the Limits object (used inside subTenantConfig).
SubTenantV1 Model class for sub-tenant.
TASAppId TAS app id model.
TASProperty TAS property model.
TASProvisionableResource TAS Provisionable resource model.
TASResource TAS resource model.
TASServiceInstance Tas Service Instance model.
UserListV1 Model class for Users list.
UserV1 Model class for user.

XML

Default Namespace
type description
accessTokenResponseV1 Model class for access token response.
apiResponseV1 Model class for a generic response from the LX REST API.
applicationFinalResponseV1 model class to send clientId and clientSecret.
applicationRecodringV1 model class to update tenant SI application.
enable Model class for recording.
applicationResponseV1 Model class for the response.
applicationV1 Model class for creating tenant application.
appRecordingV1 Model class for recording.
contextMetrics Model class for Context Metric.
ECConfigV1 Model class for Engagement Cloud integration configuration.
engagementListV1 Model class for Engagements List.
engagementScenarioConfigurationV1 Model class for engagement scenario configuation.
behavioursV1 Model class for engagement scenario behaviours.
configurationV1 Model class for engagement scenario message.
mediaOption Enum of Media Option.
messageV1 Model class for engagement scenario message.
engagementScenarioListV1 Model class for EngagementScenario list.
engagementScenarioRuleV1 Model class for engagement scenario rule.
engagementScenarioConditionV1 Model calss for engagement scenario condition.
operation Operation enum.
ruleType enum RuleType.
engagementScenarioV1 Model class for EngagementScenario.
engagementUserV1 Model class for engagement user.
engagementV1 Model class for engagement.
meetingV1 Model class for meeting.
metricsListV1 Model class for Metrics List.
metricsV1 Model class for report metrics.
users A user (associate) uri and associated metrics.
qualityMetricsV1 Model class for Quality Metric.
recordingV1 Model class for recording data contained within an engagement.
SIContextV1 Model class for service instance context required for tenant provisioning.
entitlement Model sub class for entitlement.
SIParametersV1 Model class for service instance parameters required to provision a tenant.
internalSku Valid Live Experience internal sku names for mapping feature sets.
seatType Valid Live Experience seat license types.
serviceComponentId Recognized service component ids (B-Part numbers).
SIPropertiesV1 Model class for properties of service instance provisioned tenant.
SIServiceV1 Model class for retrieving provisioned service instance.
serviceState Possible service states.
SSOConfigV1 Model class for SSO configuration.
serviceInstanceV1 Model class for service instance provisioning.
statusResponseV1 Model class for Status Response.
state Possible status states.
subTenantLimitsV1 Model class for the Limits object (used inside subTenantConfig).
subTenantV1 Model class for sub-tenant.
userListV1 Model class for Users list.
userV1 Model class for user.
auditRecordV1
baseModel