Get Available Personal Dynamic Entities
GET /obp/v7.0.0/personal-dynamic-entities/available
OBPv6.0.0-getAvailablePersonalDynamicEntities No role required Dynamic-EntityPersonal-Dynamic-EntityAPI
Get all Dynamic Entities that support personal data storage (hasPersonalEntity == true).
This endpoint allows regular users (without admin roles) to discover which dynamic entities they can interact with for storing personal data via the /my/ENTITY_NAME endpoints.
Authentication: User must be logged in (no special roles required).
Use case: Portals and apps can show users what personal data types are available without needing admin access to view all dynamic entity definitions.
For more information see here and here
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
Example success response
{
"dynamic_entities": [
{
"dynamic_entity_id": "abc-123-def",
"entity_name": "customer_preferences",
"user_id": "user-456",
"has_personal_entity": true,
"has_public_access": false,
"has_community_access": false,
"personal_requires_role": false,
"use_row_level_access": false,
"auth_mode": "UserOnly",
"schema": {
"description": "User preferences",
"required": [
"theme"
],
"properties": {
"theme": {
"type": "string"
},
"language": {
"type": "string"
}
}
},
"_links": {
"related": [
{
"rel": "personal-list",
"href": "/obp/dynamic-entity/my/customer_preferences",
"method": "GET"
},
{
"rel": "personal-create",
"href": "/obp/dynamic-entity/my/customer_preferences",
"method": "POST"
},
{
"rel": "personal-read",
"href": "/obp/dynamic-entity/my/customer_preferences/CUSTOMER_PREFERENCES_ID",
"method": "GET"
},
{
"rel": "personal-update",
"href": "/obp/dynamic-entity/my/customer_preferences/CUSTOMER_PREFERENCES_ID",
"method": "PUT"
},
{
"rel": "personal-delete",
"href": "/obp/dynamic-entity/my/customer_preferences/CUSTOMER_PREFERENCES_ID",
"method": "DELETE"
}
]
}
}
]
}Possible errors (2)
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.