1. Get Started REST API for Narrative ReportingREST API for Narrative Reporting
  2. Overview

Overview

REST API is an application programming interface that provides a simplified way to exchange data through HTTP requests from a client to the server. Identity REST services that provide user and role management are based on System for Cross-Domain Identity Management (SCIM ) V2 REST protocol. The feed-enabled user request service is based on Atom publishing protocol.

REST APIs in Oracle Narrative Reporting use RESTful architecture style and HTTP methods to create, update, read, or delete data. REST APIs support:

  • Data interchange by using JavaScript Object Notation (JSON) format.
  • Data compression by using the following encoding compression methods:
    • x-gzip/gzipe. An encoding format produced by the file compression program gzip (GNU zip) as described in RFC 1952. This format is a Lempel-Ziv coding (LZ77) with a 32-bit Cycle Redundancy Check (CRC).
    • Deflate. The zlib format defined in RFC 1950 in combination with the deflate compression mechanism described in RFC 1951.
In REST APIs, a resource is an object with a type, associated data, and relationships to other resources. You can use a set of HTTP methods to access each resource. Resources are organized in a hierarchical structure that enables:
  • Better organization, by grouping related data so that you can efficiently customize the resources.
  • Improved performance, by using a single HTTP request to handle multiple resources.
REST resources are organized in a hierarchy that includes:
  • Root resource. A logical object, such as an opportunity or an employee.
  • Subresource. A resource within the context of a parent resource, such as contact for an opportunity or an assignment for an employee.
  • List-of-values (LOV) resource. A resource that provides a list of valid values you can use to set a field value. LOV resources are of two types:
    • Lookup. A short, static list that contains field values. For example, an opportunity includes a CurrencyCode field. An LOV resource defines the currency codes available for this field.
    • Dynamic. A list of valid values that change based on the context of the resource. For example, an opportunity includes a contact. The dynamic list-of-values for contacts change based on the selected region.

Supported HTTP Methods

HTTP methods to create, update, and retrieve data.

HTTP Methods Descriptions
GET Retrieve a single or multiple records of the resource.
POST Create a resource or perform an operation.
DELETE Delete a REST API resource or related component