Appearance
ノートブック
イベント一覧
| イベント | リソース | 説明 |
|---|---|---|
notebook.create | notebook | ノートブックが作成された。 |
notebook.delete | notebook | ノートブックが削除された。 |
notebook.rename | notebook | ノートブック名が変更された。 |
notebook.open | notebook | ノートブックが開かれた。 |
notebook.update | notebook | ノートブックの本文が更新された。 |
notebook.duplicate | notebook | ノートブックが複製された。 |
notebook.restore | notebook | ノートブックが過去のバージョンから復元された。 |
notebook.restore_new | notebook | ノートブックの過去のバージョンが、新しいノートブックとして復元された。 |
notebook.move | notebook | ノートブックが移動された。 |
notebook.add_share_permission | notebook | ノートブックの追加権限が付与された。 |
notebook.change_share_permission_role | notebook | ノートブックの追加権限のロールが変更された。 |
notebook.remove_share_permission | notebook | ノートブックの追加権限が削除された。 |
イベント詳細
notebook.create 準備中
ノートブックが作成された。
| フィールド | 値 |
|---|---|
event.code | notebook.create |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 作成先のノートブックフォルダ階層。 最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は 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.code | notebook.delete |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 削除時点のノートブックフォルダ階層。 最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は 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.code | notebook.rename |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | name |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
name | 値 | string | 必須 | 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.code | notebook.open |
scope.type | workspace |
resource.type | notebook |
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.code | notebook.update |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | content |
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.code | notebook.duplicate |
scope.type | workspace |
resource.type | notebook |
references | source → notebook |
query | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
references
複製元・復元元のノートブックが入ります。
relation | type | 必須 | 説明 |
|---|---|---|---|
source | notebook | 必須 | 複製元・復元元のノートブック |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 複製先のノートブックフォルダ階層。 最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は 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.code | notebook.restore |
scope.type | workspace |
resource.type | notebook |
references | source → notebook_version |
query | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
references
複製元・復元元のノートブックのバージョンが入ります。
relation | type | 必須 | 説明 |
|---|---|---|---|
source | notebook_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.code | notebook.restore_new |
scope.type | workspace |
resource.type | notebook |
references | source → notebook |
query | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
references
複製元・復元元のノートブックが入ります。
relation | type | 必須 | 説明 |
|---|---|---|---|
source | notebook | 必須 | 複製元・復元元のノートブック |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 復元先のノートブックフォルダ階層。 最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は 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.code | notebook.move |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | notebook_folder_path |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
notebook_folder_path | 値 | Reference[] | 任意 | 移動前後のノートブックフォルダ階層。 最上位のフォルダから順に並び、末尾が直近の親です。ルート直下の場合は 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.code | notebook.add_share_permission |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | (なし) |
grant | 権限・ロール・所属の差分 |
extra | (なし) |
grant
権限・ロール・所属の変更が Grant の形で入ります。target / grantee は Reference です。
サンプル
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.code | notebook.change_share_permission_role |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | (なし) |
grant | 権限・ロール・所属の差分 |
extra | (なし) |
grant
権限・ロール・所属の変更が Grant の形で入ります。target / grantee は Reference です。
サンプル
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.code | notebook.remove_share_permission |
scope.type | workspace |
resource.type | notebook |
references | (なし) |
query | (なし) |
change | (なし) |
grant | 権限・ロール・所属の差分 |
extra | (なし) |
grant
権限・ロール・所属の変更が Grant の形で入ります。target / grantee は Reference です。
サンプル
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"
}
},
...
}