You are here: Integrating With CPQ Cloud > Integration Guides > Interface Catalog

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 Cloud.

This feature is designed to discover existing SOAP and REST web services, along with their definitions, shapes, and endpoints. The Interface Catalog also provides additional information to help you discover, learn, and use the correct interface.

Features include:

The Interface Catalog provides a list of all available interface type specific catalogs; for now, this is the SOAP Catalog and the REST Catalog. It is also the entry point to the newly exposed REST APIs for transactional objects.

ADMINISTRATION

ClosedTo 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 appears.

  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


ClosedTo see a list of Processes

  1. Click Admin to go to the Admin Home Page.
  2. Click Process Definition under Commerce and Documents.

    The Processes page appears.

    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.

ClosedTop Level Structure of the Interface Catalog

The structure of the top level of the Interface Catalog is described in the following table.

Catalog Node Description
/items/name This is the unique identifier of the interface type specific catalog.
/items/links

The "catalog" link points to the individual interface type specific catalog resource. The "groups=client.cloud" query parameter restricts the attributes that are shown to just what is needed by cloud clients.

The "self" link points to the interface type specific singular catalog resource.

/items/interfaceType Current valid values are SOAP and REST.
/links A "self" link points to this interface catalog resource.

ClosedContent 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.


ClosedSample 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:

ClosedStructure of the Interface Type Specific Catalog


ClosedSample 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"

}


ClosedSample of the REST-specific Catalog

{

  "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"

}


ClosedSOAP Catalog

The SOAP Catalog is the SOAP version of the interface type specific catalog resource. The link is seen in the sample above:

http://xxx.us.oracle.com/rest/v1/interfaceCatalogs/soapCatalog?group=client.cloud.

SOAP Catalog Node Description

/items

As part of the description for each service listed, the id, name, description, and lifecycle are displayed.

items/links

The "catalog" link points to this SOAP catalog resource with the "groups=client.cloud" query parameter.

The "canonical" and “self” links point to the SOAP catalog resource with all details of the SOAP service description.

The “WSDL” link, if shown, is a link to the Service WSDL.

/links

The "canonical" and “self” links point to the SOAP catalog resource with all details of the SOAP resource metadata URIs.


ClosedREST Catalog

The REST Catalog is the REST version of the interface type specific catalog resource. The link is seen in the sample above:

http://xxx.us.oracle.com/rest/v1/metadata-catalog

REST Catalog Node Description

/items/name

The unique name of a given REST resource.

items/links

The “alternate” link points to the REST resource metadata URIs for the given REST resource name, along with the schema.  The schema specifies Oracle-specific REST standards.

The "canonical" link points to the REST catalog resource metadata URIs for the given REST resource name.

The “describes” link is a link to the item itself, providing more information about the individual service.

/links

The "canonical" and “self” links point to the REST catalog resource with all details of the REST resource metadata URIs.


NOTES

RELATED TOPICS