エクスポート¶
GET /api/v1/objc_cfg/{objc_name}/export
概要¶
単一のリソースカタログ設定を JSON テンプレートとしてエクスポートします。
呼び出し前の準備と使用手順¶
ルート権限は routine.defaultAccess、anonymous.shared、anonymous.snapshotShared のいずれかに一致する必要があります。本 API はオブジェクトデータのクエリを実行しないため、今回のエクスポートのために infrastructure.Query を追加申請する必要はありません。
GET は JSON の content 設定を返し、CSV/ファイルストリーム/非同期ダウンロードではありません。テンプレートオブジェクトは templateInfo に使用し、統一レスポンス全体をそのまま埋め戻さないでください。現在のワークスペース設定を優先し、なければワークスペースの言語に従ってサイトテンプレートへフォールバックします。現在いずれも一致しない場合でも、リクエストされた分類名に基づいて合成された最小テンプレートを返すことがあり、404 や元の分類にデータがあることを保証するものではありません。
ローカル設定では groupCfg.name をエクスポートします。他のワークスペースへインポートする際は、名前の互換性エラーを避けるため、先にグループ UUID を明確にしてください。システムテンプレートには追加のメタデータや複数の main 項目が保持される場合があります。アップロードされたカスタムシステムテンプレートの source は、履歴上の文字列/配列のままである可能性があるため、埋め戻す前に key(および任意の name)を含むオブジェクトへ変換し、動的フィールドを項目ごとに確認してください。公開の作成/変更では先頭項目のみを消費します。このページは読み取り専用であり、削除や報告フィールドの同期は実行しません。
ルートパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| objc_name | string | Y | 削除では Body が必須です。パスでのエクスポート/変更では同じ分類名を使用し、名前は報告時の class と一致させ、パスを URL エンコードしてください。エイリアスは表示のみを制御し、対象名としては使用しません。 例: example_resources取得または入力方法: リソースカタログ一覧 の content[].name から分類コードを取得します。objc_ 設定 UUID や alias ではありません。 |
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sourceType | string | Y | 公開時は必須で、object/custom_object のみです。共有内部関数の *_history はサポートしません。作成時は実際に templateInfo.main[0].class を取得するため、必ずこのフィールドと一致させてください。変更/読み取りでは設定タイプの選択に使用します。削除の公開では custom_object のみで、コントローラーはこのタイプに固定されます。 null 許可: False 選択可能な値: ['object', 'custom_object'] 例: custom_object取得または入力方法: システムオブジェクトでは object、カスタムリソースオブジェクトでは custom_object を選択し、実際に報告されるデータソースを取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/objc_cfg/example_resources/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode sourceType=custom_object
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.main | オブジェクト配列 | 作成/変更時の埋め戻しに使用できるテンプレート配列です。ローカルで合成された場合は通常 1 項目で、システムテンプレートでは元の配列が保持される場合があります。 |
| content.main[].class | string | object/custom_object のデータ型。 |
| content.main[].source | オブジェクト または string または array | 分類の位置指定と表示名です。ローカル設定ではオブジェクトに合成され、アップロードされたカスタムシステムテンプレートでは履歴上の文字列/配列が保持される場合があるため、埋め戻す前に key を含むオブジェクトへ正規化してください。 |
| content.main[].source.key | string | source がオブジェクトの場合の実際の分類名です。履歴上の文字列/配列の分岐では省略される場合があります。 |
| content.main[].source.name | string | source がオブジェクトの場合の条件付きエイリアスです。ローカル合成で未設定の場合は分類名にフォールバックし、履歴テンプレートでは省略される場合があります。 |
| content.main[].其他模板字段 | JSON | カスタムアップロードのシステムテンプレートでは、動的拡張フィールドと元の構造が保持される場合があります。本ページの作成/変更で消費するフィールドのみを埋め戻し、認識されないフィールドを保存済みまたは検証済みと見なさないでください。 |
| content.main[].groupCfg | object | ビジネスグループのエクスポート設定です。グループがない場合は {} です。 |
| content.main[].groupCfg.name | string | グループがある場合の名前で、UUID ではありません。 |
| content.main[].fields | オブジェクト配列 | フィールド定義。 |
| content.main[].fields[].name | string | 実際に報告されるフィールド名です。name を必ず含み、重複せず、フィールド命名規則に従います。 |
| content.main[].fields[].alias | string | 任意の表示エイリアス。 |
| content.main[].filters | オブジェクト配列 | クイックフィルター。 |
| content.main[].filters[].key | string | フィルターフィールド。 |
| content.main[].groups | array | 動的表示グループ。 |
| content.main[].groups[] | JSON | 元の動的グループ項目。 |
| content.main[].fills | array | 動的フィル設定。 |
| content.main[].fills[] | JSON | 元の動的フィル項目。 |
| content.main[].table | object | リスト/詳細ビュー。 |
| content.main[].table.columns | オブジェクト配列 | リスト列。 |
| content.main[].table.columns[].key | string | 列フィールド。 |
| content.main[].table.detail | object | 詳細設定。 |
| content.main[].table.detail.views | オブジェクト配列 | タブ設定。 |
| content.title | string | エイリアス/分類名です。システムテンプレートでは元の値を使用します。 |
| content.summary | string | ローカル合成では空文字列、システムテンプレートでは元の値を使用します。 |
| content.iconSet | オブジェクト または null | アイコンです。利用可能な値がない場合は null にできます。 |
| content.iconSet.icon | string | 条件付きアイコン識別子。 |
| content.iconSet.url | string | 条件付きアイコンリソース URL。 |
| content.declaration | object | 外側の共通宣言です。templateInfo へ埋め戻す際は統一シェルを含めません。 |
| content.main[].table.detail.views[].title | string | タブタイトル。 |
| content.main[].table.detail.views[].viewType | string | component/dashboard。 |
| content.main[].table.detail.views[].viewName | string | 組み込みページパスまたは組み込みビュー名。 |
| content.main[].table.detail.views[].required | boolean | keys に従って表示するかどうか。 |
| content.main[].table.detail.views[].keys | object | 動的に一致させるフィールド/値。 |
| content.main[].table.detail.views[].keys.フィールド名 | JSON | 一致値/存在マーカー *。 |
| content.main[].table.detail.views[].timerange | string または 文字列配列 | default/相対時間/前後オフセット配列。 |
| content.main[].table.detail.views[].timerange[] | string | 単一の前/後オフセット時間。 |
{
"code": 200,
"content": {
"main": [
{
"class": "custom_object",
"source": {
"key": "example_resources",
"name": "示例资源目录"
},
"groupCfg": {},
"fields": [
{
"name": "name",
"alias": "资源名称"
}
],
"filters": [
{
"key": "env"
}
],
"groups": [],
"fills": [],
"table": {
"columns": [
{
"key": "name"
}
],
"detail": {
"views": []
}
}
}
],
"title": "示例资源目录",
"summary": "",
"iconSet": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
変更/エクスポートできるのは、現在の API Key のワークスペースの設定のみです。一覧では認可された対象ワークスペースをカウントできますが、その表示設定は引き続き現在のワークスペースのものです。API には freeEdition バージョン宣言がありますが、共通 OpenAPI 認証はこのルートでそのバージョンチェックを実行しないため、バージョン自体を固定の 403 として記載しないでください。上流の 4xx は実際の Kodo/権限マッピングに従います。通常の 5xx は最終的に 500 ft.InternalServerError になります。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています | パラメーター解析に失敗しました | パラメーターの位置、フィールド名、型、値を確認してください。 |
| 404 | ft.NotFoundObjcGroupObj | ローカル設定が参照するビジネスグループが既に存在しません | 指定されたリソース分類グループが見つかりません | 該当カタログのグループ関連付けを確認し、修正してからエクスポートしてください。ディレクトリ自体が見つからない場合でも、このエラーが必ず報告されるとは限りません。 |
| 500 | ft.InternalServerError | 単一のカタログ設定、システムテンプレート、または関連グループの読み取りおよびエクスポートのフォーマット時に未捕捉の例外が発生しました | 内部エラー | 該当分類の履歴設定、テンプレート構造、グループ関連付けを確認し、traceId を保持したうえで限定的に再試行してください。このページは読み取り専用であり、今回の設定書き込みは実行しません。 |