Relationship Diagrams for Data Exporter API

With this release, customers who use the Data Exporter API (DE API) gain the ability to generate diagrams that show the relationship between objects in an instant, without the need to navigate lengthy text documents.

Using a new endpoint, developers and integrations specialist can choose a mode (Basic, Detail, or Relations) and add the names of the objects to generate diagrams that illustrate the relationship between those objects, saving time and lessening effort. Up to 32 objects can be added. 

Two Inputs are required: ​

  • Mode – Choose from Basic, Detail, and Relations.​
  • Obj – Add the name of the objects for which you want to see relationships.​

Note that a closing coma is required when calling the endpoint and there should be no spaces between objects.

For example: [portal].csod.com/api/x/objects/$cs_diagram?mode=N&obj= X,Y,Z,

Data Exporter API can generate relationship diagrams for objects to represent relationships between different core objects. Each relationship is represented with an arrow which shows navigation from one object to another object. The object where the arrow originates is considered (To) and the object where the arrow points towards is considered (From) object. If the arrow points to itself, it represents that there is a self-referencing navigation relationship.

Basic Mode

Example: /api/x/objects/$cs_diagram?mode=basic&obj= users_core,users_cf_core,​

​This mode illustrates if objects are related. The relationship is illustrated by the presence of a connecting line.​

Looping lines mean that there is an internal self-reference, meaning that there are fields within the object that are related. In the case of user_core, manager and user are related.

Detail Mode

Example: /api/x/objects/$cs_diagram?mode=detail&obj= users_core,users_cf_core, ​

This mode shows every relationship between objects along with the name of the relationship and field.

Relations Mode

Example: /api/x/objects/$cs_diagram?mode=relation&obj= users_core,users_cf_core, ​

This mode presents each of the relationships along with the field that relates the objects.

Multiplicity

Each relationship also shows the Multiplicity that relationship represents between the two entities. Multiplicity defines how object participate in a relationship and it is the number of instances of one object related to one instance of the other object.

  • 0..* - An object instance can have zero or many related instances in another object. for example, A user can have zero or more transcripts.
  • 1 - An object instance has exactly 1 related instance in another object. For example, a user can have only one manager.
  • 0..1 - An object instance can have zero or one related instance in another object. For example, a user can have zero or one indirect manager.

How Does This Enhancement Benefit My Organization?

This enhancement makes it easier for developers to identify how objects and fields are related by using diagrams.

New End Point

https://[portalname].csod.com/services/api/x/dataexporter/api/objects/$cs_diagram

Considerations

  • Adding a scope is not required, but the user must have access to $metadata endpoint.​
  • Query string is limited to 1024 characters.​
  • Up to 32 objects may be requested per call.

Implementation

  • This functionality is automatically enabled for all organizations using the Data Explorer API.

API Documentation and Starter Guide

Documentation for the Data Explorer APIs is available in the Reporting API tile in API Explorer

If you are not logged into your Cornerstone portal, you may want to do so since the documentation for certain API endpoints adjust based on your portal's schema.