REST API File API
last update 2015-3-26

File API Reference

About File API

File API reference

SSL is used for all access to File API. The domain is https://api-datastore.appiaries.com

The relative path prefix v1 indicates the version number.

The object registered with fileAPI consists of the meta-information section (click here for information about each field) registered with the JSON Object and the binary of the file etc.

When using the access token, please specify one of the following two patterns.

  • In the header, specify: “X-APPIARIES-TOKEN: <access token>”
  • In the query, specify: access_token=<access token>

File API a list of features

fileAPI a list of features HTTP method API Path
Register a Binary Object POST /v1/bin/{datastore ID}/{app ID}/{collection ID}/
Replace a replacement Binary Object PUT /v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}
Update a Binary Object PATCH or POST /v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}

/v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}/{field name}
Deleting a Binary Object DELETE or POST /v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}
/v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}/{field name}
Search for a Binary Object(meta-information section) GET /v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}
/v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}/{field name}
/v1/bin/{datastore ID}/{app ID}/{collection ID}/{sample range}{search criteria}
Search for a Binary Object(binary) GET /v1/bin/{datastore ID}/{app ID}/{collection ID}/{object ID}/_bin

Object meta-information section field

Field name Details
_id object ID
_type content type of files
_filename file name
_tags tag( You can set freely )array
_uri binary URI used for acquisition
_length binary Data