APIにおけるアプリ操作
ここでは、アプリの説明と使い方について記載します。
アプリとは
アプリは、実現したい事を表す単位です。
DBやメールなど必要なオブジェクトを追加していき、「お問い合わせ管理」、「セミナー受付」のような実現したいアプリケーションを作成します。
※1アカウント内で作成できるアプリの上限数はこちらをご参照ください。
アプリの作成
/appsのAPIを使用し、アプリを作成します。
アプリを作成するには、「アプリの識別名」「アプリの表示名」をJSON形式のフォーマットにして送信してください。
- name(識別名)
APIで使用する他のアプリと識別する時の名称です。
アプリの検索、変更、削除やDBのAPIなどで使用します。
- displayName(表示名)
UIが実装された時に画面に表示される名称です。
アプリの検索
/apps/{appId} でGET メソッド使用すると作成されたアプリを取得できます。
これまで作成したアプリの一覧は、/apps で取得できます。
また、一覧取得時に /apps?ids={appId} や /apps?query={appName} or {appDispalyName} のようにアプリのIDや識別名、表示名を指定すると、
抽出条件に一致したアプリだけの一覧を取得できます。
アプリの変更
/apps/{appId} でPATCH メソッド使用すると、「アプリの識別名」や「アプリの表示名」を変更できます。
アプリの削除
/apps/{appId} でDELETE メソッドを使用すると、アプリを削除できます。
※アプリを削除するとアプリ配下の全てのオブジェクトも同時に削除されます。