Interface Catalog

Overview

The Interface Catalog is a "catalog of catalogs" that provides the framework to expose and describe the available interfaces for all services supported by CPQ. A "catalog of catalogs" refers to the fact that the Interface Catalog contains both SOAP and REST service catalogs in a single entity.

Features of the Interface Catalog include:

• A catalog of all SOAP and REST services available to users
• A search page
• Access restricted to FullAccess user types

The Interface Catalog provides technical documentation on how you can invoke various REST services in integrations with CPQ, and in building Oracle CPQ user interfaces. Each Interface Catalog entry provides the definition of the REST services available, the properties of the REST service, the input and output parameters of the REST service, and the various actions that can be performed via that REST service.

The Interface Catalog supports both the JSON Schema standard and the SWAGGER standard. The JSON Schema standard is the legacy standard and is supported for historical purposes. The SWAGGER standard is the more modern standard, and is the go-forward direction of CPQ.

Users wanting to integrate a third party application with CPQ, where an out-of-the-box integration does not exist, can use the information contained in the Interface Catalog REST service descriptions to create the REST calls necessary to perform the integration with the third party system.

Within the Interface Catalog for a given REST service, you will find definitions, properties, and links. Definitions give you a description of the type of resource you are working with via that REST service. You may be working with a singularResource, which gives you access to a single item within CPQ. You could be working with a collectionPagedResource, which gives you access to multiple items within CPQ. Properties describe the attributes that are used by the resource you are accessing. Examples of properties might be transactionId, salesGroup, userName, etc. Links generally defines the various actions that are available to be executed against the resource. Examples could be actions such as update, cleanSave, deleteTransaction, order_start, etc.

There is one special action called "self" this action is used to perform an HTTP Get of the particular resource. So if you were performing REST operations on a Commerce transaction and you invoked the "self" action, you would be sending a request to the Oracle CPQ site to retrieve the transaction information for the transaction whose transactionId you supplied.

Administration

To access the Interface Catalog

1. Click Admin to go to the Admin Home Page.

2. Click Interface Catalogs under Integration Platform.

   The Interface Catalogs page opens.

3. Select an interface, or All, from the Interface Type drop-down and click Search.

   A list of interfaces appears. Each result represents a service.

   

4. Click an interface Name to open its content.

   Service listings and catalog descriptions are in JSON. SOAP WSDLs are described in XML. REST services are in JSON.

   Use an XML and JSON viewer to examine the content of the service descriptions.

   SOAP services are described for both version 1 and version 2 of Web Services. For more information, see the topics An Overview of SOAP APIs and Web Services 1.0 and An Overview of SOAP APIs and Web Services 2.0

To see a list of Processes

1. Click Admin to go to the Admin Home Page.

2. Click Process Definition in the Commerce and Documents section.

   The Processes page opens.

   The REST service names are in the following format:

   commerceDocuments + process variable name (first letter capitalized) + main doc variable name (first letter capitalized)

   Even though the process names listed on the Processes page may not match the REST service names exactly, you can find the process’ name within the REST service name.

   In addition to the above REST services, there is an additional entry for the performanceLogs REST service on the Interface Catalogs page.

Structure of the Interface Catalog

The Interface Catalog contains individual Catalogs for each type of interface.

Top Level Structure of the Interface Catalog

Content of /rest/v1/interfaceCatalogs/

The content of /rest/v1/interfaceCatalogs/, described in the following table, can be matched to the nodes listed in the previous table.

Sample of the content of the Interface Catalog description

{
   "items": [{
         "name": "soapCatalog",
         "links": [[{
                  "rel": "catalog",
                  "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/soapCatalog?group=client.cloud"
               }, {
                  "rel": "canonical",
                  "href": "http://xxx.oracle.com/rest/v1//interfaceCatalogs/soapCatalog"
               }, {
                  "rel": "self",
                  "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/soapCatalog"
               }
            ]],
         "interfaceType": "SOAP"
      }, {
         "name": "restCatalog",
         "links": [[{
                  "rel": "catalog",
                  "href": "http://xxx.oracle.com/rest/v1/metadata-catalog"
               }, {
                  "rel": "canonical",
                  "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/restCatalog"
               }, {
                  "rel": "self",
                  "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/restCatalog"
               }
            ]],
         "interfaceType": "REST"
      }
   ],
   "links": [{
         "rel": "canonical",
         "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/"
      }, {
         "rel": "self",
         "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/"
      }
   ]
}

Interface Type Specific Catalog

The interface type specific catalogs are children of the Interface Catalog.

There are two interface type specific catalogs:

• /rest/v17/interfaceCatalogs/soapCatalog
• /rest/v17/metadata-catalog

Structure of the Interface Type Specific Catalog

Sample of the SOAP-specific Catalog

{
  "name": "soapCatalog",
  "links": [ [ {
    "rel": "catalog",
    "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/soapCatalog?group=client.cloud"
  }, {
    "rel": "canonical",
    "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/soapCatalog"
  }, {
    "rel": "self",
    "href": "http://xxx.oracle.com/rest/v1/interfaceCatalogs/soapCatalog"
  } ] ],
  "interfaceType": "SOAP"

Sample of the REST-specific Catalog

{
  "name": "restCatalog",
  "links": [ [ {
    "rel": "catalog",
    "href": "http://xxx.oracle.com/rest/v17/metadata-catalog"
  }, {
    "rel": "canonical",
    "href": "http://xxx.oracle.com/rest/v17/interfaceCatalogs/restCatalog"
  }, {
    "rel": "self",
    "href": "http://xxx.oracle.com/rest/v17/interfaceCatalogs/restCatalog"
  } ] ],
  "interfaceType": "REST"
}

SOAP Catalog

REST Catalog

NOTES

Related Topics

See Also