Create Entity Types and Entities

In Mentor service, entity types refer to the properties of sessions or mentors. The labels assigned to entity types appear as fields on the profile and session creation pages of the application.

The types of fields are as follows:

• Text fields: Users can add single or multiple lines of text.

• Select fields: Contains a range of options for user to choose from. These are of two types:

  • Single-select fields: Users are allowed to select only one option.

  • Multi-select fields: Users can select multiple options.

For entity types containing a fixed range of options, each option is known as an entity. The labels assigned to entities appear as options in the single-select or multi-select fields of session or profile creation pages.

For example:

• For a session entity type such as Category, the entities include Communication and Life Skills.

• For a session entity type such as Language, the entities include English and Hindi.

tip

For a given entity type, each organization can define a set of domain-specific entities.

For example, for an entity type such as Role, the entities defined in the educational domain would include teacher and headmaster. Whereas, the entities defined in the healthcare domain would include physician and specialist.

Create and Manage Entity Types

API Reference	Description
Organization Administrator Login	To carry out administrative functions in the back end such as creating entity types, organization administrators must do the following: After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more. Using APIs, log in to generate an access_token.
Create Entity Types	System administrators or organization administrators can create new entity types to achieve the following: Define domain-specific properties for sessions or mentors. Add new text fields, and single-select or multi-select fields on the profile or session creation pages. Set new default rules for entity types containing a fixed range of entities. note Only system administrators can set the entity type as searchable and filterable on the application.
Get Entity Types	To update or delete entity types, system administrators or organization administrators can obtain the details of entity types such as the ID and value.
Update Entity Types	System administrators or organization administrators can modify the existing entity types as per the organization's requirements. note The entity types updated by an organization administrator apply only to their specific organization.
Delete Entity Types	System administrators or organization administrators can delete entity types that are no longer needed. note The entity types deleted by an organization administrator are applicable only to their specific organization.

Create and Manage Entities

API Reference	Description
Organization Administrator Login	To carry out administrative functions in the back end such as creating entities, organization administrators must do the following: After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more. Using APIs, log in to generate an access_token.
Create Entities	System administrators or organization administrators can create new entities to achieve the following: Define new domain-specific entities and map them to an entity type. Add new options to the single-select or multi-select fields of session or profile creation pages.
Get Entities	To update or delete entities, system administrators or organization administrators can obtain the details of entities such as ID and value.
Update Entities	System administrators or organization administrators can modify the existing entities as per the organization's requirements. note The entities updated by an organization administrator apply only to their specific organization.
Delete Entities	System administrators or organization administrators can delete entities that are no longer needed. note The entities deleted by an organization administrator are applicable only to their specific organization.