last update 2015-3-26

Register a Binary Object

Register a Binary Object
English version is coming soon!! (Yes, we are working on it!)

Register a Binary Object

Requesr format

Method uses POST

API path

/v1/bin/{datastore ID}/{app ID}/{collection ID}

Request header

Content-Type multipart/form-data
X-APPIARIES-TOKEN Specify access token(*1)


Query name Value Notes
access_token access token(*1)
proc create Optional
get true
Optional. The default value is false.

Request content

Parameter name Value Notes
_id object ID Option. The default is a random character string
_type content type of files
_filename file name
_tags tag バイナリファイルにひもづけるタグ情報。カンマ区切りで指定する。
_file file

(*1) ~ Specify using any method

Response format

Response header

Content-Type application/json
Location URL for retrieving the registered object

HTTP response code

HTTP response code Details
201 success
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
409 object already registered
413 object size exceeds limit
422 content invalid
500 unexpected error
507 available storage capacity exceeded

Response content

When HTTP response code is 409,422, content body is returned in JSON format as shown below:

List of Error Code

Error Code Value Classification Details
0070001 Whole fields insufficient fields
0070002 Whole fields field name invalid
0070101 object ID null, null character
0070102 object ID not a character string
0070104 object ID Not URI format
0070109 object ID objectID already in use
0070201 file null, size is 0
0070202 file not binary
0070301 file name null, null character
0070302 file name not a character string
0070303 file name control characters except LF, CR and TAB are included
0070401 content type null, null character
0070402 content type not a character string
0070403 content type Control characters except LF, CR and TAB are included
0071001 tag null, null character
0071002 tag not an array
0071005 tag array is null
0071006 tag array is not a character string
0071007 tag 配列の要素数が10以上。

Example) curl command