Overview of schema configuration

A schema is metadata that identifies how data is structured. In Cloud API, schemas are used to define resources. A resource is a JSON object included in a REST request or response that contains the data for the request or the response.

For example, Cloud API has an Activity schema. It defines properties such as subject (a string) and priority (a value from the Priority typelist). This schema is used by the various /common/v1/activities endpoints. For example:

• When you submit a POST /common/v1/activities request, the request object contains an Activity resource that defines the activity to create.
• When you submit a GET /common/v1/activities request, the response object contains one or more Activity resources that contain the data you requested.

This topic provides an overview of the different types of files used in schema configuration.