6.1. API呼び出し¶

DELETE /1/(tenantId)/api/(apiName)/(subpath)¶

カスタムAPIを呼び出す。HTTPメソッドは API 定義によって異なる。

Request Headers:
	X-Application-Id -- アプリケーションID(必須) X-Application-Key -- アプリケーションキー(必須) Content-Type -- API定義による
Parameters:	apiName (string) -- API名 subpath (string) -- サブパス
Status Codes:	200 OK -- 正常にAPIを実行した 400 Bad Request -- パラメータ/リクエストボディ不正 401 Unauthorized -- 認証エラー 403 Forbidden -- 権限エラー 404 Not Found -- api や function が存在しない 500 Internal Server Error -- その他エラー 504 Gateway Timeout -- タイムアウトエラー

クエリパラメータ

API定義による。指定した場合はパラメータを JSON 化(パラメータ名をプロパティ名、値をプロパティの値とする)して後続のバックエンドシステム(Cloud Functionsなど)に引き渡す。 POST/PUTメソッドの場合は無視される。

リクエストボディ

API定義による。指定できるのは POST/PUT メソッドの場合のみ。

レスポンス

ステータスコード・レスポンスヘッダ・ボディいずれもAPI定義による。

注意事項