カテゴリー内の他の記事

アプリのアクション設定の変更

アプリのアクション設定を更新します。

このAPI は、テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、このAPI を実行した後に、アプリ設定の運用環境への反映 API を実行してください。

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/app/actions.json

ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/actions.json

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app 数値または文字列 必須 アプリのIDを指定します。
actions オブジェクト 必須

アクションの設定を表すオブジェクトです。

actions.(アクション名) オブジェクト  

各アクションの設定を表すオブジェクトです。

「(アクション名)」に更新前のアクション名を指定します。
存在しないアクション名を指定した場合は、新規のアクションとして追加します。

アクションを追加、更新するときは、既存のすべてのアクションを「(アクション名)」に指定する必要があります。指定しなかった場合はそのアクションが削除されます。

actions.(アクション名).name 文字列 条件必須

アクション名を1文字以上32文字以下で指定します。

アクション名を変更、または新規追加する場合は必須です。

アクション名を変更する場合は、変更後のアクション名を指定します。
新規追加する場合は、「(アクション名)」と同じ値を指定します。
省略した場合は更新しません。

actions.(アクション名).index 数値または文字列 条件必須

アクションの表示順を指定します。
指定した数字の昇順にアクションが並びます。

「(アクション名)」を指定する場合、必須です。

actions.(アクション名).destApp オブジェクト 条件必須

コピー先のアプリの情報を表すオブジェクトです。

新規追加する場合は必須です。
省略した場合は更新しません。

actions.(アクション名).destApp.app 数値または文字列 条件必須

コピー先のアプリのアプリ ID を指定します。

「actions.(アクション名).destApp.code」を指定しない場合は必須です。

actions.(アクション名).destApp.code 文字列 条件必須

コピー先のアプリのアプリコードを指定します。

「actions.(アクション名).destApp.app」を指定しない場合は必須です。
両方指定した場合は、code が優先されます。

null または空文字を指定した場合は、指定なしとみなされます。

actions.(アクション名).mappings 配列 条件必須

フィールドの関連付けを表す配列です。

アクションを新規追加または「actions.(アクション名).destApp」を指定している場合は必須です。
省略した場合は更新しません。

空配列を指定した場合は、フィールドの関連付けなしに設定されます。

actions.{アクション名}.mappings[].srcType 文字列 条件必須

コピー元の種類を指定します。
次の値を指定可能です。

  • FIELD:フィールド
  • RECORD_URL:レコードの URL

「actions.(アクション名).mappings」を指定する場合は必須です。

actions.(アクション名).mappings[].srcField 文字列 条件必須

コピー元のフィールドのフィールドコードを指定します。
「actions.(アクション名).mappings[].srcType」が FIELD の場合は必須です。

actions.(アクション名).mappings[].destField 文字列 条件必須

コピー先のフィールドのフィールドコードを指定します。

「actions.(アクション名).mappings」を指定する場合は必須です。

actions.(アクション名).entities 配列 条件必須

アクションの利用者を表す配列です。

アクションを新規追加する場合は必須です。
省略した場合は更新しません。

空配列を指定した場合は、アクションの利用者なしに設定されます。

actions.(アクション名).entities[].type 文字列 条件必須

アクションの利用者の種類を指定します。
次の値を指定可能です。

  • USER:ユーザー
  • GROUP:グループ
  • ORGANIZATION:組織
    ゲストスペースの場合は指定できません。

「actions.(アクション名).entities」を指定する場合は必須です。

actions.(アクション名).entities[].code 文字列 条件必須

アクションの利用者のコードを指定します。

ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。

「actions.(アクション名).entities」を指定する場合は必須です。

revision 数値または文字列  

アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、エラーになります。
指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

PUT /k/v1/preview/app/actions.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンスパラメータ

パラメータ名 値の種類 説明
actions オブジェクト アクションの情報を表すオブジェクトです。
actions.(アクション名).id 文字列 アクションの ID です。
revision 文字列 更新後のアプリの設定のリビジョン番号です。

レスポンスの例

JavaScript サンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。