1. REST API for Oracle Digital Experience for Communications Industry Fabric
  2. Endpoints

All REST Endpoints

Administration/API Annexes
The API Annexes are accessible through Industries Framework. An API Annex can be used as extension to the existing API. For a single API there can be multiple API Annexes.
Create an API annex.
Method: post
Path: /admin/apiAnnexes
Delete an API annex.
Method: delete
Path: /admin/apiAnnexes/{id}
Get all API annexes.
Method: get
Path: /admin/apiAnnexes
Get an API annex.
Method: get
Path: /admin/apiAnnexes/{id}
Replace an API annex.
Method: put
Path: /admin/apiAnnexes/{id}
Update an API annex.
Method: patch
Path: /admin/apiAnnexes/{id}
Administration/APIs
The API resource lets you to define APIs that are accessible through Industries Framework. An API can be used to configure an adapter for a service that implements the API. An API can also be used to configure a listener for API events.
Create an API.
Method: post
Path: /admin/apis
Delete an API.
Method: delete
Path: /admin/apis/{id}
Get all APIs.
Method: get
Path: /admin/apis
Get an API.
Method: get
Path: /admin/apis/{id}
Replace an API.
Method: put
Path: /admin/apis/{id}
Update an API.
Method: patch
Path: /admin/apis/{id}
Administration/Connection Descriptors
The Connection Descriptors resource lets you create, view, update and delete connection descriptors.
Create a connection descriptor.
Method: post
Path: /admin/connectionDescriptors
Delete a connection descriptor.
Method: delete
Path: /admin/connectionDescriptors/{id}
Get a connection descriptor.
Method: get
Path: /admin/connectionDescriptors/{id}
Get all connection descriptors.
Method: get
Path: /admin/connectionDescriptors
Replace a connection descriptor.
Method: put
Path: /admin/connectionDescriptors/{id}
Update a connection descriptor.
Method: patch
Path: /admin/connectionDescriptors/{id}
Administration/Endpoint Rules
Endpoint Rules helps Tenant to define outer detection configurations for any host that is Routed through CXIF.
Create an endpoint rule.
Method: post
Path: /admin/endpointRules
Delete an endpoint rule.
Method: delete
Path: /admin/endpointRules/{id}
Get all endpoint rules.
Method: get
Path: /admin/endpointRules
Get an endpoint rule.
Method: get
Path: /admin/endpointRules/{id}
Replace an endpoint rule.
Method: put
Path: /admin/endpointRules/{id}
Update an endpoint rule.
Method: patch
Path: /admin/endpointRules/{id}
Administration/Export
Export is used to move configuration data between different clusters.
Export all configurations.
Method: get
Path: /admin/export
Export an individual configuration.
Method: get
Path: /admin/export/{configurationName}
Administration/Extensibility Secrets
Secrets API helps Tenant to store non public information like UserName, Password ..etc securely to the CXIF Vault.
Create an extensibility secret.
Method: post
Path: /admin/extensibilitySecrets
Get all extensibility secrets.
Method: get
Path: /admin/extensibilitySecrets
Replace an extensibility secret.
Method: put
Path: /admin/extensibilitySecrets/{id}
Administration/Feature Flags
The Feature Flags resource lets you view and update feature flags.
Enable/Disable a feature flag.
Method: put
Path: /admin/featureFlags/{flag}
Get a feature flag.
Method: get
Path: /admin/featureFlags/{flag}
Get all feature flags.
Method: get
Path: /admin/featureFlags
Administration/Gatekeeping Rule Annexes
The operations from the Administration/Gatekeeping Rule Annexes category.
Create a gatekeeping rule annex.
Method: post
Path: /admin/gatekeepingRuleAnnexes
Delete a gatekeeping rule annex.
Method: delete
Path: /admin/gatekeepingRuleAnnexes/{id}
Get a gatekeeping rule annex.
Method: get
Path: /admin/gatekeepingRuleAnnexes/{id}
Get all gatekeeping rule annexes.
Method: get
Path: /admin/gatekeepingRuleAnnexes
Replace a gatekeeping rule annex.
Method: put
Path: /admin/gatekeepingRuleAnnexes/{id}
Update a gatekeeping rule annex.
Method: patch
Path: /admin/gatekeepingRuleAnnexes/{id}
Administration/Gatekeeping Rules
The Gatekeeping Rules resource lets you view gatekeeping rules and update them.
Get a gatekeeping rule.
Method: get
Path: /admin/gatekeepingRules/{id}
Get all gatekeeping rules.
Method: get
Path: /admin/gatekeepingRules
Replace a gatekeeping rule.
Method: put
Path: /admin/gatekeepingRules/{id}
Administration/Import
The exported configurable configurations can be imported into another cluster.
Import all configurations.
Method: post
Path: /admin/import
Administration/Interaction Context Enrichments
Captures the operations that create or update a routing interaction context. Such a context is a short-lived map of information that is retained in an in-memory cache as part of the Industries Framework. In case a routing target specifies that it requires the publishing of a key/value pair on the context, Industries Framework automatically extracts the relevant information from the request and response and either creates or updates such an interaction context. The call to the request source is then receiving the ID of the interaction context via the ORA-INTERACTION-CTX custom HTTP header.
Create an interaction context enrichment.
Method: post
Path: /admin/interactionContextEnrichments
Delete an interaction context enrichment.
Method: delete
Path: /admin/interactionContextEnrichments/{id}
Get all interaction context enrichments.
Method: get
Path: /admin/interactionContextEnrichments
Get an interaction context enrichment.
Method: get
Path: /admin/interactionContextEnrichments/{id}
Replace an interaction context enrichment.
Method: put
Path: /admin/interactionContextEnrichments/{id}
Update an interaction context enrichment.
Method: patch
Path: /admin/interactionContextEnrichments/{id}
Administration/Listener Registrations
The Listener Registrations resource lets you create, view, update and delete listener registrations.
Create a listener registration.
Method: post
Path: /admin/listenerRegistrations
Delete a listener registration.
Method: delete
Path: /admin/listenerRegistrations/{id}
Get a listener registration.
Method: get
Path: /admin/listenerRegistrations/{id}
Get all listener registrations.
Method: get
Path: /admin/listenerRegistrations
Replace a listener registration.
Method: put
Path: /admin/listenerRegistrations/{id}
Update a listener registration.
Method: patch
Path: /admin/listenerRegistrations/{id}
Administration/OIDC Servers
List of the OpenID Connect servers that Industries Framework will interact with. This document appears both globally and on a per-workspace basis. Global documents are stored within the on-cluster control plane to describe for example the OIDC server that Fabric is secured with itself. Per-workspace servers are stored in a single respective document per namespace.
Create an OIDC server.
Method: post
Path: /admin/oidcServers
Delete an OIDC server.
Method: delete
Path: /admin/oidcServers/{id}
Get all OIDC servers.
Method: get
Path: /admin/oidcServers
Get an OIDC server.
Method: get
Path: /admin/oidcServers/{id}
Replace an OIDC server.
Method: put
Path: /admin/oidcServers/{id}
Update an OIDC server.
Method: patch
Path: /admin/oidcServers/{id}
Administration/Routing Criteria
RoutingCriteria is a collection of different Criterias used by different end systems for routing. Will be used in RoutingMS to evaluate the criteria based on Incoming call.
Create a routing criteria.
Method: post
Path: /admin/routingCriteria
Delete a routing criteria.
Method: delete
Path: /admin/routingCriteria/{id}
Get a routing criteria.
Method: get
Path: /admin/routingCriteria/{id}
Get all routing criteria.
Method: get
Path: /admin/routingCriteria
Replace a routing criteria.
Method: put
Path: /admin/routingCriteria/{id}
Update a routing criteria.
Method: patch
Path: /admin/routingCriteria/{id}
Administration/SCIM Configurations
Captures SCIM Adapter configurations of user management APIs.
Create a SCIM configuration.
Method: post
Path: /admin/scimConfigurations
Get a SCIM configuration.
Method: get
Path: /admin/scimConfigurations/{id}
Get all SCIM configurations.
Method: get
Path: /admin/scimConfigurations
Replace a SCIM configuration.
Method: put
Path: /admin/scimConfigurations/{id}
Update a SCIM configuration.
Method: patch
Path: /admin/scimConfigurations/{id}
Administration/Stock Responses
The Stock Responses provide a static responses for the APIs. This resource lets you view, create, update, and delete stock responses.
Create a stock response.
Method: post
Path: /admin/stockResponses
Delete a stock response.
Method: delete
Path: /admin/stockResponses/{id}
Get a stock response.
Method: get
Path: /admin/stockResponses/{id}
Get all stock responses.
Method: get
Path: /admin/stockResponses
Replace a stock response.
Method: put
Path: /admin/stockResponses/{id}
Update a stock response.
Method: patch
Path: /admin/stockResponses/{id}
Administration/System Descriptors
The System Descriptors resource lets you create, view, update and delete system descriptors.
Create a system descriptor.
Method: post
Path: /admin/systemDescriptors
Delete a system descriptor.
Method: delete
Path: /admin/systemDescriptors/{id}
Get a system descriptor.
Method: get
Path: /admin/systemDescriptors/{id}
Get all system descriptors.
Method: get
Path: /admin/systemDescriptors
Replace a system descriptor.
Method: put
Path: /admin/systemDescriptors/{id}
Update a system descriptor.
Method: patch
Path: /admin/systemDescriptors/{id}
Administration/Tenant Configurations
The Tenant Configurations resource lets you view and update tenant configuration. A tenant configuration object includes all configurations of a tenant or workspace.
Get all tenant configurations.
Method: get
Path: /admin/tenantConfigurations
Replace a tenant configuration.
Method: put
Path: /admin/tenantConfigurations/{id}
Administration/Utility Configurations
The Utility Configurations resource lets you view and update utility configurations.
Get all utility configurations.
Method: get
Path: /admin/utilityConfigurations
Replace a utility configuration.
Method: put
Path: /admin/utilityConfigurations/{id}
Administration/Workspace Clients
This document type describes the lookup of client application specific OAuth/OpenID Connect secrets that identify the client application on the various different AuthZ servers. It also references the secrets that are needed to sign OIDC token assertions.
Create a workspace client.
Method: post
Path: /admin/workspaceClients
Delete a workspace client.
Method: delete
Path: /admin/workspaceClients/{id}
Get a workspace client.
Method: get
Path: /admin/workspaceClients/{id}
Get all workspace clients.
Method: get
Path: /admin/workspaceClients
Replace a workspace client.
Method: put
Path: /admin/workspaceClients/{id}
Update a workspace client.
Method: patch
Path: /admin/workspaceClients/{id}
Administration/Workspaces
Workspace is a collection of Industries Framework configurations. Will be used in identifying the workspace to which the Microservice needs the call to be routed to.
Get a workspace.
Method: get
Path: /admin/workspaces/{id}
Get all workspaces.
Method: get
Path: /admin/workspaces
Replace a workspace.
Method: put
Path: /admin/workspaces/{id}
Update a workspace.
Method: patch
Path: /admin/workspaces/{id}
After-Market Extensibility
The resource lets you to view after-market extentions available. You can view the list of objects that can be extended, the current extensions available, and get information about a current extension. Currently, you can extend all TMF objects available in the framework.

Below is the mapping table for design time after market extensions.The extensions created at Shopping Cart (TMF 663) will be copied over Product Order (TMF 622) and Product Inventory (Asset) (TMF 637) based on below mappings

Shopping Cart (TMF 663) Product Order (TMF 622) Product Inventory (Asset) (TMF 637)
AccountRefOracle AccountRefOracle AccountRefOracle
AddressOracle AddressOracle AddressOracle
BillingAccountRefOracle BillingAccountRefOracle BillingAccountRefOracle
ContactMedium
EligibilityProfileOracle EligibilityProfileOracle
MediumCharacteristic
OracleContractCreateJob
OracleCouponManagement OracleCouponManagement
OracleDeliverySchedule OracleDeliverySchedule
OracleFulfillmentInfo OracleFulfillmentInfo
OracleInstallation OracleInstallation
OracleLoyaltyManagement OracleLoyaltyManagement
OraclePayment OraclePayment
OracleRelatedParty OracleRelatedParty
OracleShipmentTracking OracleShipmentTracking
OracleStorePickUp OracleStorePickUp
OracleTSQ OracleTSQ
OracleValidateCart
Quantity Quantity Quantity
TimePeriod TimePeriod TimePeriod
Money Money Money
OracleContact OracleContact
OracleItemFulfillmentInfo OracleItemFulfillmentInfo
CharacteristicOracle CharacteristicOracle CharacteristicOracle
CartItemOracle ProductOrderItemOracle ProductOracle
BillStructure
OracleValidateOrder
BillingCycleSpecificationRefOrValue
BillFormatRefOrValue
BillPresentationMediaRefOrValue

The CartItemOracle extension component name should be PrefixCartItemOracle. And, the ProductOrderItemOracle and ProductOracle will be internally prefixed with extensionName as

PrefixProductOrderItemOracle and PrefixProductOracle. In the runtime APIs the @type should be passed as PrefixProductOrderItemOracle and PrefixProductOracle for ProductOrder and Asset.

Create a generation rule.
Method: post
Path: /apiManagement/generationRules/{resource-owner}/{classifier}
Create a JSON Schema.
Method: post
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}
Get all extensible resources.
Method: get
Path: /extensionPublisher/cx/industry/publisher/v1/extensibleResource/
Get all extensions.
Method: get
Path: /extensionPublisher/cx/industry/publisher/v1/extensions/
Get an extension status.
Method: get
Path: /extensionPublisher/cx/industry/publisher/v1/status/{extensionName}
Update a generation rule.
Method: put
Path: /apiManagement/generationRules/{resource-owner}/{classifier}/{id}
Update a JSON Schema.
Method: put
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}/{id}
Business Logical Extensions
Each BLE can be triggered based on combination of an entity action (Create, Modify, Deleteetc.) and conditions that are provided by tenants or SI. Some of the examples- * Perform address validation when contact is created for a Party Account.
* Based on the Cart price, call a promotion calculation system like Pega and get available promotional discounts for the cart. Based on the discount Cart prices is updated..
* Shipping address is added to the header or items. As the address is added, tax needs to be calculated from an external system based on the address.
* A device is added to the cart. As a result there is a check required to an external (external to shopping cart) inventory to check if there is stock.
* An offer is added to the cart item with a base price. A call to the external system is made to get the price for specific account or account type to get the discounted price and update cart with the new price.
* When a customer is deemed as blacklisted, then an external system validated if such customers are eligible for the offers/plans added to the cart.
Create a processing information for business logical extension.
Method: post
Path: /publisher/apiManagement/processingInformation/shoppingcartAdapter/shoppingCart/v4/schemas/oracle/buying/{component_name}
Delete a business logical extension.
Method: delete
Path: /publisher/apiManagement/processingInformation/shoppingcartAdapter/shoppingCart/v4/schemas/oracle/buying/{component_name}
Get the audit details for the business logical extension process.
Method: get
Path: /publisher/shoppingCart/v4/shoppingCart/audit/{id}
Update a business logical extension.
Method: patch
Path: /publisher/apiManagement/processingInformation/shoppingcartAdapter/shoppingCart/v4/schemas/oracle/buying/{component_name}
Document Management/Documents
Delete document.
Method: delete
Path: /documentManagement/v1/{documentManagementSystemId}/documents/{documentId}
Download document.
Method: get
Path: /documentManagement/v1/{documentManagementSystemId}/documents/{documentId}/data
Get document metadata.
Method: get
Path: /documentManagement/v1/{documentManagementSystemId}/documents/{documentId}
Upload document.
Method: post
Path: /documentManagement/v1/{documentManagementSystemId}/documents
Upload multiple files.
Method: post
Path: /documentManagement/v1/{documentManagementSystemId}/documents/uploadMultiple
Upload new version of document.
Method: post
Path: /documentManagement/v1/{documentManagementSystemId}/documents/{documentId}
Document Management/Folders
Create folder.
Method: post
Path: /documentManagement/v1/{documentManagementSystemId}/folders
Delete folder.
Method: delete
Path: /documentManagement/v1/{documentManagementSystemId}/folders/{folderId}
Rename folder.
Method: put
Path: /documentManagement/v1/{documentManagementSystemId}/folders/{folderId}
Extensibility/Generation Rules
Generation Rules service provides the way to upload or create the generationRules on to the Extensibility Solution at the runtime. GenerationRules contain the binding rules for the aftermarket extension schema(s) to a given OpenAPI.

Note:

Refer the details of the REST API user role required to generate the OAuth token for respective services and their HTTP operations, provided in the Access Roles for Resources topic. Example if you want to generate the OAuth token for 'Generation Rules' service and for POST operation, you would use 'EXTENSION_RULES_CREATE' as a user role.

Create a generation rule.
Method: post
Path: /apiManagement/generationRules/{resource-owner}/{classifier}
Delete a generation rule.
Method: delete
Path: /apiManagement/generationRules/{resource-owner}/{classifier}/{id}
Get a generation rule.
Method: get
Path: /apiManagement/generationRules/{resource-owner}/{classifier}/{id}
Get all generation rules.
Method: get
Path: /apiManagement/generationRules/{resource-owner}/{classifier}
Update a generation rule.
Method: put
Path: /apiManagement/generationRules/{resource-owner}/{classifier}/{id}
Extensibility/JSON Schemas
JSON Schemas service provides the way to upload or create the jsonSchema having an aftermarket extension to the Extensibility Solution at the runtime.

Note:

Refer the details of the REST API user role required to generate the OAuth token for respective services and their HTTP operations, provided in the Access Roles for Resources topic. Example if you want to generate the OAuth token for 'Generation Rules' service and for POST operation, you would use 'EXTENSION_RULES_CREATE' as a user role.

Create a JSON Schema.
Method: post
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}
Delete a JSON Schema.
Method: delete
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}/{id}
Get a JSON Schema.
Method: get
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}/{id}
Get all JSON Schemas.
Method: get
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}
Update a JSON Schema.
Method: put
Path: /apiManagement/jsonSchemas/{resource-owner}/{classifier}/{id}
Extensibility/Open APIs
OpenAPI service provides the way to generate the OpenAPI document on demand through the Extensibility service along with aftermarket extensions if any applied at the runtime.
Get all OpenAPIs.
Method: get
Path: /apiManagement/openAPI/v3.0.3
Get an OpenAPI.
Method: get
Path: /apiManagement/openAPI/v3.0.3/{api-name}/{api-version}
Extensibility/Processing Information
The process information resource lets you view, create, update, and delete processing information in the Extensibility Solution at the runtime. The resource is a ECMAScript 6 that is run by the EDK (Extensibility Developement Kit) on an EDK based adapter in order to perform the aftermarket extension processing.

Note:

How find out the resource owner and classifier to be used in ProcessingInformation REST URL.

  • The type/resource for which the ProcessingInformation to be uploaded is already known, for example 'ShoppingCartOracle'.
  • Perform GET ALL call on schema service with the sample URL as 'apiManagement/jsonSchemas'. Find the type/resource name in the above REST response and get to know its schema location. For example in the REST response, href for 'ShoppingCartOracle' is https:///apiManagement/jsonSchemas/oracle/buying/ShoppingCartOracle.schema.json where '/oracle/buying/' is the schema location. The resource owner and classifier are 'oracle' and 'buying' respectively.
  • The ProcessingInformation can be formed using the schema location obtained above. The example ProcessingInformation URL is 'apiManagement/processingInformation/{adapter-id}/customerManagement/{api-version}/schemas/oracle/buying/ShoppingCartOracle'

    • Enabled the additional ProcessingInformation validation through Adapter Capabilities Management.

  • We have enabled the additional validation based on Adapter Capabilities Management during the ProcessingInformation upload.
  • ProcessingInformation is only allowed to be uploaded if the corresponding adapter supports such capability.
  • Any existing ProcessingInformations those are not allowed to be updated (due to adapter supported capabilities or incase it was uploaded with wrong schema location in the URL ) should be deleted first. Then correct the ProcessingInformation URL and re-upload.

    • The ProcessingInformation written and uploaded by the Tenant should not contain and process any sort of sensitive/confidential information. The ProcessingInformation can contain the business logic in the form of ECMA script but should not contain any PII data.

    Refer the details of the REST API user role required to generate the OAuth token for respective services and their HTTP operations, provided in the Access Roles for Resources topic. Example if you want to generate the OAuth token for 'Generation Rules' service and for POST operation, you would use 'EXTENSION_RULES_CREATE' as a user role.

    Create processing information.
    Method: post
    Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}
    Delete a processing information.
    Method: delete
    Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}
    Get a processing information.
    Method: get
    Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}
    Get all processing information.
    Method: get
    Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/
    Replace a processing information.
    Method: put
    Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}
    Routing Status
    Defines Routing Status API for Industries Framework Routing service.
    Get spoke system registration information.
    Method: get
    Path: /status/routing/apis
    TMF 632 Party Management/Event Subscriptions
    The Event Subscriptions resource lets you view, create, update, and delete event subscription records. An event subscription is a registration indicating that a particular event is significant to a particular system and specifying the processing to perform when the triggering event occurs.
    Register a listener.
    Method: post
    Path: /party/v4/hub
    Unregister a listener.
    Method: delete
    Path: /party/v4/hub/{id}
    TMF 632 Party Management/Individuals
    The Individuals resource lets you view, create, update, and delete individual records. Individual is a person who has any kind of relation with the organization.
    Create an individual.
    Method: post
    Path: /party/v4/individual
    Delete an individual.
    Method: delete
    Path: /party/v4/individual/{id}
    Get all individuals.
    Method: get
    Path: /party/v4/individual
    Get an individual.
    Method: get
    Path: /party/v4/individual/{id}
    Update an individual.
    Method: patch
    Path: /party/v4/individual/{id}
    TMF 632 Party Management/Notification Listeners
    The Notification Listeners resource lets you view, create, update, and delete notification listener records. A notification listener is a class that listens to notifications and responds appropriately.
    Sample listener for Create Individual event.
    Method: post
    Path: /party/v4/listener/individualCreateEvent
    Sample listener for Create Organization event.
    Method: post
    Path: /party/v4/listener/organizationCreateEvent
    Sample listener for Individual Delete event.
    Method: post
    Path: /party/v4/listener/individualDeleteEvent
    Sample listener for Organization Delete event.
    Method: post
    Path: /party/v4/listener/organizationDeleteEvent
    Sample listener for Update Individual event.
    Method: post
    Path: /party/v4/listener/individualAttributeValueChangeEvent
    Sample listener for Update Organization event.
    Method: post
    Path: /party/v4/listener/organizationAttributeValueChangeEvent
    TMF 632 Party Management/Organizations
    The Organizations resource lets you view, create, update, and delete organization records.
    Create an organization.
    Method: post
    Path: /party/v4/organization
    Delete an organization.
    Method: delete
    Path: /party/v4/organization/{id}
    Get all organizations.
    Method: get
    Path: /party/v4/organization
    Get an organization.
    Method: get
    Path: /party/v4/organization/{id}
    Update an organization.
    Method: patch
    Path: /party/v4/organization/{id}
    User Management
    The User Management API lets you to create users in identity management systems that are compliant to SCIM 2.0. The API supports customization of the requested user to be created in the sense of custom attribute mapping and group allocation, based on the requested user profile and destination identity management system.
    Create user in the target IDM.
    Method: post
    Path: /userManagement/v1/user
    Get users by user name.
    Method: get
    Path: /userManagement/v1/user
    Replace user attribute values in the target IDM.
    Method: put
    Path: /userManagement/v1/user/{id}
    Update user in the target IDM.
    Method: patch
    Path: /userManagement/v1/user/{id}