Start a conversation

Custom Field Container Descriptor File Format

Each Container Entity that supports custom fields will have its own Descriptor file you can use to add the custom field to that Container Entity type.

This is a much simpler file to edit, since you are only specifying which custom fields to use.

The following properties are supported:

type

The Entity Type: This corresponds to the EntityType enum defined in the GraphQL schema, and can have one of these values:

Value Description
COMMUNITY Represents the Community entity type
CATEGORY Represents the Category entity type.
GROUP_HUB Represents the GroupHub entity type.
FORUM Represents the Forum entity type.
FORUM_TOPIC Represents the Forum Topic entity type.
FORUM_REPLY Represents the Forum Reply entity type.
BLOG Represents the Blog entity type.
BLOG_ARTICLE Represents the Blog Article entity type.
BLOG_REPLY Represents the Blog Article Reply entity type.
TKB Represents the Knowledge Base entity type.
TKB_ARTICLE Represents a Knowledge Base Article entity type.
TKB_REPLY Represents a Knowledge Base Article Reply entity type.
EVENT Represents the Event entity type.
EVENT_TOPIC Represents the Event Topic entity type.
EVENT_REPLY Represents the Event Topic Reply entity type.
IDEA Represents the Idea entity type.
IDEA_POST Represents the Idea Post entity type.
IDEA_REPLY Represents the Idea Reply entity type.
USER Represents the User entity type.
SALESFORCE_CASE Represents the Case entity type.

Example:

"type": "BLOG_ARTICLE"

customFieldNames

A string array of all the custom field names supported by this Container Entity.

Its possible values include any name of any custom field that has been defined in a .field.json file in the res/entities/fields directory. The default value is [] (an empty array).

Example:

"customFieldNames": [
    "streamingService",
    "lastWatchDate"
]
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. ATLAS

  2. Posted
  3. Updated

Comments