REST APIs (Inbound)

You can use REST APIs to create, review, update, and sometimes delete data in Oracle Service Logistics, including setup, definition, and transactional entities.

Key Features

• Create and manage setup data.
• Perform data updates in near real time.
• Retrieve data for custom pages or external systems.

Best Practices

• Create and manage setup data

  You can create and manage certain entities using a REST API.

• Perform data updates in near real-time

  Use this option only if you need to perform near real-time mode operations, which can include creating or updating data.

• Retrieve data for custom pages or external systems
  • You can perform GET operations to retrieve both setup, lookup, and general object data.
  • You can query by object id, query, or finder.
  • To improve performance:
    • Limit the attributes using the fields query parameter.
    • Avoid OR conditions with LIKE clauses where possible.
    • Avoid querying master records using only child query criteria where possible.

Constraints

• Create and manage setup data
  • Several objects are supported by the REST API integration option.
  • You should review the capabilities of each REST API and identify the best method for the implementation and for the ongoing management of the object data.
• Perform data updates in near real-time

  Every REST API will have validations to ensure data integrity is maintained.

• Retrieve data for custom pages or external systems

  Retrieving child records across multiple main records is a REST API limitation.

  REST limitation: