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: postPath:
/admin/apiAnnexes - Delete an API annex.
- Method: deletePath:
/admin/apiAnnexes/{id} - Get all API annexes.
- Method: getPath:
/admin/apiAnnexes - Get an API annex.
- Method: getPath:
/admin/apiAnnexes/{id} - Replace an API annex.
- Method: putPath:
/admin/apiAnnexes/{id} - Update an API annex.
- Method: patchPath:
/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: postPath:
/admin/apis - Delete an API.
- Method: deletePath:
/admin/apis/{id} - Get all APIs.
- Method: getPath:
/admin/apis - Get an API.
- Method: getPath:
/admin/apis/{id} - Replace an API.
- Method: putPath:
/admin/apis/{id} - Update an API.
- Method: patchPath:
/admin/apis/{id}
Administration/Connection Descriptors
The Connection Descriptors resource lets you create, view, update and delete connection descriptors.
- Create a connection descriptor.
- Method: postPath:
/admin/connectionDescriptors - Delete a connection descriptor.
- Method: deletePath:
/admin/connectionDescriptors/{id} - Get a connection descriptor.
- Method: getPath:
/admin/connectionDescriptors/{id} - Get all connection descriptors.
- Method: getPath:
/admin/connectionDescriptors - Replace a connection descriptor.
- Method: putPath:
/admin/connectionDescriptors/{id} - Update a connection descriptor.
- Method: patchPath:
/admin/connectionDescriptors/{id}
Administration/Export
Export is used to move configuration data between different clusters.
- Export all configurations.
- Method: getPath:
/admin/export - Export an individual configuration.
- Method: getPath:
/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: postPath:
/admin/extensibilitySecrets - Get all extensibility secrets.
- Method: getPath:
/admin/extensibilitySecrets - Replace an extensibility secret.
- Method: putPath:
/admin/extensibilitySecrets/{id}
Administration/Feature Flags
The Feature Flags resource lets you view and update feature flags.
- Enable/Disable a feature flag.
- Method: putPath:
/admin/featureFlags/{flag} - Get a feature flag.
- Method: getPath:
/admin/featureFlags/{flag} - Get all feature flags.
- Method: getPath:
/admin/featureFlags
Administration/Gatekeeping Rule Annexes
The operations from the Administration/Gatekeeping Rule Annexes category.
- Create a gatekeeping rule annex.
- Method: postPath:
/admin/gatekeepingRuleAnnexes - Delete a gatekeeping rule annex.
- Method: deletePath:
/admin/gatekeepingRuleAnnexes/{id} - Get a gatekeeping rule annex.
- Method: getPath:
/admin/gatekeepingRuleAnnexes/{id} - Get all gatekeeping rule annexes.
- Method: getPath:
/admin/gatekeepingRuleAnnexes - Replace a gatekeeping rule annex.
- Method: putPath:
/admin/gatekeepingRuleAnnexes/{id} - Update a gatekeeping rule annex.
- Method: patchPath:
/admin/gatekeepingRuleAnnexes/{id}
Administration/Gatekeeping Rules
The Gatekeeping Rules resource lets you view gatekeeping rules and update them.
- Get a gatekeeping rule.
- Method: getPath:
/admin/gatekeepingRules/{id} - Get all gatekeeping rules.
- Method: getPath:
/admin/gatekeepingRules - Replace a gatekeeping rule.
- Method: putPath:
/admin/gatekeepingRules/{id}
Administration/Import
The exported configurable configurations can be imported into another cluster.
- Import all configurations.
- Method: postPath:
/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: postPath:
/admin/interactionContextEnrichments - Delete an interaction context enrichment.
- Method: deletePath:
/admin/interactionContextEnrichments/{id} - Get all interaction context enrichments.
- Method: getPath:
/admin/interactionContextEnrichments - Get an interaction context enrichment.
- Method: getPath:
/admin/interactionContextEnrichments/{id} - Replace an interaction context enrichment.
- Method: putPath:
/admin/interactionContextEnrichments/{id} - Update an interaction context enrichment.
- Method: patchPath:
/admin/interactionContextEnrichments/{id}
Administration/Listener Registrations
The Listener Registrations resource lets you create, view, update and delete listener registrations.
- Create a listener registration.
- Method: postPath:
/admin/listenerRegistrations - Delete a listener registration.
- Method: deletePath:
/admin/listenerRegistrations/{id} - Get a listener registration.
- Method: getPath:
/admin/listenerRegistrations/{id} - Get all listener registrations.
- Method: getPath:
/admin/listenerRegistrations - Replace a listener registration.
- Method: putPath:
/admin/listenerRegistrations/{id} - Update a listener registration.
- Method: patchPath:
/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: postPath:
/admin/oidcServers - Delete an OIDC server.
- Method: deletePath:
/admin/oidcServers/{id} - Get all OIDC servers.
- Method: getPath:
/admin/oidcServers - Get an OIDC server.
- Method: getPath:
/admin/oidcServers/{id} - Replace an OIDC server.
- Method: putPath:
/admin/oidcServers/{id} - Update an OIDC server.
- Method: patchPath:
/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: postPath:
/admin/routingCriteria - Delete a routing criteria.
- Method: deletePath:
/admin/routingCriteria/{id} - Get a routing criteria.
- Method: getPath:
/admin/routingCriteria/{id} - Get all routing criteria.
- Method: getPath:
/admin/routingCriteria - Replace a routing criteria.
- Method: putPath:
/admin/routingCriteria/{id} - Update a routing criteria.
- Method: patchPath:
/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: postPath:
/admin/stockResponses - Delete a stock response.
- Method: deletePath:
/admin/stockResponses/{id} - Get a stock response.
- Method: getPath:
/admin/stockResponses/{id} - Get all stock responses.
- Method: getPath:
/admin/stockResponses - Replace a stock response.
- Method: putPath:
/admin/stockResponses/{id} - Update a stock response.
- Method: patchPath:
/admin/stockResponses/{id}
Administration/System Descriptors
The System Descriptors resource lets you create, view, update and delete system descriptors.
- Create a system descriptor.
- Method: postPath:
/admin/systemDescriptors - Delete a system descriptor.
- Method: deletePath:
/admin/systemDescriptors/{id} - Get a system descriptor.
- Method: getPath:
/admin/systemDescriptors/{id} - Get all system descriptors.
- Method: getPath:
/admin/systemDescriptors - Replace a system descriptor.
- Method: putPath:
/admin/systemDescriptors/{id} - Update a system descriptor.
- Method: patchPath:
/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: getPath:
/admin/tenantConfigurations - Replace a tenant configuration.
- Method: putPath:
/admin/tenantConfigurations/{id}
Administration/Utility Configurations
The Utility Configurations resource lets you view and update utility configurations.
- Get all utility configurations.
- Method: getPath:
/admin/utilityConfigurations - Replace a utility configuration.
- Method: putPath:
/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: postPath:
/admin/workspaceClients - Delete a workspace client.
- Method: deletePath:
/admin/workspaceClients/{id} - Get a workspace client.
- Method: getPath:
/admin/workspaceClients/{id} - Get all workspace clients.
- Method: getPath:
/admin/workspaceClients - Replace a workspace client.
- Method: putPath:
/admin/workspaceClients/{id} - Update a workspace client.
- Method: patchPath:
/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: getPath:
/admin/workspaces/{id} - Get all workspaces.
- Method: getPath:
/admin/workspaces - Replace a workspace.
- Method: putPath:
/admin/workspaces/{id} - Update a workspace.
- Method: patchPath:
/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.
* 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: getPath:
/publisher/shoppingCart/v4/shoppingCart/audit/{id}
Document Management/Documents
- Delete document.
- Method: deletePath:
/documentManagement/v1/{documentManagementSystemId}/documents/{documentId} - Download document.
- Method: getPath:
/documentManagement/v1/{documentManagementSystemId}/documents/{documentId}/data - Get document metadata.
- Method: getPath:
/documentManagement/v1/{documentManagementSystemId}/documents/{documentId} - Upload document.
- Method: postPath:
/documentManagement/v1/{documentManagementSystemId}/documents - Upload multiple files.
- Method: postPath:
/documentManagement/v1/{documentManagementSystemId}/documents/uploadMultiple - Upload new version of document.
- Method: postPath:
/documentManagement/v1/{documentManagementSystemId}/documents/{documentId}
Document Management/Folders
- Create folder.
- Method: postPath:
/documentManagement/v1/{documentManagementSystemId}/folders - Delete folder.
- Method: deletePath:
/documentManagement/v1/{documentManagementSystemId}/folders/{folderId} - Rename folder.
- Method: putPath:
/documentManagement/v1/{documentManagementSystemId}/folders/{folderId}
Routing Status
Defines Routing Status API for Industries Framework Routing service.
- Get spoke system registration information.
- Method: getPath:
/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: postPath:
/party/v4/hub - Unregister a listener.
- Method: deletePath:
/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: postPath:
/party/v4/individual - Delete an individual.
- Method: deletePath:
/party/v4/individual/{id} - Get all individuals.
- Method: getPath:
/party/v4/individual - Get an individual.
- Method: getPath:
/party/v4/individual/{id} - Update an individual.
- Method: patchPath:
/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: postPath:
/party/v4/listener/individualCreateEvent - Sample listener for Create Organization event.
- Method: postPath:
/party/v4/listener/organizationCreateEvent - Sample listener for Individual Delete event.
- Method: postPath:
/party/v4/listener/individualDeleteEvent - Sample listener for Organization Delete event.
- Method: postPath:
/party/v4/listener/organizationDeleteEvent - Sample listener for Update Individual event.
- Method: postPath:
/party/v4/listener/individualAttributeValueChangeEvent - Sample listener for Update Organization event.
- Method: postPath:
/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: postPath:
/party/v4/organization - Delete an organization.
- Method: deletePath:
/party/v4/organization/{id} - Get all organizations.
- Method: getPath:
/party/v4/organization - Get an organization.
- Method: getPath:
/party/v4/organization/{id} - Update an organization.
- Method: patchPath:
/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: postPath:
/userManagement/v1/user - Get users by user name.
- Method: getPath:
/userManagement/v1/user - Replace user attribute values in the target IDM.
- Method: putPath:
/userManagement/v1/user/{id} - Update user in the target IDM.
- Method: patchPath:
/userManagement/v1/user/{id}