Appearance
レポート
イベント一覧
| イベント | リソース | 説明 |
|---|---|---|
report.view | report | レポートが閲覧された。 |
report.rename | report | レポートの名前が変更された。 |
report.update_tags | report | レポートのタグが更新された。 |
report.update_settings | report | レポートの設定が更新された。 |
report.publish | report | レポートが公開された。 |
report.publish_changes | report | レポートの変更が公開された。 |
report.delete | report | レポートが削除された。 |
report.add_share_permission | report | レポートの共有権限が付与された。 |
report.remove_share_permission | report | レポートの共有権限が削除された。 |
report.share_to_guest | report | レポートがゲストに共有された。 |
report.delete_invitation | report | レポートのゲスト招待が削除された。 |
イベント詳細
report.view 準備中
レポートが閲覧された。
| フィールド | 値 |
|---|---|
event.code | report.view |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
サンプル
json
{
"event": {
"code": "report.view",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
...
}report.rename 準備中
レポートの名前が変更された。
| フィールド | 値 |
|---|---|
event.code | report.rename |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | name |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
name | 値 | string | 必須 | sensitivity: pii |
サンプル
json
{
"event": {
"code": "report.rename",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"change": {
"fields": [
{
"name": "name",
"old": "Old",
"new": "Weekly Dashboard"
}
]
},
...
}report.update_tags 準備中
レポートのタグが更新された。
| フィールド | 値 |
|---|---|
event.code | report.update_tags |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | tag_ids |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
tag_ids | 集合 | string[] | 必須 | 付与・解除されたタグの識別子 |
サンプル
json
{
"event": {
"code": "report.update_tags",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"change": {
"fields": [
{
"name": "tag_ids",
"added": [
"63e1be654aa70ad689601be8"
],
"removed": []
}
]
},
...
}report.update_settings 準備中
レポートの設定が更新された。
| フィールド | 値 |
|---|---|
event.code | report.update_settings |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | settings |
grant | (なし) |
extra | (なし) |
change
| 名前 | モード | 型 | 必須 | 説明 |
|---|---|---|---|---|
settings | フラグ | — | 必須 | — |
サンプル
json
{
"event": {
"code": "report.update_settings",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"change": {
"fields": [
{
"name": "settings",
"changed": true
}
]
},
...
}report.publish 準備中
レポートが公開された。
| フィールド | 値 |
|---|---|
event.code | report.publish |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
サンプル
json
{
"event": {
"code": "report.publish",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
...
}report.publish_changes 準備中
レポートの変更が公開された。
| フィールド | 値 |
|---|---|
event.code | report.publish_changes |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
サンプル
json
{
"event": {
"code": "report.publish_changes",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
...
}report.delete 準備中
レポートが削除された。
| フィールド | 値 |
|---|---|
event.code | report.delete |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
サンプル
json
{
"event": {
"code": "report.delete",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
...
}report.add_share_permission 準備中
レポートの共有権限が付与された。
| フィールド | 値 |
|---|---|
event.code | report.add_share_permission |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | 権限・ロール・所属の差分 |
extra | (なし) |
grant
権限・ロール・所属の変更が Grant の形で入ります。target / grantee は Reference です。
サンプル
json
{
"event": {
"code": "report.add_share_permission",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"grant": {
"target": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
},
"grantee": {
"type": "user",
"uid": "63e1be654aa70ad689601bec",
"email_addr": "taro@example.com"
},
"role": {
"new": "report.viewer"
}
},
...
}report.remove_share_permission 準備中
レポートの共有権限が削除された。
| フィールド | 値 |
|---|---|
event.code | report.remove_share_permission |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | 権限・ロール・所属の差分 |
extra | (なし) |
grant
権限・ロール・所属の変更が Grant の形で入ります。target / grantee は Reference です。
サンプル
json
{
"event": {
"code": "report.remove_share_permission",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"grant": {
"target": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
},
"grantee": {
"type": "user",
"uid": "63e1be654aa70ad689601bec",
"email_addr": "taro@example.com"
},
"role": {
"old": "report.viewer"
}
},
...
}report.share_to_guest 準備中
レポートがゲストに共有された。
| フィールド | 値 |
|---|---|
event.code | report.share_to_guest |
scope.type | workspace |
resource.type | report |
references | (なし) |
query | (なし) |
change | (なし) |
grant | 権限・ロール・所属の差分 |
extra | (なし) |
grant
権限・ロール・所属の変更が Grant の形で入ります。target / grantee は Reference です。
サンプル
json
{
"event": {
"code": "report.share_to_guest",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"grant": {
"target": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
},
"grantee": {
"type": "invitation",
"uid": "inv_01",
"email_addr": "taro@example.com"
},
"role": {
"new": "report.viewer"
}
},
...
}report.delete_invitation 準備中
レポートのゲスト招待が削除された。
| フィールド | 値 |
|---|---|
event.code | report.delete_invitation |
scope.type | workspace |
resource.type | report |
references | invitation → invitation |
query | (なし) |
change | (なし) |
grant | (なし) |
extra | (なし) |
references
対象となった招待が入ります。
relation | type | 必須 | 説明 |
|---|---|---|---|
invitation | invitation | 必須 | 対象となった招待 |
サンプル
json
{
"event": {
"code": "report.delete_invitation",
...
},
"scope": {
"type": "workspace",
...
},
"resource": {
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard",
"path": "notebook/63e1be654aa70ad689601bf3/report/63e1be654aa70ad689601bf5",
"parts": [
{
"type": "notebook",
"uid": "63e1be654aa70ad689601bf3",
"name": "Sales KPI"
},
{
"type": "report",
"uid": "63e1be654aa70ad689601bf5",
"name": "Weekly Dashboard"
}
],
...
},
"references": [
{
"type": "invitation",
"uid": "inv_01",
"email_addr": "taro@example.com",
"relation": "invitation"
}
],
...
}