パラメータの指定方法

各APIの呼出し時にパラメータを指定する方法には以下の２通りございます。

<< Click to Display Table of Contents >>

Navigation:  API V3 マニュアル >

パラメータの指定方法

各APIの呼出し時にパラメータを指定する方法には以下の２通りございます。

1. RequestBodyにJson文字列を指定する方法（推奨）

•METHODをPOSTとし、Content-Typeをapplication/json; charset=utf-8として、RequestBodyにJson形式の文字列を指定する方式です。

•RequestBodyに指定できる文字数に制限はありませんので、ファイルパスが長くなった場合でも制限にかかることなく呼出しが可能な方式で、最も推奨されるやり方です。

POST http://<ホスト名>/fileblog/api/v3/files/list_folder
Authorization: Bearer <アクセストークン>
Content-Type: application/json; charset=utf-8
 
{
 path:"/"
}

2. "arg" URL　ParameterにURLEncodeされたJson文字列を指定する方法

•METHODをGETとして、"arg"という名前のUrlクエリ文字列に、UrlEncodeされたJson文字列（UTF8)を指定する方式です。

•HTTP Range Requestを送信したい（動画再生など）場合など、METHODとしてGETしか使えない場合に有効です。

•ただし、利用するHTTPクライアントの仕様によっては、URLの文字数上限を超える大きなサイズのパラメータを指定できない可能性があります。

GET http://<ホスト名>/fileblog/api/v3/files/list_folder?arg=%7B%0D%0A%09path%3A%22%2F%22%0D%0A%7D
Authorization: Bearer <アクセストークン>