コンテンツにスキップ

一覧



GET /api/v1/objc_cfg/list

概要

リソースカタログのカテゴリ設定を読み取り、現在報告されているカテゴリおよびその数量をマージします。

呼び出し前の前提と使用手順

ルートの権限は routine.defaultAccess、anonymous.shared、anonymous.snapshotShared のいずれかに一致する必要があります。一覧の実際のカウントには O/CO データのクエリ権限 infrastructure.Query も必要です。リソースカタログの読み取り権限はデータのクエリ権限の代わりにはなりません。

ネイティブの content 配列を返します。ページネーションは行わず、name の大文字小文字を無視した昇順で並びます。設定は現在のワークスペースの未削除のカタログから取得します。設定がないもののデータがあるカテゴリは、現在の言語のシステムテンプレートで補完でき、それ以外はデフォルトの空の表示設定になります。uuid は null になる場合があります。docCount は今回カウント対象となったカテゴリにのみ存在します。未報告の設定も一覧に表示されますが、docCount=0 とは限りません。

sourceType は公開されている値が object/custom_object のみで、共有の内部履歴データ型は適用されません。数量の集計は最大 1000 カテゴリまでで、クエリ権限やアクセスルールが適用されるため、絶対的に完全な資産一覧ではありません。search はローカル設定のマッチングと下流のソース正規表現の両方に影響します。timeRange はデータ統計にのみ影響し、データのない設定をすべて非表示にするわけではありません。Query の objcGroupUUID は現在フィルタリングに使用されていません。

targetWorkspaceUUIDs は統計の取得元を切り替えるだけで、設定・テンプレート・グループは引き続き現在のワークスペースのものです。有効な認可が必要で、同一サイトである必要があります。クロスワークスペースの docCount から、その対象ワークスペースが現在の表示設定を採用していると誤認しないでください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証資格情報です。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
objcGroupUUID string 任意。作成/変更時に明示的に空文字列を指定するとグループをクリアします。省略した場合はテンプレートの groupCfg.name を試み、名前がなければ空文字列となり、変更時は元のグループを維持するわけではありません。空でない場合は現在のワークスペースにグループが存在する必要があります。一覧はこのフィールドを宣言していますが、現在の実装ではこれによるフィルタリングは行わないため、結果の絞り込みに依存しないでください。
空文字列を許可: True
null を許可: False
最大長: 64
例:
取得または入力方法: 現在のワークスペースのリソースカタログのグループ管理、または一覧項目の objcGroupUUID から objcg_ 識別子を取得します。
search string 一覧では任意で、先頭と末尾の空白は除去されます。ローカル設定は name/alias のあいまい一致で検索し、下流のカテゴリ統計ではこれを正規表現のソース式に組み込みます。特殊な正規表現やバッククォートは範囲を変えたり解析エラーを引き起こす可能性があります。通常のキーワードを使用することを推奨します。結果の各項目に docCount があることは保証されません。
null を許可: False
例: example
取得または入力方法: 呼び出し元がカテゴリ名/別名のキーワードを入力します。
sourceType string Y 公開必須で、object/custom_object のみです。共有内部関数の *_history はサポートしません。作成時は実際に templateInfo.main[0].class を取得するため、必ずこのフィールドと一致させてください。変更/読み取りでは設定タイプの選択に使用します。削除は公開のみ custom_object で、コントローラーはこのタイプに固定されています。
null を許可: False
選択可能な値: ['object', 'custom_object']
例: custom_object
取得または入力方法: システムオブジェクトは object、カスタムリソースオブジェクトは custom_object を選択し、実際に報告されるデータソースを取得します。
targetWorkspaceUUIDs commaArray 一覧では任意で、英字カンマ区切りです。指定しない場合は現在のワークスペースのエンティティ数をクエリします。下流の数量統計にのみ影響し、設定・テンプレート・グループは引き続き現在のワークスペースから取得します。対象は有効な認可があり、単一サイト由来である必要があります。異なるワークスペースの設定を混在して返すことはありません。
空文字列を許可: False
null を許可: False
例: wksp_example
取得または入力方法: 認可されたワークスペース一覧 の content[].data[].workspaceUUID から対象を取得するか、現在のワークスペースの UUID を指定します。
timeRange string 任意。デフォルトは文字列 [] で、デフォルトのウィンドウはクエリサービスが決定します。数量統計にのみ影響し、ローカル設定は切り捨てません。--data-urlencode でエンコードしてください。JSON でない文字列はコントローラーで解析に失敗して 500 になります。これはリクエスト Body の JSON 構文エラーではありません。
null を許可: False
例: [1785427200000,1785430800000]
取得または入力方法: クライアントが開始/終了の Unix ミリ秒タイムスタンプを 2 要素の JSON 配列に構成し、それを Query 文字列にシリアライズします。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/objc_cfg/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode sourceType=custom_object \
  --data-urlencode 'timeRange=[1785427200000,1785430800000]'

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示します。

フィールド 型 説明
content オブジェクト配列 カテゴリ配列。空の場合は []。
content[].uuid string または null ローカル設定の UUID。報告のみ/システムテンプレートでローカル設定がない場合のみ null。
content[].name string カテゴリコード。以降のエクスポート/変更/削除で使用し、uuid は使用しません。
content[].alias string または null 表示用の別名。
content[].fields オブジェクト配列 設定フィールド定義。
content[].fields[].name string 実際に報告されるフィールド名。必ず name を含み、重複せず、フィールド命名規則に従います。
content[].fields[].alias string 任意の表示用別名。
content[].filters オブジェクト配列 クイックフィルター項目。
content[].filters[].key string フィルターフィールド。
content[].tableColumns オブジェクト配列 一覧の列設定。
content[].tableColumns[].key string 列フィールド。
content[].tableDetailViews オブジェクト配列 または object 詳細設定。テンプレートのない分岐では {} になる場合があります。
content[].iconSet object 条件アイコン設定。設定のない分岐では省略される場合があります。
content[].iconSet.icon string 条件アイコンの識別子。
content[].iconSet.url string 条件画像の URL。
content[].objcGroupUUID string ローカルグループの UUID。値がない場合は空文字列。
content[].objcGroupInfo object 任意のグループ情報。ローカル/テンプレートの取得元によって異なります。
content[].objcGroupInfo.id integer ローカルグループのレコード番号。省略される場合があります。
content[].objcGroupInfo.uuid string グループ UUID。
content[].objcGroupInfo.workspaceUUID string 所属ワークスペース。省略される場合があります。
content[].objcGroupInfo.name string グループ名。
content[].objcGroupInfo.creator string 条件付きの作成主体。
content[].objcGroupInfo.updator string 条件付きの更新主体。
content[].objcGroupInfo.createAt integer 条件付きの作成 Unix 秒。
content[].objcGroupInfo.updateAt integer 条件付きの更新 Unix 秒。
content[].objcGroupInfo.deleteAt integer 条件付きの削除 Unix 秒。未削除は -1。
content[].objcGroupInfo.status integer 条件付きのグループステータス。
content[].bindSet array 設定のない分岐のみの従来のプレースホルダーフィールド。
content[].docCount integer または number 今回のエンティティカウントに一致したカテゴリのみこのフィールドを持ちます。設定が存在しても一致するデータがない場合は省略され、一律に 0 を補うことはありません。
content[].declaration object 空でない各配列項目の共通宣言。
content[].tableDetailViews[].title string Tab タイトル。
content[].tableDetailViews[].viewType string component/dashboard。
content[].tableDetailViews[].viewName string 組み込みページのパスまたは組み込みビュー名。
content[].tableDetailViews[].required boolean keys に従って表示するかどうか。
content[].tableDetailViews[].keys object 動的にマッチするフィールド/値。
content[].tableDetailViews[].keys.フィールド名 JSON マッチ値/存在マーカー *。
content[].tableDetailViews[].timerange string または 文字列配列 default/相対時間/前後オフセット配列。
content[].tableDetailViews[].timerange[] string 個々の前/後オフセット時間。
{
  "code": 200,
  "content": [
    {
      "uuid": "objc_example",
      "name": "example_resources",
      "alias": "サンプルリソースカタログ",
      "fields": [
        {
          "name": "name",
          "alias": "リソース名"
        }
      ],
      "filters": [
        {
          "key": "env"
        }
      ],
      "tableColumns": [
        {
          "key": "name"
        }
      ],
      "tableDetailViews": [],
      "iconSet": {},
      "objcGroupUUID": "",
      "docCount": 2,
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

変更/エクスポートできるのは現在の API Key のワークスペースの設定のみです。一覧は認可された対象ワークスペースのカウントを実行できますが、その表示設定は引き続き現在のワークスペースのものです。このインターフェースには freeEdition バージョン宣言がありますが、公開 OpenAPI 認証はこのルートでそのバージョンチェックを実行しないため、バージョン自体を固定の 403 として記述しないでください。上流の 4xx は実際の Kodo/権限マッピングに従います。通常の 5xx は最終的に 500 ft.InternalServerError になります。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 パラメータ解析に失敗 パラメータの位置、フィールド名、型、値を確認してください。
406 ft.workspaceUnauthorized 明示的な対象ワークスペースが現在のワークスペースに認可されていない ワークスペース[{}]は認可されていません 認可されたワークスペース一覧から有効な対象を選び直してください。
406 ft.UnsupportMultiSiteQuery 対象の認可が複数サイトにまたがる/外部組織アドレスが一意でない マルチサイトのワークスペースクエリはサポートされていません サイトごとに個別にリクエストし、認可元のアドレスを確認してください。
404 ft.NoInitOtherNodeCfg 外部組織のクロスサイト認可にソースサイトのアドレスがない 他のノード設定が初期化されていません 管理者に連絡し、認可サイト情報を修正してください。
400 ft.InvalidWorkspace 対象の現在のサイトのワークスペースが存在しないか非アクティブ 無効なワークスペース: {} 認可されたワークスペースの現在のステータスを確認してください。
403 ft.ForbiddenQuery 現在の Key に対象データタイプのクエリ権限がない {} の権限がありません カタログの読み取り権限はオブジェクトデータのクエリ権限の代わりにならないため、該当する namespace の認可を追加してください。
406 ft.DqlParseError search の特殊文字などにより生成された式の解析が失敗 dql parser 解析失敗: {} 特殊な正規表現/バッククォートを除去し、通常のカテゴリキーワードを使用してください。
503 ft.QueryServiceUnavailable 上流クエリの 503 が一時的な利用不可として正規化された クエリサービスは一時的に利用できません。しばらくしてから再試行してください content.retryable と traceId に従い、限定的なバックオフ再試行を行ってください。
500 ft.InternalServerError 従来の設定/システムテンプレートの構造異常、時間文字列が JSON でない、クエリ/データフォーマットの未捕捉エラー 内部エラー パラメータと従来のテンプレートを確認し、読み取り範囲を絞ってから限定的に再試行し、traceId を保持してください。読み取りでは今回の設定書き込みは実行されません。

フィードバック

このページは役に立ちましたか?