Menu

Search results for JSON

This page is generated by Machine Translation from Japanese.

Search by the JSON response

Outputs a JSON results of Fess . You must in order to emit JSON enabled keep JSON response in the General Management screen crawl settings.

Request

To get JSON output http://localhost:8080/ |Fess| /JSON? query = search terms Of these sends a request. Request parameters are as follows.

query Search language. Pass the URL encoding.
Start The number of where to start. Starts at 0.
NUM The number of display. The default is 20. You can display up to 100.
fields.label The label value. Use to specify the label.
callback If you use the JSONP callback name. You do not need to specify if you do not use the JSONP.

Table: Request parameter

Responses to

Returns the following response.

{
    "response": {
        "version": 1,
        "status": 0,
        "query": " |Fess| ",
        "execTime": 0.59,
        "pageSize": 20,
        "pageNumber": 1,
        "recordCount": 101,
        "pageCount": 6,
        "result": [
            {
            "created":"2014-05-24T15:13:29.096+0900",
            "docId":"0592263c6cae4141b3a276894e8e326d",
            "title":" |Fess| \u3092\u5229\u7528\u3057\u3066\u3044\u308B\u30B5\u30A4\u30C8",
            "url":"http:\u002F\u002Ffess.codelibs.org\u002Fja\u002Fusers.html",
            "score":0.7036715,
            "site":"fess.codelibs.org\u002Fja\u002Fusers.html",
            "filetype_s":"html",
            "contentDescription":" <em>fess<\u002Fem> \u5168\u822C \u5165\u9580...",
            "digest":" |Fess| \u5168\u822C \u5165\u9580 \u30C9\u30AD\u30E5\u30E1\u30F3 Jav...",
            "host":"fess.codelibs.org",
            "mimetype":"text\u002Fhtml",
            "contentLength":22788,
            "boost":1.0,
            "lastModified":"2014-05-22T11:09:07.000+0900",
            "id":"http:\u002F\u002Ffess.codelibs.org\u002Fja\u002Fusers.html",
            "urlLink":"http:\u002F\u002Ffess.codelibs.org\u002Fja\u002Fusers.html"
            },
...
        ]
    }
}

Each element is as follows.

response The root element.
version Format version.
status The status of the response. the status value is 0: normal, 1: search error, 2 or 3: request parameter error, 9: in service, 1: API type of error is.
query Search language.
execTime Response time. Unit is seconds.
pageSize The number of display.
pageNumber Page number.
recordCount Number of hits for the search term.
pageCount Page number of the number of hits for the search term.
result Parent element of the search results.
site The name of the site.
contentDescription A description of the content.
host The name of the host.
lastModified Last update date.
cache The contents of the content.
score Score values of the document.
Digest Digest a string of documents.
created Document creation date.
URL The URL of the document.
ID The ID of the document.
mimetype The MIME type.
title The title of the document.
contentTitle The title of the document for viewing.
contentLength The size of the document.
urlLink The URL as the search results.

Table: Responses to information