The Operations page defines the paths and methods used to perform specific tasks with an API. These methods include:

  • GET — retrieve data
  • POST — submit or create data
  • PUT — update existing data
  • DELETE — remove data
  • PATCH — apply partial updates

What you’ll find on the Operations page

Each operation includes:

  • Method — the HTTP method used to perform the task
  • Description — explains what the operation does and what it returns
  • URL template — shows the endpoint structure, including parameters that must be replaced before use

The Operations page reflects the structure and functionality defined in the API’s schema file.

What you can do on the Operations page

You can: