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/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/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}
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.
Get the audit details for the business logical extension process.
Method: get
Path: /publisher/shoppingCart/v4/shoppingCart/audit/{id}
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}
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}