コンテンツにスキップ

取得



GET /api/v1/field_cfg/{field_uuid}/get

概要

現在のワークスペースで有効なフィールド設定1件の保存値を読み取ります。

呼び出し前の準備と使用手順

対象ワークスペースのAPI Keyを使用します。この設定は既存のフィールドに表示用の別名、説明、単位、分類を追加するものであり、収集フィールドの作成、実際のデータ型の変更、過去データのバックフィルは行いません。フィールドのソースが同一で、名前の大文字・小文字が完全に一致するカスタム設定は重複登録できません。ソースが異なる場合は同名でも登録できます。

まずフィールドリストからsysField=0のuuidを取得し、その後で詳細を呼び出します。このAPIは現在のワークスペースのUUIDおよびstatus=0のみで読み取り、システムワークスペースの組み込みフィールドをマージしません。詳細は保存済みの互換フィールドと多言語マッピングをそのまま返し、リストのようにリクエスト言語でalias/descを書き換えることはありません。creatorInfo/updatorInfoは追加されません。

ルートパラメータ

パラメータ名 型 必須 説明
field_uuid string Y 現在のワークスペースで有効なフィールド設定のUUID。組み込み設定は通常システムワークスペースに属するため、リストに表示されていても現在のワークスペースで詳細を読み取れるとは限りません。
例: field_example
取得または入力方法: フィールドリストからsysField=0の対象行のuuidを読み取ります。フィールド名は使用しません。

リクエストヘッダ

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

パラメータ補足説明

設定の詳細を返すものであり、そのフィールドの業務データを読み取るものではありません。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/field_cfg/field_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content.id integer レコード番号。APIのアドレッシングには使用しません。
content.workspaceUUID string 設定の所属ワークスペース。組み込み設定はシステムワークスペースに属します。
content.status integer レコードのステータス。正常は0、論理削除は3。この詳細は有効かつ現在のワークスペースに属するレコードのみを返します。
content.deleteAt integer 削除時刻(Unix秒)。未削除の場合は-1。
content.declaration object 現在の呼び出しワークスペースの共通宣言。
content.uuid string フィールド設定のUUID。以降の操作ではこの値を使用し、実際のフィールド名ではありません。
content.name string 実際のフィールド名。大文字・小文字を区別します。
content.alias string 別名。リストではリクエスト言語で表示され、詳細/作成/変更では互換フィールドの値を保持します。
content.aliasEn string 互換用の英語別名。中国語にフォールバックする場合があります。
content.aliasI18n object または null 過去に保存された多言語マッピングをそのまま返します。null、{}、または一部の言語キーのみを含む場合があります。リストで行われる6言語の正規化は実行しません。
content.desc string 説明。リストではリクエスト言語で表示され、その他のレスポンスでは互換フィールドの値を返します。
content.descEn string 互換用の英語説明。中国語にフォールバックする場合があります。
content.descI18n object または null 過去に保存された多言語マッピングをそのまま返します。null、{}、または一部の言語キーのみを含む場合があります。リストで行われる6言語の正規化は実行しません。
content.fieldType string 設定のデータ型。実際に収集されるフィールドの型は変更しません。過去の組み込みレコードでは、新規作成時のBody以外の値を持つ場合があります。
content.fieldSource string 適用対象のソース。空文字列は汎用設定を表します。
content.unit string 表示単位。fieldType=stringの場合、保存時に強制的に空になります。
content.sysField integer 1は組み込み、0はカスタム。組み込み設定はこのAPIでは変更/削除できません。
content.category string systemはシステムフィールド、businessは業務フィールド、otherはその他。古いレコードでは空の場合があります。
content.creator string 作成者。API KeyまたはシステムIDの場合があります。
content.updator string 更新者。未更新の場合は空文字列。
content.createAt integer 作成時刻(Unix秒)。
content.updateAt integer 更新時刻(Unix秒)。未更新の場合は-1。
content.aliasI18n.zh string zh言語の元の別名。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.aliasI18n.en string en言語の元の別名。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.aliasI18n.zh-hant string zh-hant言語の元の別名。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.aliasI18n.id string id言語の元の別名。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.aliasI18n.ja string ja言語の元の別名。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.aliasI18n.ko string ko言語の元の別名。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.descI18n.zh string zh言語の元の説明。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.descI18n.en string en言語の元の説明。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.descI18n.zh-hant string zh-hant言語の元の説明。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.descI18n.id string id言語の元の説明。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.descI18n.ja string ja言語の元の説明。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
content.descI18n.ko string ko言語の元の説明。未提供の場合は通常空です。リスト表示では言語に応じたフォールバックが行われます。詳細は保存値をそのまま返すため、このキーは省略される場合があります。先に親オブジェクトおよびキーの存在を確認してください。
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "field_example",
    "workspaceUUID": "wksp_example",
    "name": "host",
    "alias": "主机",
    "aliasEn": "Host",
    "aliasI18n": {
      "zh": "主机",
      "en": "Host",
      "zh-hant": "主機",
      "id": "",
      "ja": "",
      "ko": ""
    },
    "desc": "主机名称",
    "descEn": "Host name",
    "descI18n": {
      "zh": "主机名称",
      "en": "Host name",
      "zh-hant": "主機名稱",
      "id": "",
      "ja": "",
      "ko": ""
    },
    "fieldType": "string",
    "fieldSource": "logging",
    "category": "business",
    "unit": "",
    "sysField": 0,
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
400 ft.FieldNotFound UUIDが現在のワークスペースに属していない、レコードが存在しない、または削除済み 指定されたフィールドが見つかりません 現在のワークスペースのフィールドリストからカスタム設定のUUIDを取得してください。システムワークスペースのUUIDでは操作できません。
500 ft.InternalServerError クエリまたはレスポンスのフォーマットに失敗 内部エラー traceIdを保持したうえで再試行してください。継続して失敗する場合は管理者に連絡してください。

フィードバック

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