Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
example-queryNodes
example-queryNodes
Examples
    • Find webpages in the Travel Demo which were last modified before or on June 3, 2015: 

Code Pro
languagebash
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?mgnl:lastModified\[lte\]=2015-06-03' \
-u superuser:superuser

(The brackets have been escaped with the backslash character ( \ ) for the command to work correctly in bash.)

Expand
titleClick to see the resulting JSON
Code Pro
languagejs
linenumberstrue
{
  "results": [{
    "@name": "meta",
    "@path": "/travel/meta",
    "@id": "7ebd74f1-c6f7-4307-9953-afd549118a56",
    "@nodeType": "mgnl:page",
    "jcr:createdBy": "admin",
    "hideInNav": "true",
    "mgnl:template": "travel-demo:pages/standard",
    "mgnl:lastActivatedBy": "superuser",
    "jcr:created": "2018-03-09T13:47:38.468+01:00",
    "mgnl:lastActivated": "2018-03-09T13:47:50.329+01:00",
    "mgnl:created": "2015-02-02T20:58:23.939+01:00",
    "mgnl:createdBy": "superuser",
    "title": "Container for meta pages",
    "mgnl:lastModified": "2015-06-03T20:37:49.283+02:00",
    "mgnl:activationStatus": "true",
    "mgnl:lastModifiedBy": "superuser",
    "@nodes": []
  }]
}

The result is returned for the following configuration:

Code Block
languageyaml
class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
params:
  website:
    rootPath: /
    nodeTypes:
      - mgnl:page
Info

Please note that the logic of the "equal" filtering operation before the release of REST 2.1 was slightly different. In order to obtain the above response you would have to send the following request:

Code Pro
curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?mgnl:lastModified\[lte\]=2015-06-04' \
 -u superuser:superuser

(

Jira
serverMagnolia - Issue tracker
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId500b06a6-e204-3125-b989-2d75b973d05f
keyMGNLREST-170
)

    • Find webpages whose title is either Customer Experience Agent or Customer Experience Supervisor. This can be done in two ways:

      Code Pro
      curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?title=Customer%20Experience%20Agent|Customer%20Experience%20Supervisor' \
      -u superuser:superuser
      Code Pro
      curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?title\[like\]=Customer%20Experience%20%25' \
      -u superuser:superuser

      (The brackets have been escaped with the backslash character ( \ ) for the command to work correctly in bash.)

      Expand
      titleClick to see the resulting JSON
      Code Pro
      languagejs
      linenumberstrue
      {
        "results": [
          {
            "@name": "customer-experience-agent",
            "@path": "/travel/about/careers/customer-experience-agent",
            "@id": "1f8af166-258f-4351-a543-3d0fc8bb00c0",
            "@nodeType": "mgnl:page",
            "hideInNav": "false",
            "title": "Customer Experience Agent",
            "title_de": "Kundenerlebnisvermittler",
            "@nodes": []
          },
          {
            "@name": "customer-experience-supervisor",
            "@path": "/travel/about/careers/customer-experience-supervisor",
            "@id": "c8e6902a-499a-44d7-9de9-45fd93d60a6b",
            "@nodeType": "mgnl:page",
            "hideInNav": "false",
            "title": "Customer Experience Supervisor",
            "title_de": "Kundenerlebnisteamleiter",
            "@nodes": []
          }
        ]
      }

      The result is returned for the following configuration:

      Code Block
      languageyaml
      class: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpointDefinition
      params:
        website:
          rootPath: /
          includeSystemProperties: false
          nodeTypes:
            - mgnl:page
      Info

      Due to the use of a wildcard character (%, URL encoded as %25) in the URL with the [like] filter the number of results can be potentially higher. For example, if the website contained also a page called Customer Experience Manager, it would be also returned in the response.

    • Find nodes in the tours workspace which contain the keyword beach. Return the results in the descending order by the location property and restrict the number of results to three:

      Code Pro
      curl -X GET 'http://localhost:8080/magnoliaAuthor/.rest/delivery/trips/v1?q=beach&orderBy=location%20desc&limit=3' \
      -u superuser:superuser
      Expand
      titleClick to see the resulting JSON
      Code Pro
      languagejs
      linenumberstrue
      {
        "results": [
          {
            "@name": "Beach-Paradise-in-Brazil",
            "@path": "/magnolia-travels/Beach-Paradise-in-Brazil",
            "@id": "545d5815-a3dd-4b68-a539-c38eb1bba29b",
            "@nodeType": "mgnl:content",
            "isFeatured": "true",
            "name": "Beach Paradise in Brazil",
            "description": "An Amazonian beach holiday",
            "location": "São Luís, Brasil",
            "tourTypes": [
              "082c340c-b062-4b15-86b8-96dd9deff680"
            ],
            "author": "Magnolia Travels",
            "body_de": "<p>Wenn Sie &bdquo;Amazonas&ldquo; h&ouml;ren, denken Sie wahrscheinlich an einen tiefen Dschungel. Nun, dieses bemerkenswert gut versteckte Strandparadies liegt mitten drin. Alter do Ch&atilde;o liegt am Rio Tapaj&oacute;s, einem Nebenfluss des m&auml;chtigen Amazonas, der so breit ist, dass Sie nicht einmal das gegen&uuml;berliegende Ufer sehen k&ouml;nnen. Es gibt viel Natur in der Umgebung, die zu Fu&szlig; erkundet werden kann; die Bucht am See ist voller gem&uuml;tlicher Strandrestaurants und Bars, ideal f&uuml;r ein Chill-out nach dem Schwimmen. &nbsp;</p>\n<p>Keine Angst vor Krokodilen hier, aber es gibt einige Stachelrochen, auf die man aufpassen sollte.&nbsp; Sie beginnen Ihr Abenteuer auf der zweit&auml;gigen Bootsfahrt von Manaus (Hauptstadt des Amazonas) nach Santar&eacute;m, aber achten Sie darauf, Ihre eigene H&auml;ngematte (und etwas Seil) oder einfach nur etwas Extra-Kleingeld f&uuml;r die Bar mitzubringen!</p>\n<p>W&auml;hrend Sie dort sind, werden Sie feststellen, dass es viel mehr zu tun gibt, als an den herrlichen Str&auml;nden herumzuh&auml;ngen. Die Stadt liegt am Eingang zur Lagune Lago Verde, Heimat vieler Tiere Amazoniens und der perfekte Ort f&uuml;r eine Kanufahrt. Wir unternehmen auch Touren in die sch&ouml;ne Floresta Nacional do Rio Tapaj&oacute;s und Rio Arapiuns.</p> ",
            "body": "<p>When you hear &ldquo;Amazon&rdquo;, you probably think of a deep jungle. Well, this remarkably well hidden beach paradise is right in the middle of it. &nbsp;Alter do Ch&atilde;o lies on Rio Tapaj&oacute;s, a tributary to the mighty Amazon, which is so wide here that you can&rsquo;t even see across to the far shore. &nbsp;There&rsquo;s plenty of nature to explore in the area on foot, but the inlet to the lake is also covered with cosy beach restaurants and bars, perfect for a post swim chill out. &nbsp;</p>\n<p>No fear of crocodiles here, but there are some sting rays to watch out for. &nbsp;You&rsquo;ll start your adventure on the two-day boat ride from Manaus (capital of the Amazon) to Santar&eacute;m, but be sure to bring your own hammock (and some rope) or just some extra coins for the bar!</p>\n<p>While you&rsquo;re here, you&rsquo;ll discover there&rsquo;s much more to do than hanging out at the glorious beaches. The town lies at the entrance to the Lago Verde lagoon, home to many Amazon animals, and the perfect place to do a canoe trip. We also include tours to the beautiful Floresta Nacional do Tapaj&oacute;s and Rio Arapiuns.</p> ",
            "description_de": "Ein Amazonas-Strandurlaub",
            "destination": [
              "bed2e297-199c-4dc8-90cd-54ad3cb4221b"
            ],
            "duration": "14",
            "name_de": "Strand Paradies in Brasilien",
            "image": "jcr:950cc73c-1b12-4f2a-bba7-97ad9d171f5d",
            "@nodes": []
          },
          {
            "@name": "West-Coast---Highway-101",
            "@path": "/magnolia-travels/West-Coast---Highway-101",
            "@id": "730c8850-d638-4e91-b3fb-4041a0c59ffe",
            "@nodeType": "mgnl:content",
            "body_de": "<p>Stellen Sie sich vor, dass Sie auf den Spuren der Forscher, Missionare und Soldaten unterwegs sind, die Amerika zu dem gemacht haben, was es heute ist. Entdecken Sie den ber&uuml;hmten Camino Real (Die k&ouml;nigliche Stra&szlig;e), der auf dem alten Weg beruht, der die spanischen Missionen, Pueblos und Milit&auml;rposten miteinander verband.</p>\n<p>Wir starten in Seattle und gehen s&uuml;dw&auml;rts nach Oregon und schlie&szlig;lich nach Kalifornien, wo wir auf die Str&auml;nde des Highway 1 treffen. Die Reise wird von Geschichte und traumhafter durchdrungen sein, aber es wird auch jede Menge Zeit f&uuml;r Spa&szlig; geben, mit einigen tollen Strandaktivit&auml;ten am Ende der Reise.</p>\n<p>&nbsp;</p> ",
            "body": "<p>Imagine walking in the footsteps of the explorers, missionaries, and soldiers who made America what it is today. Discover the famous El Camino Real (The Royal Road) based on the old trail which linked the Spanish Missions, Pueblos and Presidios.</p>\n<p>We&#39;ll kick off in Seattle and head south into Oregon and finally to California where we&#39;ll hit the beaches on California Highway 1. The trip will be infused with history and fabulous scenery, but there&rsquo;ll be lots of time for fun, with some great beach activities at the end of the trip.</p> ",
            "description_de": "Familienreisen in den USA",
            "name": "West Coast - Highway 101",
            "description": "Family travels in USA",
            "destination": [
              "ed3dcd18-78af-46df-a9e1-bc732479f2e7"
            ],
            "location": "Seattle, USA",
            "tourTypes": [
              "17da160b-da66-4e09-9e31-5fd040880f4a"
            ],
            "author": "Magnolia Travels",
            "duration": "7",
            "name_de": "Westküste - Highway 101",
            "image": "jcr:d44f783c-91ca-4b48-9533-ea4e147e13e9",
            "@nodes": []
          },
          {
            "@name": "Dubai-and-Oman",
            "@path": "/magnolia-travels/Dubai-and-Oman",
            "@id": "5007ccb4-0332-4a20-aef7-bf8155ab9340",
            "@nodeType": "mgnl:content",
            "body_de": "<p>Diese einzigartige Reise bringt Ihnen einige wirkliche Einblicke in das Leben auf der arabischen Halbinsel, gibt Ihnen aber auch genug Zeit, die Sonne zu genie&szlig;en. Sie beginnen Ihre Reise im altert&uuml;mlichen Oman, wo das Leben fast genauso seinen Gang geht wie schon viele Jahrhunderte zuvor. Sie besuchen den faszinierenden Souk von Maskat, um dort um handgefertigtes Silberzeug und T&ouml;pfe zu feilschen. Danach k&ouml;nnen Sie einen Spaziergang entlang des belebten Hafens unternehmen und einige der verwinkelten Gassen der Stadt besuchen. Runden Sie den Tag ab und entspannen Sie sich in einem Liegestuhl im Grand Hyatt, von dem aus Sie Blick auf den Strand von Oman haben.</p>\n<p>In Dubai besuchen wir einige der Wunder der Stadt wie Burj al Khalifa, das h&ouml;chste Geb&auml;ude der Welt, und den Dubai Mall, das gr&ouml;&szlig;te Einkaufszentrum Welt mit seinem herrlichen Aquarium. Aber nach all dem Sightseeing gibt es nichts Besseres als Entspannung am Strand des luxuri&ouml;sen Atlantis Hotel auf der Palm Jumeirah, eine vom Menschenhand geschaffene Insel in Form einer Palme. Magnolia Travels wird daf&uuml;r sorgen, das dies ein Urlaub ist, den Sie nie vergessen werden!</p> ",
            "body": "<p>This unique trip will give you some real insights into life in the Arabian Peninsula, while also allowing you plenty of time to soak up the sun. You&rsquo;ll start your trip in ancient Oman, where life still goes on much the way it did centuries ago. You&rsquo;ll be able to visit Muscat&rsquo;s fascinating souk to haggle for some handmade silver and pots. Then you can take a stroll along the lively harbour and visit some of the city&rsquo;s winding lanes. Round out the day relaxing on a beach chair at the Grand Hyatt, overlooking the Beach of Oman.</p>\n<p>In Dubai, we&rsquo;ll visit some of the city&rsquo;s wonders, like Burj al Khalifa, the tallest building in the world, and Dubai Mall, the biggest shopping mall in the world, with its magnificent aquarium. But after all the sightseeing, there&rsquo;s nothing better than relaxing at the beach at the luxury Atlantis Hotel, located on the Palm Jumeirah, a man-made palm shaped island. Magnolia Travels will make sure this is a holiday you never forget!</p> ",
            "description_de": "Ein unvergessliches Erlebnis im Arabischen Golf",
            "name": "Dubai and Oman",
            "description": "An unforgettable experience in the Arabian Gulf",
            "destination": [
              "79da73f7-900b-4c91-b58b-3b1355485519"
            ],
            "location": "Muscat, Oman",
            "tourTypes": [
              "e007e401-1bf8-4658-8293-b9c743784264"
            ],
            "duration": "7",
            "author": "Magnolia Travels",
            "name_de": "Dubai und Oman",
            "image": "jcr:7eeb9a4f-72ef-43f4-a392-5c1916b31e3a",
            "@nodes": []
          }
        ]
      }

      The result is based on the basic configuration.

      Info

      Please be aware that in this example the endpoint prefix is called trips but the workspace mapped is called tours.

    • Find a tour whose description is Get photobombed by a Sea Turtle:

      Code Block
      curl -X GET \
      'http://localhost:8080/magnoliaAuthor/.rest/delivery/trips/v1?description=Get%20photobombed%20by%20a%20Sea%20Turtle' \
      -u superuser:superuser
      Expand
      titleClick to see the resulting JSON
      Code Pro
      languagejs
      linenumberstrue
      {
        "results": [
          {
            "@name": "Scuba-Diving-in-Bahamas--famed-Tiger-Beach",
            "@path": "/magnolia-travels/Scuba-Diving-in-Bahamas--famed-Tiger-Beach",
            "isFeatured": "true",
            "name": "Scuba Diving at Tiger Beach",
            "description": "Get photobombed by a Sea Turtle",
            "location": "Miami, USA",
            "tourTypes": [
              "d2245867-ecaa-4b4e-8743-e0c939be68b7",
              "eaf9a648-fae1-48ae-a293-69bed874f159"
            ],
            "author": "Magnolia Travels",
            "body_de": "<p>Unsere beliebteste aktive Tour f&uuml;hrt zum weltber&uuml;hmten Tiger Beach in den Gew&auml;ssern vor den Bahamas. Dieser spektakul&auml;re Ort ist einmalig in der Welt. Magnolia Travels garantiert Ihnen eine der einzigstartigen Unterwasser-Erfahrungen &uuml;berhaupt. Umgeben vom kristallblauen Wasser der Bahamas und perlwei&szlig;em Sand k&ouml;nnen Sie Ammenhaie, Riffhaie, Zitronenhaie und Tigerhaie beobachten. Bringen Sie Ihre Kamera mit, es gibt auf dieser Reise keinen Mangel an gro&szlig;artigen Foto- oder Videogelegenheiten. &nbsp;</p>\n<p>Auf dieser Expedition haben Sie Gelegenheit, mit unseren entz&uuml;ckenden und ber&uuml;hmten Tigerhai-&bdquo;Supermodels&ldquo; von Angesicht zu Angesicht zu tauchen:&nbsp; Emma, Baby Cakes, Tanya, Begonia und Mini-T. Unsere &bdquo;Supermodel&ldquo; werden Ihnen dabei helfen, einige der weltweit besten Hai-Fotos zu schie&szlig;en. Sie lieben es, f&uuml;r die Kamera zu l&auml;cheln!</p>\n<p>Nat&uuml;rlich w&auml;re keine Reise auf die Bahamas vollst&auml;ndig ohne Tauchen in den umwerfenden und vielfarbigen Riffen. Sie sind von einer F&uuml;lle kleiner und gro&szlig;er Meereslebewesen umgeben;&nbsp; Sch&ouml;nheit und Wunder dieses vibriendenden &Ouml;kosystems lassen Sie verstummen. Karibische Riffhaie, gro&szlig;e Zackenbarsche, Mur&auml;nenaale und viele andere Fische wetteifern um Ihre Aufmerksamkeit, w&auml;hrend Sie &uuml;ber vielf&auml;ltige Korallenarten, wellenf&ouml;rmige Seef&auml;cher und eine bunte Anordnung von Schw&auml;mmen gleiten. Beginnen Sie noch heute, mit uns Ihre Erinnerungen zu gestalten!</p> ",
            "body": "<p>Our most popular active tour is to the world-famous Tiger Beach in the waters off the Bahamas. This spectacular location is unlike any other in the world. Magnolia Travels guarantees you will have one of the most unique underwater experiences ever. &nbsp;Amidst the crystal blue Bahamian water and powder white sand, you will experience Nurse, Reef, Lemon and Tiger sharks up close and personal. &nbsp;Bring your camera, there is no shortage of great photo or video opportunities on this trip. &nbsp;</p>\n<p>On this expedition you will have the opportunity to dive face-to-face with our lovely and famous Tiger shark &ldquo;supermodels&rdquo;: &nbsp;Emma, Baby Cakes, Tanya, Begonia &amp; Mini-T. &nbsp;Our &ldquo;supermodels&rdquo; will help you produce some of the world&rsquo;s best shark photography. They love to smile for the camera!</p>\n<p>Of course, no trip to the Bahamas would be complete without diving the dazzling and colorful reefs. &nbsp;Surrounded by an abundance of marine life, both large and small, you will be in awe of the beauty and wonder of this vibrant ecosystem. &nbsp;Caribbean Reef sharks, large groupers, moray eels and numerous fish will compete for your attention as you hover above the multiple species of coral, undulating sea fans, and colorful array of sponges. &nbsp;Start making your memories with us today!</p> ",
            "description_de": "Lassen Sie sich von einer Meeresschildkröte überraschen, die plötzlich auf Ihrem Foto erscheint",
            "destination": [
              "ed3dcd18-78af-46df-a9e1-bc732479f2e7"
            ],
            "duration": "14",
            "name_de": "Tauchen am Tiger Beach",
            "image": "jcr:795449d2-6c16-402e-9e8a-bbb101fe22bb",
            "@nodes": []
          }
        ]
      }

      The result is based on the basic configuration.

      Info

      Please be aware that in this example the endpoint prefix is called trips but the workspace mapped is called tours.

In the website workspace, find all nodes for whom /travel/about/careers is the ancestor:

Code Block
curl -X GET \
'http://localhost:8080/magnoliaAuthor/.rest/delivery/website/v1?@ancestor=/travel/about/careers' \
 -u superuser:superuser

...

titleClick to see the resulting JSON
Code Pro
languagejs
linenumberstrue
{
  "results": [{
    "@name": "customer-experience-agent",
    "@path": "/travel/about/careers/customer-experience-agent",
    "@id": "1f8af166-258f-4351-a543-3d0fc8bb00c0",
    "@nodeType": "mgnl:page",
    "hideInNav": "false",
    "title": "Customer Experience Agent",
    "title_de": "Kundenerlebnisvermittler",
    "@nodes": []
  }, {
    "@name": "customer-experience-supervisor",
    "@path": "/travel/about/careers/customer-experience-supervisor",
    "@id": "c8e6902a-499a-44d7-9de9-45fd93d60a6b",
    "@nodeType": "mgnl:page",
    "hideInNav": "false",
    "title": "Customer Experience Supervisor",
    "title_de": "Kundenerlebnisteamleiter",
    "@nodes": []
  }, {
    "@name": "marketing-associate",
    "@path": "/travel/about/careers/marketing-associate",
    "@id": "f19c60f2-3049-4883-a170-4bf65e3abb91",
    "@nodeType": "mgnl:page",
    "hideInNav": "false",
    "title": "Marketing Associate",
    "title_de": "Marketingmitarbeiter/in",
    "@nodes": []
  }]
}

The result is returned for the following configuration:

...

languageyaml

Include Page
_REST delivery endpoint v1 filter examples
_REST delivery endpoint v1 filter examples

...

Anchor
configuration
configuration
Configuration

...