Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

67 lines (45 sloc) 1.635 kb

Search Zotonic’s :term:`resources <resource>` using the :ref:`manual-datamodel-query-model`.

For instance, the API call:

http://localhost:8000/api/search?cat=text&text=test

Returns a JSON list of all resource ids of the :ref:`category <manual-datamodel-categories>` text that contain the string test:

[320]

Adding &format=simple to the API call gives us a list of JSON objects:

[
  {
      "category": [
          "text"
      ],
      "id": 338,
      "preview_url": "http://example.dev:8000/image/2014/10/8/image_2014_09_09_19_19_41.png%28800x800%29%28upscale%29%28CF8AD1D93AC1B8457F9AD6B9BA64C74F%29.jpg",
      "summary": {
          "trans": {
              "en": "English summary",
              "es": "Spanish summary"
          }
      },
      "title": {
          "trans": {
              "en": "English",
              "es": "Hola hola Espanol"
          }
      }
  }
]

Parameters

You can enter all parameters that are in the standard :ref:`manual-datamodel-query-model`.

Besides, the following parameters exist:

limit

The number of results to return. Defaults to 20; maximum number to return per call is 1000. To return more, do multiple requests with the offset parameter.

offset

Start offset for the result set.

format

Either ids to return a plain array of rsc ids; or simple to return a list of JSON objects with the resource's title, summary, category, and preview_url (the first image).
Jump to Line
Something went wrong with that request. Please try again.