Create System Level Dynamic Entity

Create a system level Dynamic Entity.

This v6.0.0 endpoint accepts and returns snake_case field names with an explicit entity_name field.

Request format:

{
  "entity_name": "customer_preferences",
  "has_personal_entity": true,
  "has_public_access": false,
  "has_community_access": false,
  "personal_requires_role": false,
  "use_row_level_access": false,
  "schema": {
    "description": "User preferences",
    "required": ["theme"],
    "properties": {
      "theme": {"type": "string", "minLength": 1, "maxLength": 20, "example": "dark", "description": "The UI theme preference", "indexed": true},
      "language": {"type": "string", "minLength": 2, "maxLength": 5, "example": "en", "description": "ISO language code"},
      "internal_note": {"type": "string", "example": "set by a privileged service", "description": "Field-level write-restricted (auto-generated per-field role)", "write_role_required": true},
      "audit_ref": {"type": "string", "example": "AUD-0001", "description": "Field-level write-restricted via an explicit, shareable role", "write_role": "CanWriteCustomerPreferencesAudit"},
      "ssn": {"type": "string", "example": "123-45-6789", "description": "Field-level read-restricted (auto-generated per-field role)", "read_role_required": true},
      "risk_score": {"type": "string", "example": "low", "description": "Field-level read-restricted via an explicit, shareable role", "read_role": "CanReadCustomerPreferencesRisk"}
    }
  }
}

Note:

• The entity_name must be lowercase with underscores (snake_case), e.g. customer_preferences. No uppercase letters or spaces allowed.
• Each property MUST include an example field with a valid example value.
• Each property can optionally include description (markdown text), and for string types: minLength and maxLength.
• Each property can optionally be marked queryable with "indexed": true — only indexed fields may be used in the list endpoint's filter/sort query parameters (and a reference:<Entity> field must be indexed to form a join edge). Add "index": "spatial" for a GeoJSON geometry index (only valid on a json field); the default when omitted is "index": "scalar" (B-tree).
• Each property can optionally declare field-level access control: write_role_required/read_role_required (booleans — auto-generate a per-field role) or write_role/read_role (name an explicit, shareable role). Write-restricted fields are not set via POST/PUT (their existing value is preserved) and are written only via the role-gated PATCH path; read-restricted fields are omitted from GET for callers lacking the read role. hide_field_from_public_access (boolean) hides a field of a public entity from callers whose access comes only from its public access, while callers holding the entity's read role still see it.
• Set has_public_access to true to generate read-only public endpoints (GET only, no authentication required) under /public/.
• Set auth_mode to say who may hold the roles that guard the entity's data endpoints: UserOnly (default, the User's Entitlements), ApplicationOnly (the Consumer's Scopes), UserOrApplication (either) or UserAndApplication (both). Personal (/my/) endpoints always require a User. An entity with has_personal_entity cannot be ApplicationOnly.
• Set has_community_access to true to generate read-only community endpoints (GET only, authentication required + CanGet role) under /community/. Community endpoints return ALL records (personal + non-personal from all users).
• Set personal_requires_role to true to require the corresponding role (e.g. CanCreateDynamicEntity_, CanGetDynamicEntity_) for /my/ personal entity endpoints. Default is false (any authenticated user can use /my/ endpoints).
• Set use_row_level_access to true to decide read, update, delete and grant per record with an access list, in place of the entity's Get, Update and Delete roles. The User who creates a record holds all four permissions on it and shares it with GET/PUT /obp/dynamic-entity/ENTITY_NAME/RECORD_ID/access (a body of user_id, can_read, can_update, can_delete, can_grant) and DELETE /obp/dynamic-entity/ENTITY_NAME/RECORD_ID/access/USER_ID; revoking cascades to the grants that user passed on. Records the caller may not read are omitted from list responses and return 404 individually. Creating a record still needs the entity's Create role, CanGrantDynamicEntityRowAccess_<Entity> administers the access list of any record, and field-level read and write roles still apply on top. It cannot be combined with has_public_access or has_community_access, and is only supported for locally-backed entities.

For more information see here and here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.

This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.

This endpoint supports User OR Application authentication. You can authenticate either as a logged-in User (with Entitlements) or as an Application using a Consumer Key (with Scopes). See here for more information.