On this page
Supported field types
Last updated on
3 October 2022
Supported:
- Block:
- with JSON:API Extras module. Use the provided field enhancer "Block field (Block field only) (Entity Share)" on both client and server websites. And in the config import enable the "Block field block content" plugin.
- Boolean
- Content (entity reference)
- Date:
- date only
- date and time
- Date range:
- date only
- date all day
- date and time
- File
- Image
- Link:
- internal:
- with JSON:API Extras module. Use the provided field enhancer "UUID for link (link field only) (Entity Share)" on both client and server websites. And in the config import enable the "Link internal content" plugin.
- external
- internal:
- List:
- float
- integer
- text
- Media:
- audio
- image
- file
- remote video
- video
- Metatags:
- with JSON:API Extras module. Use the provided field enhancer "Metatag (Metatag field only) (Entity Share)" on the server website, on the field (example: field_metatag) not on the "metatag" field.
- Number:
- decimal
- float
- integer
- Paragraphs
- Smart Date
- Date and time
- Individual recurrences of recurring dates (but not their rrules, see below)
- Taxonomy
- Telephone
- Text:
- plain
- plain, long
- formatted
- formatted, long
- formatted, long, with summary
- Timestamp
Not supported:
- Comment: See https://www.drupal.org/project/jsonapi_comment
- Dynamic entity reference: See #3056102: Support dynamic entity reference fields
- Smart Date Rule (the rrules of recurring dates)
Help improve this page
Page status: No known problems
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion