Fields metadata update: Category display name

Two new properties were added to the Get all employee fields (metadata) endpoint to facilitate finding a field's category in Bob's UI. Nothing has changed in the existing properties.

The new properties are:

• categoryDisplayName: How the category appears in Bob's UI. Use this property to identify the category when setting permissions to the service user. To learn more, see Permissions.
• categoryId: The backend-id of the category (it is the same as the existing category property added for additional clarity). It can be either text-based (for out-of-the-box categories) or numeric. It does not represent how the category appears in Bob's UI.

Example

Consider the following metadata:

{
        "id": "root.firstName",
        "categoryId": "root",
        "categoryDisplayName": "Basic info",
        "category": "root",
        "name": "First name",
        "description": null,
        "jsonPath": "firstName",
        "type": "text",
        "typeData": {},
        "historical": false
    }

• The categoryId is root.
• However, the actual category name, as displayed in Bob’s U,I is Basic info, which is found in the categoryDisplayName property.

This means that even if the category ID suggests a different name, you should always reference categoryDisplayName to ensure consistency with what users see in the UI.