Business entity schemas

For some use cases, it’s necessary to have a schema with detailed graph and entity information. For this purpose, PolicyCenter provides endpoints that retrieve schema information that can be used to navigate the graph structure for various purposes and to build out custom user interfaces.

The schema endpoints return metadata about the business entities that are exposed by the API (such as Users and Contacts) as normal JSON schema documents. In addition to standard JSON Schema properties, the schema endpoints can also return additional application-specific metadata. This additional metadata is returned in the form of x-gw-* properties.

The topics in this section describe the endpoints and query parameters for retrieving schemas. They also describe properties that are specific to entity and graph schemas and not found in the standard business schemas (such as OpenAPI).