アプリのアクション設定を取得します。
同名のアクションがアプリに存在する場合は、この API を実行するとエラーが発生します。
URI
URI は、運用環境の設定を取得する場合と、テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/app/actions.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/actions.json
テスト環境の設定を取得する場合
https://(サブドメイン名).cybozu.com/k/v1/preview/app/actions.json
ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/actions.json
HTTPメソッド
GET
必要なアクセス権
アプリ管理権限
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリのIDを指定します。 |
lang | 文字列 |
「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
省略すると default が設定されます。 |
リクエストの例
URL パラメータで指定する場合
GET /k/v1/app/actions.json?app=8&lang=ja HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
リクエストボディで設定する場合
ヘッダ
GET /k/v1/app/actions.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
ボディ
レスポンスパラメータ
パラメータ名 | 値の種類 | 説明 |
---|---|---|
actions | オブジェクト | アクションの設定を表すオブジェクトです。 |
actions.(アクション名) | オブジェクト |
各アクションの設定を表すオブジェクトです。 lang を指定した場合でも、デフォルトの言語で設定されたアクション名が返ります。 |
actions.(アクション名).name | 文字列 | アクション名です。 lang を指定した場合は、「言語ごとの名称」で設定された値が返ります。 |
actions.(アクション名).id | 文字列 | アクションの ID です。 |
actions.(アクション名).index | 文字列 | アクションの並び順(0始まり)です。 |
actions.(アクション名).destApp | オブジェクト | コピー先のアプリの情報を表すオブジェクトです。 |
actions.(アクション名).destApp.app | 文字列 | コピー先のアプリのアプリ ID です。 |
actions.(アクション名).destApp.code | 文字列 | コピー先のアプリのアプリコードです。 アプリコードを設定していない場合は、空文字が返ります。 |
actions.(アクション名).mapping | 配列 | フィールドの関連付けを表す配列です。 関連付けが設定されていない場合は、空配列が返ります。 |
actions.(アクション名).mappings[].srcType | 文字列 |
コピー元の種類です。
|
actions.(アクション名).mappings[].srcField | 文字列 |
コピー元に指定されたフィールドのフィールドコードです。 actions.(アクション名).mappings[].srcType が FIELD の場合のみ返却されます。 |
actions.(アクション名).mappings[].destField | 文字列 |
コピー先に指定されたフィールドのフィールドコードです。 |
actions.(アクション名).entities | 配列 |
アクションの利用者を表す配列です。 |
actions.(アクション名).entities[].type | 文字列 |
アクションの利用者の種類です。
|
actions.(アクション名).entities[].code | 文字列 |
アクションの利用者のコードです。 |
revision | 文字列 | アプリの設定のリビジョン番号です。 |
レスポンスの例
JavaScript サンプル
kintone REST API リクエストを送信する APIを使ったリクエスト
XMLHttpRequest
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。