REST API JSON Data API
last update 2015-4-9

Search for a JSON Object

Search for a JSON Object

English version is coming soon!! (Yes, we are working on it!)

Search for a JSON Object

Method

Method uses GET.

Endpoint

  • Search using a specific objectID

/v1/dat/{datastore ID}/{app ID}/{collection ID}/{object ID}

  • Search for an object by specifying the search parameters

/v1/dat/{datastore ID}/{app ID}/{collection ID}/<start>-<end>;<search criteria>;(*)?<query parameter>

※※取得開始位置、取得終了位置の数値は省略可能ですが、間の-(ハイフン)は省略できません。
(*)~検索条件はマトリクスパラメーター形式;(セミコロン区切り)で複数条件指定可能です。For search parameters, please see here.

Request format

Request header

X-APPIARIES-TOKEN Specify access token(*1)

Query

Query name Value Notes
access_token access token(*1)
proc get or count The default value is get. Count is special; the number of objects returned in the search results can be obtained.
sel You can use multiple comma-separated descriptors in the object fieldname The acquisition target field
excpt You can use multiple comma-separated descriptors in the object fieldname The acquisition exception field
order You can use multiple comma-separated descriptors in the object fieldname The sort key field
oonly true or false(the default is false) If true, only objects will be taken from the search results.

Response format

Response header

Content-Type application/json

HTTP response code

HTTP response code Details
200 Success
400 Search parameters invalid縲《earch criteria invalid縲ヾpecify both acquisition targets and acquisition exceptions縲ヾort Key invalid縲€etc
401 Token unspecified, Authentication failure
403 No permission to access the app.(No permission to create in the collection.The object that can be stored in the collection is not “JSON data”)
404 Collection not created
500 Unexpected error

Response content

The response body, in addition to search results information, also gives information about whether the results exist in a list of acquired JSONdata objects and total number of objects returned etc.

The table below describes all fields except object list.

Field name Details
_total total number of objects returned
_objs a list of acquired objects, array
_start the position of the first of the returned objects when viewed from total number
_end the position of the last of the returned objects when viewed from total number
_prev are there any objects before the returned objects?
_next are there any objects after the returned objects?

ex 1)Specify objectID and acquire

ex 2)Acquire a list of object(parameters specified, acquisition field specified)

The target JSON Object is shown in the image below.

ex 3)Object number is displayed

The response in this case resembles the following:

ex 4)Specifying the starting number and ending number