[Relationship Field] : Expose REST Endpoint that returns fields that meet specific criteria

[jcastro-dotcms]

Parent Issue

• Implement Advanced Relationship Field  #30495

User Story

As a dotCMS developer, I want to be able to retrieve Fields from a Content Type that meet a specific list of criteria, so I can display the appropriate fields in the UI for Content Authors to deal with them. Such criteria can be related to can be, but not restricted to:

• Required
• User Searchable
• System Indexed
• Show in List
• Unique

Acceptance Criteria

For this particular case, we need to be able to return all fields from a Content Type that are flagged as User Searchable.

However, in order to make this more generic, the new method in the REST Endpoint allows you to filter -- for the time being -- for fields that match the current 5 common attributes in a Field:

• Required.
• User Searchable.
• System Indexed.
• Show in List.
• Unique.

So, a GET request to the Endpoint looking for fields in a given Content Type with all of those options checked would look like this:

{{serverURL}}/api/v3/contenttype/{{typeIdOrInode}}/fields/allfields?filter=REQUIRED&filter=USER_SEARCHABLE&filter=SYSTEM_INDEXED&filter=SHOW_IN_LIST&filter=UNIQUE

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

[github-actions]

PRs:

• feat(Edit Mode) #30796 [Relationship Field] : Expose REST Endpoint that returns fields that meet specific criteria #30845

[nicobytes]

QA Notes:

I’ve created a content type with fields using the options to filter.

My tests:

REQUIRED: 3 fields ✅

USER_SEARCHABLE: 2 fields ✅

SYSTEM_INDEXED: 7 fields ✅

SHOW_IN_LIST: 2 fields ✅

UNIQUE: 1 fields ✅

As a suggestion, each field should have a fieldType attribute.