You are here

Home » API reference » REST Export Nested 8

README.txt in REST Export Nested 8 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

This module extends core's REST Export views display to automatically convert
any JSON string field to JSON in the output. It works with Views Field View.

Theoretically it should work with any field which displays a JSON string without
 any surrounding HTML.

REQUIREMENTS
------------

This module requires:
- drupal:rest
- drupal:views


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. Visit
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
   for further information.


CONFIGURATION
-------------

1. Install module.
2. In your view, add a display of type "REST export nested"
3. Configure view.
When adding a Views Field View field, make sure the output of the field is set
to "REST export" or "REST export nested".

Example using Views Field View:

1. Install and enable Views Field View
2. Create view display of referenced content (e.g. Articles) of type
"REST export" or "REST export nested"
3. Add a relationship to the host entity and contextual filter of host entity ID
4. Create a view display "REST export nested" of parent entity type
5. Add required fields (e.g. "nid", "title")
6. Add a field of type "Views field", configure with the correct View and
display and pass "nid" as the contextual filter
7. Using another source of JSON

If your JSON is stored as field data or you're generating it another way, you
may need to adjust the row style options. In your "REST export nested" display,
edit your fields settings and select "Raw output" for the JSON field.

MAINTAINERS
-----------

Current maintainers:
 * Ian McLean (imclean) - https://www.drupal.org/u/imclean
 * Debora Antunes (dgaspara) - https://www.drupal.org/u/dgaspara

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. This module extends core's REST Export views display to automatically convert

  15. any JSON string field to JSON in the output. It works with Views Field View.

  16. 

  17. Theoretically it should work with any field which displays a JSON string without

  18.  any surrounding HTML.

  19. 

  20. REQUIREMENTS

  21. ------------

  22. 

  23. This module requires:

  24. - drupal:rest

  25. - drupal:views

  26. 

  27. 

  28. INSTALLATION

  29. ------------

  30. 

  31.  * Install as you would normally install a contributed Drupal module. Visit

  32.    https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules

  33.    for further information.

  34. 

  35. 

  36. CONFIGURATION

  37. -------------

  38. 

  39. 1. Install module.

  40. 2. In your view, add a display of type "REST export nested"

  41. 3. Configure view.

  42. When adding a Views Field View field, make sure the output of the field is set

  43. to "REST export" or "REST export nested".

  44. 

  45. Example using Views Field View:

  46. 

  47. 1. Install and enable Views Field View

  48. 2. Create view display of referenced content (e.g. Articles) of type

  49. "REST export" or "REST export nested"

  50. 3. Add a relationship to the host entity and contextual filter of host entity ID

  51. 4. Create a view display "REST export nested" of parent entity type

  52. 5. Add required fields (e.g. "nid", "title")

  53. 6. Add a field of type "Views field", configure with the correct View and

  54. display and pass "nid" as the contextual filter

  55. 7. Using another source of JSON

  56. 

  57. If your JSON is stored as field data or you're generating it another way, you

  58. may need to adjust the row style options. In your "REST export nested" display,

  59. edit your fields settings and select "Raw output" for the JSON field.

  60. 

  61. MAINTAINERS

  62. -----------

  63. 

  64. Current maintainers:

  65.  * Ian McLean (imclean) - https://www.drupal.org/u/imclean

  66.  * Debora Antunes (dgaspara) - https://www.drupal.org/u/dgaspara