Extending system API resources

System API resources are defined by a set of schemas. In the base configuration, system API resources expose a subset of PolicyCenter entities and associated fields through a set of properties. To expose additional entity fields, including your own customizations, you can extend the schemas for the resource.

A resource is structured by three types of schemas. A schema definition defines the data structure of a resource, comprising property names and value types. A mapper maps the schema definition to a PolicyCenter entity and its fields. An updater enables resource data to be written to PolicyCenter, and is only needed for resources that must support write operations.

The basic workflow for extending a system API resource entails the following:

  • Extend the schema definition
  • Extend the mapper
  • Extend the updater (for POST or PATCH operations only)

For an end-to-end walk-through, see Tutorial: Create a resource extension.