Skip to content

レポート

レポートは、公開時点のノートブックの内容をメンバーやゲストに共有する機能です。

イベント一覧

イベントリソース説明
report.publishreportレポートが公開された
report.publish_changesreportレポートの変更が公開された
report.renamereportレポートの名前が変更された
report.update_settingsreportレポート設定が更新された
report.openreportレポートが開かれた
report.runreportワークフローでレポートの集計が実行された
report.capturereportワークフローでレポートのスクリーンショットが取得された
report.add_share_permissionreportレポートの共有権限が付与された
report.remove_share_permissionreportレポートの共有権限が削除された
report.send_invitationreportレポートにゲストが招待された
report.delete_invitationreportレポートのゲスト招待が削除された
report.deletereportレポートが削除された

イベント詳細

report.publish プレビュー

記録期間: 2026-09-15 〜

レポートの公開を記録します。

フィールド
event.codereport.publish
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
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 プレビュー

記録期間: 2026-09-15 〜

レポートへの変更の再公開を記録します。 ワークフローの runReport ステップで公開中レポートの内容を更新した場合も発行されます。

フィールド
event.codereport.publish_changes
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
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.rename プレビュー

記録期間: 2026-09-15 〜

レポートの表示名の変更を記録します。

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

change

名前モード必須説明
namestring必須変更前後の表示名
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_settings プレビュー

記録期間: 2026-09-15 〜

レポート設定の再公開なしで変更可能な項目の更新を記録します。

フィールド
event.codereport.update_settings
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

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

report.open プレビュー

記録期間: 2026-09-15 〜

レポートの閲覧を記録します。

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

サンプル

json
{
  "event": {
    "code": "report.open",
    ...
  },
  "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.run プレビュー

記録期間: 2026-09-15 〜

ワークフローの runReport ステップの実行を記録します。 どのワークフロー実行・ステップからかは context.workflow から辿れます。

ステップの設定でレポートの内容を更新する場合は report.publish_changes も併せて発行されます。

フィールド
event.codereport.run
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

サンプル

actor はワークフロー。どのステップからかは context.workflow.step。

json
{
  "event": {
    "code": "report.run",
    ...
  },
  "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"
      }
    ],
    ...
  },
  "context": {
    "workflow": {
      "workflow": {
        "type": "workflow",
        "uid": "63e1be654aa70ad689601bf8",
        "name": "Nightly Refresh"
      },
      "workflow_job": {
        "type": "workflow_job",
        "uid": "wjob_01"
      },
      "step": {
        "type": "workflow_step",
        "uid": "runReport_1"
      }
    }
  },
  ...
}

report.capture プレビュー

記録期間: 2026-09-15 〜

ワークフローの screenshot ステップの実行を記録します。 どのワークフロー実行・ステップからかは context.workflow から辿れます。

フィールド
event.codereport.capture
scope.typeworkspace
resource.typereport
references対象ページ
query(なし)
outbound(なし)
change(なし)
grant(なし)
extra(なし)

references

スクリーンショット取得対象のノートブックページの識別子と表示名が入ります。

relationtype必須説明
targetnotebook_page必須ノートブックのページ

サンプル

json
{
  "event": {
    "code": "report.capture",
    ...
  },
  "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": "notebook_page",
      "uid": "671ecbbf2990c63fea3b3a26",
      "name": "Overview",
      "relation": "target"
    }
  ],
  "context": {
    "workflow": {
      "workflow": {
        "type": "workflow",
        "uid": "63e1be654aa70ad689601bf8",
        "name": "Nightly Refresh"
      },
      "workflow_job": {
        "type": "workflow_job",
        "uid": "wjob_01"
      },
      "step": {
        "type": "workflow_step",
        "uid": "screenshot_1"
      }
    }
  },
  ...
}

report.add_share_permission プレビュー

記録期間: 2026-09-15 〜

レポートの共有権限の付与を記録します。

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

grant

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

サンプル

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 プレビュー

記録期間: 2026-09-15 〜

レポートの共有権限の削除を記録します。

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

grant

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

サンプル

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.send_invitation プレビュー

記録期間: 2026-09-15 〜

レポートへのゲスト招待を記録します。

フィールド
event.codereport.send_invitation
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
change(なし)
grant招待先と付与された権限
extra(なし)

grant

招待されたメールアドレスと、そのゲスト招待に付与されたレポートの共有権限が入ります。grantee は invitation です。

サンプル

json
{
  "event": {
    "code": "report.send_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"
      }
    ],
    ...
  },
  "grant": {
    "target": {
      "type": "report",
      "uid": "63e1be654aa70ad689601bf5",
      "name": "Weekly Dashboard"
    },
    "grantee": {
      "type": "invitation",
      "uid": "63e1be654aa70ad689601bf4",
      "email_addr": "taro@example.com"
    },
    "role": {
      "new": "report.viewer"
    }
  },
  ...
}

report.delete_invitation プレビュー

記録期間: 2026-09-15 〜

レポートのゲスト招待の削除を記録します。招待そのものは削除されません。

フィールド
event.codereport.delete_invitation
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
change(なし)
grant共有権限が失われた招待
extra(なし)

grant

レポートの共有権限が失われたゲスト招待の情報が入ります。grantee は 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"
      }
    ],
    ...
  },
  "grant": {
    "target": {
      "type": "report",
      "uid": "63e1be654aa70ad689601bf5",
      "name": "Weekly Dashboard"
    },
    "grantee": {
      "type": "invitation",
      "uid": "63e1be654aa70ad689601bf4",
      "email_addr": "taro@example.com"
    },
    "role": {
      "old": "report.viewer"
    }
  },
  ...
}

report.delete プレビュー

記録期間: 2026-09-15 〜

レポートの削除を記録します。

フィールド
event.codereport.delete
scope.typeworkspace
resource.typereport
references(なし)
query(なし)
outbound(なし)
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"
      }
    ],
    ...
  },
  ...
}

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