OS1 Services
...
Entity
How to use Entities?

How to: Retrieve Entity

2min

Overview

For information about prerequisites, see How to use Entities?.

To retrieve the list of all the existing Entities, call the Get all Entities endpoint. If you want to retrieve details of a particular Entity by specifying the entityId, call the Get Entity endpoint.

Eventual Consistency in GET List APIs

Our GET List APIs employ an eventual consistency model, which means that there may be a slight delay between the time an object is updated and when the changes are reflected in the API responses. This delay is typically 1 second. Refer to the AWS Consistency Model guide for more details. We recommend the following guidelines when using the GET list APIs:

  • Getting Updated Objects Immediately: If your application requires immediate access to the updated object, we recommend using the object returned in the callback of the update operation. The callback object represents the most recent state of the object and can be used without waiting for the eventual consistency to take effect.
  • Handling Eventual Consistency with GET Requests: When making GET requests to retrieve objects from the API, it's important to consider the eventual consistency model. To ensure that your application obtains the most up-to-date data, we recommend implementing a retry mechanism.



Updated 09 May 2024
Did this page help you?
PREVIOUS
How to: Create the Entity
NEXT
How to: Update Entity
Docs powered by Archbee