レコードのアクセス権の設定を取得する

固定リンクがコピーされました

レコードのアクセス権の設定を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/record/acl.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/record/acl.json
URL（動作テスト環境）	https://sample.cybozu.com/k/v1/preview/record/acl.json
URL（動作テスト環境のゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/record/acl.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID
lang	文字列	省略可	取得する名称の言語言語ごとの名称を設定している場合に指定します。言語ごとの名称 `ja`：日本語 `en`：英語 `zh`：中国語 `user`：APIを実行するユーザーが表示言語に設定している言語言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。ヘッダーあり：「Accept-Language」ヘッダーで指定した言語ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語ロケールの設定 `default`：デフォルト省略すると、デフォルトの名称を取得します。

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
rights	配列	アクセス権の設定の一覧設定の優先度が高いものから順に並びます。
rights[].filterCond	文字列	レコードの条件クエリ形式で表されます。クエリ形式の詳細は次のページを参照してください。クエリの書き方
rights[].entities	配列	アクセス権の設定対象の一覧設定の優先度が高いものから順に並びます。
rights[].entities[].entity	オブジェクト	アクセス権の設定の対象
rights[].entities[].entity.type	文字列	アクセス権の設定対象の種類 `USER`：ユーザー `GROUP`：グループ `ORGANIZATION`：組織 `FIELD_ENTITY`：「フォームのフィールドを追加」で指定したフィールド
rights[].entities[].entity.code	文字列	アクセス権の設定対象のコード `entity.type`の値によって異なります。「USER」の場合：ユーザーのログイン名「GROUP」の場合：グループコード「ORGANIZATION」の場合：組織コード「FIELD_ENTITY」の場合：「フォームのフィールドを追加」で指定したフィールドのフィールドコード
rights[].entities[].viewable	真偽値	レコードの閲覧が可能かどうか `true`：閲覧できる `false`：閲覧できない
rights[].entities[].editable	真偽値	レコードの編集が可能かどうか `true`：編集できる `false`：編集できない
rights[].entities[].deletable	真偽値	レコードの削除が可能かどうか `true`：削除できる `false`：削除できない
rights[].entities[].includeSubs	真偽値	設定を下位組織に継承するか `true`：継承する `false`：継承しない
revision	文字列	アプリの設定のリビジョン番号

必要なアクセス権

固定リンクがコピーされました

アプリ管理権限

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/record/acl.json?app=1&lang=ja

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/record/acl.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

1
2
3
4


{
  "app": "1",
  "lang": "ja"
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30


{
  "rights": [
    {
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "entities": [
        {
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "viewable": false,
          "editable": false,
          "deletable": false,
          "includeSubs": true
        },
        {
          "entity": {
            "type": "FIELD_ENTITY",
            "code": "更新者"
          },
          "viewable": true,
          "editable": true,
          "deletable": true,
          "includeSubs": false
        }
      ]
    }
  ],
  "revision": "2"
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5
6


const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

await kintone.api(kintone.api.url('/k/v1/record/acl.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6
7


curl -X GET 'https://sample.cybozu.com/k/v1/record/acl.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "lang": "ja"
  }'

kintone API

kintone APIドキュメント

レコードのアクセス権の設定を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル