1. Integration Playbooks for Procurement
  2. REST APIs

REST APIs

Oracle Fusion Cloud Procurement provides customers and system integrators with a comprehensive set of REST APIs to view, create, update, or delete records for their real-time integration requirements.

In addition to using file-based data import (FBDI) and Business Intelligence Cloud Connector (BICC) to import and export large-volume data from Oracle Fusion Cloud Applications, REST APIs provide a robust and highly scalable tool for integration with Oracle Procurement applications.

For more information, see REST API for Oracle Fusion Cloud Procurement.

Key Features

  • REST APIs are used for both inbound and outbound flow.
  • Support for real-time integration requirements.
  • Support for CRUD operations on both single-item and collection.
  • Many product teams support BATCH operations on their objects, which allows them to execute multiple updates, insert, delete, and get operations in a single call.
  • Along with CRUD operations, many Oracle Procurement applications support custom actions.
  • Extensive support across Oracle Procurement applications
  • End-to-end process orchestration can easily use REST APIs.
  • Support only for JSON format.

Best Practices

  • Always consult the REST documentation guide for various headers to pass while making a REST call, and review examples provided by Oracle Procurement product teams.
  • While retrieving data, use limit and offset for data pagination.
  • When retrieving data, use the field URI parameter to restrict the response to only fields you're interested in.
  • Use query parameter q to filter and restrict the results.
  • Combine multiple API requests into a single request when possible.
  • Use the onlyData=true directive to exclude all links from the response, thereby reducing the response size.
  • Implement timeout handling and retry logic for HTTP error codes like 500 (Internal Server Error), 502 (Bad Gateway), 503 (Service Unavailable), and 504 (Gateway Timeout). While retrying, always use exponential back-off to avoid overwhelming the server.
  • For the 503 (Service Unavailable) error, see if the response output has the word "Maintenance" retry. In such cases, consider a total delay of up to 8 hours because sometimes updates can take a long time.
  • If you contact Oracle Support, ensure you log errors and important transaction details. To quickly resolve errors, Oracle Support would need the exact time for the REST call and input and output payloads.
  • You can specify an Oracle Business Object REST API framework version for your web application to opt into new functionality offered by a later version of the REST API framework.
  • You can use entity tags (ETags) for APIs with a high Read/Write ratio needing frequent updates. To avoid conflicts and improve caching, ETags can be used to validate data, detect stale data, and so on. It ensures better performance and efficiency.

Constraints

  • Not suitable for large volumes of data import/export.
  • None of the Oracle Procurement REST APIs allow the return of more than 500 records in a single call. You can paginate through the entire set using offset and limit in REST parameters.
  • The changes introduced in each framework version are backward incompatible. Therefore, assess your business requirements and use the framework version that supports them.
Note: When building an integration with Oracle Procurement applications, don't use an undocumented REST API. Oracle doesn't guarantee backward compatibility of undocumented REST APIs and they can be deprecated without formal notice.

Oracle Visual Builder Add-In for Microsoft Excel

You can use Excel as a REST client to retrieve, analyze, edit, and load data using the Oracle Visual Builder Add-in for Excel. For more information, see Oracle Visual Builder Add-in for Excel, Version 3.2.0.

Related Topics