DataAPI SDK japanese MT.DataAPI Core method request

request

指定されたパラメータを用いて、エンドポイントにリクエストを送ります

パラメータ

パラメータ名	タイプ	必須	説明
method	String	*	リクエストメソッド
endpoint	String	*	エンドポイント
queryParameter	String | Object		クエリーパラメータ
requestData	String | Object | HTMLFormElement | FormData		リクエストデータ
requestData.{JSON文字列が期待されるキー}	String | Object | HTMLFormElement		JSON文字列が期待されるキーに対しては、「文字列」「Object」「HTMLFormElement」のいずれかの形式で値を渡すことができます。「Object」や「HTMLFormElement」が渡された場合には自動でシリアライズされます。
requestData.{ファイルが期待されるキー}	HTMLInputElement | File		ファイルが期待されるキーに対しては、「HTMLInputElement」か「Fileオブジェクト」を渡すことができます
callback	Function

戻り値

XMLHttpRequest | null: リクエストがXMLHttpRequestで送信された場合には、XMLHttpRequestオブジェクトが返されます。IFRAME など、XMLHttpRequest以外の方法で送信された場合には、nullが返されます。

例

var verb  = 'GET',
    route = '/sites/1/entries',
    query = {
      search: 'QUERY'
    };
api.request(verb, route, query, function(response) {
  // レスポンスデータを使った処理
});