When do we use Entity or attribute while consuming API

When do we use Entity or attribute while consuming API in Vdesigner 2.0?

Hi @Anuj_Tiwari ,
An entity in vDesigner acts as a container for data that you retrieve or send through the API. Entities are used to hold structured data and help with organizing that data in a way that your application can process efficiently.

When to use Entities:

  • To define the structure of data that will be received from or sent to the API.
  • When you need to store or manage multiple pieces of related data. For example, when consuming an API that provides customer details or product data, you would create an entity to store this data in the correct format.

An attribute in vDesigner represents a specific piece of data within an entity. It corresponds to a key/value pair or property that defines a part of the entity’s data structure.

When to use Attributes:

  • To map specific values from the API response to individual variables or data points.
  • When you need to retrieve specific information from a larger data set or send individual pieces of data to the API.
  • For specific data points like customer name, email, or order ID that are part of a larger data structure.
8 Likes