Skip to content

ノートブック

ノートブックは、SQL・チャート・テキストなどをまとめて共同編集できるデータ分析のドキュメントです。

イベント一覧

イベントリソース説明
notebook.createnotebookノートブックが作成された
notebook.duplicatenotebookノートブックが複製された
notebook.restorenotebookノートブックが過去のバージョンから復元された
notebook.renamenotebookノートブック名が変更された
notebook.editnotebookノートブックが編集された
notebook.movenotebookノートブックが移動された
notebook.opennotebookノートブックが開かれた
notebook.add_share_permissionnotebookノートブックの追加権限が付与された
notebook.change_share_permissionnotebookノートブックの追加権限のロールが変更された
notebook.remove_share_permissionnotebookノートブックの追加権限が削除された
notebook.deletenotebookノートブックが削除された

イベント詳細

notebook.create プレビュー

記録期間: 2026-09-15 〜

ノートブックの作成を記録します。

フィールド
event.codenotebook.create
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
changenotebook_folder_path
grant(なし)
extra(なし)

change

名前モード必須説明
notebook_folder_pathReference[]任意配置先の親フォルダ階層です。
並びは notebook_folder_path を参照してください。

サンプル

json
{
  "event": {
    "code": "notebook.create",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "notebook_folder_path",
        "new": [
          {
            "type": "notebook_folder",
            "uid": "WORKSPACE",
            "name": "Workspace"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

notebook.duplicate プレビュー

記録期間: 2026-09-15 〜

ノートブックの複製を記録します。過去のバージョンから新しいノートブックを作成した場合も、このイベントになります。

フィールド
event.codenotebook.duplicate
scope.typeworkspace
resource.typenotebook
references複製元のノートブック
query(なし)
outbound(なし)
changenotebook_folder_path
grant(なし)
extra(なし)

references

複製元のノートブックの識別子と表示名が入ります。 過去のバージョンから新しいノートブックを作成したときは、使ったバージョンも入ります。

relationtype必須説明
sourcenotebook必須ノートブック
sourcenotebook_version任意ノートブックのバージョン

change

名前モード必須説明
notebook_folder_pathReference[]任意配置先の親フォルダ階層です。
並びは notebook_folder_path を参照してください。

サンプル

ノートブックを複製する
json
{
  "event": {
    "code": "notebook.duplicate",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf9",
    "name": "Sales KPI (copy)",
    "path": "notebook/63e1be654aa70ad689601bf9",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf9",
        "name": "Sales KPI (copy)"
      }
    ],
    ...
  },
  "references": [
    {
      "type": "notebook",
      "uid": "63e1be654aa70ad689601bf3",
      "name": "Sales KPI",
      "relation": "source"
    }
  ],
  "change": {
    "fields": [
      {
        "name": "notebook_folder_path",
        "new": [
          {
            "type": "notebook_folder",
            "uid": "WORKSPACE",
            "name": "Workspace"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}
過去のバージョンから新しいノートブックを作成する
json
{
  "event": {
    "code": "notebook.duplicate",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf9",
    "name": "Sales KPI restored",
    "path": "notebook/63e1be654aa70ad689601bf9",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf9",
        "name": "Sales KPI restored"
      }
    ],
    ...
  },
  "references": [
    {
      "type": "notebook",
      "uid": "63e1be654aa70ad689601bf3",
      "name": "Sales KPI",
      "relation": "source"
    },
    {
      "type": "notebook_version",
      "uid": "63e1be654aa70ad689601bf4",
      "name": "v1",
      "relation": "source"
    }
  ],
  "change": {
    "fields": [
      {
        "name": "notebook_folder_path",
        "new": [
          {
            "type": "notebook_folder",
            "uid": "WORKSPACE",
            "name": "Workspace"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

notebook.restore プレビュー

記録期間: 2026-09-15 〜

ノートブックの過去のバージョンからの復元を記録します。

フィールド
event.codenotebook.restore
scope.typeworkspace
resource.typenotebook
references復元元のノートブックのバージョン
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

references

復元に使ったノートブックバージョンが入ります。

relationtype必須説明
sourcenotebook_version必須ノートブックのバージョン

サンプル

json
{
  "event": {
    "code": "notebook.restore",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "references": [
    {
      "type": "notebook_version",
      "uid": "63e1be654aa70ad689601bf4",
      "name": "v1",
      "relation": "source"
    }
  ],
  ...
}

notebook.rename プレビュー

記録期間: 2026-09-15 〜

ノートブックの表示名の変更を記録します。

フィールド
event.codenotebook.rename
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
changename
grant(なし)
extra(なし)

change

名前モード必須説明
namestring必須変更前後の表示名
sensitivity: pii

サンプル

json
{
  "event": {
    "code": "notebook.rename",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "name",
        "old": "Old",
        "new": "Sales KPI"
      }
    ]
  },
  ...
}

notebook.edit プレビュー

記録期間: 2026-09-15 〜

ノートブックの編集を記録します。

フィールド
event.codenotebook.edit
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "notebook.edit",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  ...
}

notebook.move プレビュー

記録期間: 2026-09-15 〜

ノートブックの移動を記録します。

フィールド
event.codenotebook.move
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
changenotebook_folder_path
grant(なし)
extra(なし)

change

名前モード必須説明
notebook_folder_pathReference[]任意配置先の親フォルダ階層です。
並びは notebook_folder_path を参照してください。

サンプル

json
{
  "event": {
    "code": "notebook.move",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "notebook_folder_path",
        "old": [
          {
            "type": "notebook_folder",
            "uid": "WORKSPACE",
            "name": "Workspace"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bfc",
            "name": "Sales"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bfa",
            "name": "Reports"
          }
        ],
        "new": [
          {
            "type": "notebook_folder",
            "uid": "WORKSPACE",
            "name": "Workspace"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bfb",
            "name": "Archive"
          }
        ]
      }
    ]
  },
  ...
}

notebook.open プレビュー

記録期間: 2026-09-15 〜

ノートブックが開かれたことを記録します。

フィールド
event.codenotebook.open
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

json
{
  "event": {
    "code": "notebook.open",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  ...
}

notebook.add_share_permission プレビュー

記録期間: 2026-09-15 〜

ノートブックの追加権限の付与を記録します。

フィールド
event.codenotebook.add_share_permission
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
change(なし)
grant付与先と付与権限
extra(なし)

grant

追加権限が付与されたユーザーまたはグループと付与された権限が入ります。

サンプル

json
{
  "event": {
    "code": "notebook.add_share_permission",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "grant": {
    "target": {
      "type": "notebook",
      "uid": "63e1be654aa70ad689601bf3",
      "name": "Sales KPI"
    },
    "grantee": {
      "type": "user",
      "uid": "63e1be654aa70ad689601bec",
      "email_addr": "taro@example.com"
    },
    "role": {
      "new": "notebook.editor"
    }
  },
  ...
}

notebook.change_share_permission プレビュー

記録期間: 2026-09-15 〜

ノートブックの追加権限のロールの変更を記録します。

フィールド
event.codenotebook.change_share_permission
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
change(なし)
grant変更前後のロール
extra(なし)

grant

追加権限のロールが変更されたユーザーまたはグループと変更前後のロールが入ります。

サンプル

json
{
  "event": {
    "code": "notebook.change_share_permission",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "grant": {
    "target": {
      "type": "notebook",
      "uid": "63e1be654aa70ad689601bf3",
      "name": "Sales KPI"
    },
    "grantee": {
      "type": "user",
      "uid": "63e1be654aa70ad689601bec",
      "email_addr": "taro@example.com"
    },
    "role": {
      "old": "notebook.viewer",
      "new": "notebook.editor"
    }
  },
  ...
}

notebook.remove_share_permission プレビュー

記録期間: 2026-09-15 〜

ノートブックの追加権限の削除を記録します。

フィールド
event.codenotebook.remove_share_permission
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
change(なし)
grant削除された追加権限
extra(なし)

grant

追加権限が削除されたユーザーまたはグループと削除された権限が入ります。

サンプル

json
{
  "event": {
    "code": "notebook.remove_share_permission",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "grant": {
    "target": {
      "type": "notebook",
      "uid": "63e1be654aa70ad689601bf3",
      "name": "Sales KPI"
    },
    "grantee": {
      "type": "group",
      "uid": "63e1be654aa70ad689601bed",
      "name": "Data Engineers"
    },
    "role": {
      "old": "notebook.viewer"
    }
  },
  ...
}

notebook.delete プレビュー

記録期間: 2026-09-15 〜

ノートブックの削除を記録します。

フィールド
event.codenotebook.delete
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
outbound(なし)
changenotebook_folder_path
grant(なし)
extra(なし)

change

名前モード必須説明
notebook_folder_pathReference[]任意配置先の親フォルダ階層です。
並びは notebook_folder_path を参照してください。

サンプル

json
{
  "event": {
    "code": "notebook.delete",
    ...
  },
  "scope": {
    "type": "workspace",
    ...
  },
  "resource": {
    "type": "notebook",
    "uid": "63e1be654aa70ad689601bf3",
    "name": "Sales KPI",
    "path": "notebook/63e1be654aa70ad689601bf3",
    "parts": [
      {
        "type": "notebook",
        "uid": "63e1be654aa70ad689601bf3",
        "name": "Sales KPI"
      }
    ],
    ...
  },
  "change": {
    "fields": [
      {
        "name": "notebook_folder_path",
        "old": [
          {
            "type": "notebook_folder",
            "uid": "WORKSPACE",
            "name": "Workspace"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

Codatum Audit Events 監査ログイベントカタログ