Skip to content

ノートブック

イベント一覧

イベントリソース説明
notebook.createnotebookノートブックが作成された。
notebook.deletenotebookノートブックが削除された。
notebook.renamenotebookノートブック名が変更された。
notebook.opennotebookノートブックが開かれた。
notebook.updatenotebookノートブックの本文が更新された。
notebook.duplicatenotebookノートブックが複製された。
notebook.restorenotebookノートブックが過去のバージョンから復元された。
notebook.restore_newnotebookノートブックの過去のバージョンが、新しいノートブックとして復元された。
notebook.movenotebookノートブックが移動された。
notebook.add_share_permissionnotebookノートブックの追加権限が付与された。
notebook.change_share_permission_rolenotebookノートブックの追加権限のロールが変更された。
notebook.remove_share_permissionnotebookノートブックの追加権限が削除された。

イベント詳細

notebook.create 準備中

ノートブックが作成された。

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

change

名前モード必須説明
notebook_folder_pathReference[]任意作成先のノートブックフォルダ階層。
最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は null が入ります。
階層を取得できなかった場合はこのフィールドを省略します。

サンプル

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": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

notebook.delete 準備中

ノートブックが削除された。

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

change

名前モード必須説明
notebook_folder_pathReference[]任意削除時点のノートブックフォルダ階層。
最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は null が入ります。
階層を取得できなかった場合はこのフィールドを省略します。

サンプル

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": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

notebook.rename 準備中

ノートブック名が変更された。

フィールド
event.codenotebook.rename
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
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.open 準備中

ノートブックが開かれた。

フィールド
event.codenotebook.open
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
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.update 準備中

ノートブックの本文が更新された。

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

change

名前モード必須説明
contentフラグ必須

サンプル

json
{
  "event": {
    "code": "notebook.update",
    ...
  },
  "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": "content",
        "changed": true
      }
    ]
  },
  ...
}

notebook.duplicate 準備中

ノートブックが複製された。

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

references

複製元・復元元のノートブックが入ります。

relationtype必須説明
sourcenotebook必須複製元・復元元のノートブック

change

名前モード必須説明
notebook_folder_pathReference[]任意複製先のノートブックフォルダ階層。
最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は null が入ります。
階層を取得できなかった場合はこのフィールドを省略します。

サンプル

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": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

notebook.restore 準備中

ノートブックが過去のバージョンから復元された。

フィールド
event.codenotebook.restore
scope.typeworkspace
resource.typenotebook
referencessourcenotebook_version
query(なし)
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.restore_new 準備中

ノートブックの過去のバージョンが、新しいノートブックとして復元された。

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

references

複製元・復元元のノートブックが入ります。

relationtype必須説明
sourcenotebook必須複製元・復元元のノートブック

change

名前モード必須説明
notebook_folder_pathReference[]任意復元先のノートブックフォルダ階層。
最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は null が入ります。
階層を取得できなかった場合はこのフィールドを省略します。

サンプル

json
{
  "event": {
    "code": "notebook.restore_new",
    ...
  },
  "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"
    }
  ],
  "change": {
    "fields": [
      {
        "name": "notebook_folder_path",
        "new": [
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bf2",
            "name": "Quarterly Reports"
          }
        ]
      }
    ]
  },
  ...
}

notebook.move 準備中

ノートブックが移動された。

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

change

名前モード必須説明
notebook_folder_pathReference[]任意移動前後のノートブックフォルダ階層。
最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は null が入ります。
階層を取得できなかった場合はこのフィールドを省略します。

サンプル

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": "63e1be654aa70ad689601bfc",
            "name": "Sales"
          },
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bfa",
            "name": "Reports"
          }
        ],
        "new": [
          {
            "type": "notebook_folder",
            "uid": "63e1be654aa70ad689601bfb",
            "name": "Archive"
          }
        ]
      }
    ]
  },
  ...
}

notebook.add_share_permission 準備中

ノートブックの追加権限が付与された。

フィールド
event.codenotebook.add_share_permission
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
change(なし)
grant権限・ロール・所属の差分
extra(なし)

grant

権限・ロール・所属の変更が Grant の形で入ります。target / granteeReference です。

サンプル

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_role 準備中

ノートブックの追加権限のロールが変更された。

フィールド
event.codenotebook.change_share_permission_role
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
change(なし)
grant権限・ロール・所属の差分
extra(なし)

grant

権限・ロール・所属の変更が Grant の形で入ります。target / granteeReference です。

サンプル

json
{
  "event": {
    "code": "notebook.change_share_permission_role",
    ...
  },
  "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 準備中

ノートブックの追加権限が削除された。

フィールド
event.codenotebook.remove_share_permission
scope.typeworkspace
resource.typenotebook
references(なし)
query(なし)
change(なし)
grant権限・ロール・所属の差分
extra(なし)

grant

権限・ロール・所属の変更が Grant の形で入ります。target / granteeReference です。

サンプル

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"
    }
  },
  ...
}

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