Data Cataloging REST APIs

The Data Cataloging REST APIs are REST-style APIs that provide interoperability between a client and server over a network. These APIs allow authenticated users to perform management tasks.

The following list shows the significant features of REST-style APIs:
  • REST-style APIs are resource-based.
  • REST-style APIs are stateless.
  • REST-style APIs are client or server.
  • REST-style APIs are cacheable.
  • REST-style APIs are a layered system.

A representational state transfer (REST) system is a resource-based service system in which requests are made to the resource’s universal resources identifier (URI). These requests start a response from the resource in the JSON or CSV format.

The operations that you can perform on the resources or a resource element are directed by the HTTP methods such as GET, POST, PUT, and DELETE and in some cases by the parameters of the HTTPS request. The following list provides the meanings of the basic HTTP methods that are used in the requests:
GET
Reads a specific resource or a collection of resources and provides the details as the response.
PUT
Updates a specific resource or a collection of resources.
DELETE
Removes or deletes a specific resource.
POST
Creates a resource.