削除¶
POST /api/v1/field_cfg/delete
概要¶
現在のワークスペースのカスタムフィールド設定を一括で論理削除します。
呼び出し前の準備と使用手順¶
対象ワークスペースの API Key を使用します。この設定は既存フィールドに表示用の別名、説明、単位、分類を追加するもので、収集フィールドの作成、実際のデータ型の変更、履歴データのバックフィルは行いません。同じフィールドソースかつ名前の大文字小文字が完全に一致するカスタム設定は重複登録できません。異なるソースであれば同名でも可能です。
カスタム設定の UUID 配列を送信します。現在のワークスペースで sysField=0 かつ未削除のレコードのみを削除し、組み込み、別ワークスペース、見つからない、または削除済みの UUID は無視されます。true が返されても一致件数/削除件数は含まれません。[] でも成功する場合があります。削除後、一覧では以前に同じソース・同名のカスタム設定で上書きされていた組み込みフィールドが再び表示されます。実際に収集されたデータは削除されません。送信後のキャッシュクリアに失敗すると 500 が返る場合があるため、読み戻して確認してから再試行してください。確認後に再度削除しても、通常は操作なしで成功します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| objUUIDs[*] | string | 削除対象の単一 UUID。未知/別ワークスペース/組み込みの場合は削除されません。 例: field_example取得または入力方法: 対象のカスタム設定 UUID を項目ごとに入力します。 |
|
| objUUIDs | array | Y | 必須配列。各項目は空でない UUID 文字列を推奨します。サーバー側では要素型を完全には検証しません。 null を許可: False 例: ["field_example"]取得または入力方法: フィールド一覧から sysField=0 のレコードの uuid 配列を選択します。 |
パラメータ補足説明¶
フィールド表示設定のみを削除し、実際のデータおよび組み込み設定は保持されます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/field_cfg/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"objUUIDs":["field_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 処理完了時に true を返しますが、リクエストしたすべての UUID が削除されたことを意味するものではありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 500 | ft.InternalServerError | 書き込み、送信後のキャッシュクリア、またはレスポンス組み立ての失敗 | 内部エラー | まず一覧/詳細で送信済み状態を確認してから再試行するか判断し、重複作成を避けてください。 |