Catendaがドキュメントとモデルのリビジョンを管理する方法を大幅に更新する、ステータスワークフローを実装します。この変更により、作業中のリビジョンと正式なリビジョンの区別が導入され、統合に調整が必要になる場合があります。

エグゼクティブサマリー

Catendaは以下を区別します：

「共有」リビジョン（作業/ドラフトバージョン）
「公開」リビジョン（正式/承認済みバージョン）

早急な対応が必要な場合

アプリケーションが Catenda Hub と統合している場合
ユーザーにリビジョン情報を表示している
API を使用して新しいリビジョンを作成する
CADツールのプラグインを使用している

変更内容

1.リビジョンの種類

以前は、すべてのリビジョンは暗黙のうちに "公式 "とみなされていました。現在は

「共有」：共同作業リビジョン。
「公開」：より広範に配布される公式リビジョン

2.APIレスポンスの変更

Document APIには、ライブラリ・アイテムのための新しいフィールドが含まれます：

{
 "document"：{
 "revision"：{
 "extendedVersion"：{
 "major"：1,
 "minor": null // またはSharedの場合は1,2,3
 },
 "version"：5 // レガシーナンバリングを維持
 }.
 
 ｝

モデルAPIの変更は最小限である：

scopeパラメータ（scope=publishedまたはscope=all）によるフィルタリング機能を追加。
リビジョンステータスや拡張ナンバリングを公開しない
基礎となる文書から継承されたパーミッションを強制します。

3.デフォルトの動作

重要: APIは、ユーザがアクセスできる場合、デフォルトで "Shared "と "Published "の両方のリビジョンを返します。これは後方互換性を維持しますが、返されるデータの性質を根本的に変えます。

誰がどのように影響を受けるか

影響を受けない

✅ Catenda Hubに依存しないスタンドアロンAPIアプリケーション
✅ リビジョンを表示または管理しないアプリケーション

重大な影響 - CAD ツールプラグイン

⚠️重大な問題：

共有」または「公開」リビジョンを作成しているかどうかを判断できない。
ユーザーに正確なリビジョンステータスを表示できない。
ハブとは異なるナンバリングを表示する可能性がある（シーケンシャル形式とX.Y形式）。
ステータスが表示されないと、ユーザーはリビジョンのコンテキストを理解できません。

プラグイン開発者に必要なアクション

リビジョン情報を表示しているかどうかを評価する
リビジョンタイプに関するユーザーガイダンスの追加を検討する
番号の不一致による潜在的なユーザーの混乱に備える。

また、次のようなアプリケーションも影響を受けます。

⚠️ 以下のアプリケーション：

ユーザーにリビジョンリストを表示する
API経由で新しいリビジョンを作成する
すべてのリビジョンが「公式」であることに依存している
カテンダサイトとの統合

技術実装ガイド

リビジョンのフィルタリング

どのリビジョンが返されるかを制御するには、新しいスコープパラメータを使用してください：

# Documents API
GET /documents?scope=published # 公開のみ
GET /documents?scope=shared # 共有のみ(パーミッションが必要)
GET /documents # 全て(デフォルト)

# Models API
GET /models/revisions?scope=published # 公開のみ
GET /models/revisions # 全て(デフォルト)

権限の変更

新しい ACL 権限はあなたの操作に影響します：

共有 "リビジョンの閲覧：共有」リビジョンの閲覧: 特定のパーミッションが必要です。
公開 "リビジョンの作成：Catenda Hub UIからのみ可能
APIリビジョンの作成：デフォルトで "共有 "リビジョンを作成します。

APIでできないこと

公開」リビジョンの作成（Hubのみ）
❌ モデルAPIでリビジョンステータスにアクセスする
❌ Models APIで拡張番号 (X.Y) を見る
❌ モデルとドキュメントの関係を決定する

移行に関する考慮事項

既存のプロジェクト：

既存のプロジェクト：移行すると、現在のリビジョンはすべて「発行済み」になります。
バージョン番号はメジャーリビジョン番号になる（例：v3 → 3）
過去のデータに対するアクションは不要

新しい動作

API経由で作成された新しいリビジョンは、デフォルトで「共有」になります。
パブリッシュには、ハブでの手動操作が必要

実装のための重要な決定事項

質問1：公式リビジョンのみが必要ですか？

はい→スコープ=公開フィルタリングを実装する
いいえ→ リビジョンタイプが混在しても対応できるようにする

質問2：リビジョン情報を表示しますか？

はい→ 番号の不一致に備える（特にモデルAPIユーザー向け）
いいえ→ 影響は最小限

質問3: ユーザーはアプリを通じてリビジョンを作成しますか？

はい→ ユーザーに「共有」リビジョンを作成していることを知らせる
いいえ→ 対処の必要なし

既知の制限と回避策

モデルAPIユーザー

制限事項：リビジョンステータスや拡張番号にアクセスできない
回避策フィルタリングを使用して、必要なリビジョンタイプのみを取得する
ユーザーへの影響リビジョン番号の違いによる混乱の可能性

コレクションAPIユーザー向け：

現在、コレクションに追加できるのは「公開」リビジョンのみです。
これは顧客からのフィードバックに基づいて変更される可能性があります。

サポートリソース

ドキュメントの更新があります：

[APIリファレンスの更新] - 新しいスコープパラメータを含む

よくある質問

Q: 私の統合は壊れますか？

A: APIレベルでの変更はありませんが、特にCADプラグインではユーザーエクスペリエンスが大きく変わる可能性があります。

Q: Models APIでリビジョン・ステータスが表示されないのはなぜですか？

A: 後方互換性を維持するために、Models APIはStatus Workflowの機能を最小限に公開しています。フィルタリングを使用して、返されるリビジョンを制御してください。

Q: ユーザーは自分が作成しているリビジョンのタイプをどのように知ることができますか？

A: APIを通して、すべての新しいリビジョンは "共有 "です。公開」リビジョンを作成するには、Catenda Hubを使用する必要があります。

Q: 適応に時間が必要な場合はどうすればいいですか？

A: すぐにご連絡ください。ステータス・ワークフローは徐々に有効になります。

ステータスワークフロー - APIアップデート