パブリック配信不可: 2025-05-14

移動先

• リクエスト
• レスポンス

既存のターゲットの変更

patch

https://EM_HOST:8080/em/api/targets/{targetId}

このAPIは、指定されたIDで特定された既存のターゲットを変更します。これはそのターゲットの部分更新です。指定された部分のみを更新します。

リクエスト

パス・パラメータ

• targetId(必須): string
  ターゲットID

サポートされているメディア・タイプ

• application/json+merge-patch

リクエスト本文 - application/json+merge-patch ()

ルート・スキーマ: schema

型: object

既存のターゲットの変更に使用するペイロード

ソースの表示

• accessPoint: accessPoint
  この更新のアクセス・ポイント
• credentials: object credentials
  使用可能なその他のプロパティ: additionalProperties

  更新する資格証明
• displayName: string
  ターゲットの表示名
• propagateToAgent: boolean
  プロパティの変更をエージェントまで発展させるかどうかを示します。
• properties: array properties
  更新するプロパティ

{
    "x-em-sdk-level":"emSDK",
    "description":"The payload used to modify an existing target",
    "type":"object",
    "properties":{
        "propagateToAgent":{
            "type":"boolean",
            "description":"indicates if property changes shall get promoted to the agent"
        },
        "displayName":{
            "type":"string",
            "description":"the display name of the target"
        },
        "properties":{
            "type":"array",
            "description":"the properties to be updated",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            }
        },
        "credentials":{
            "type":"object",
            "description":"the credentials to be updated",
            "additionalProperties":{
                "type":"string"
            }
        },
        "accessPoint":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/NameTypePair"
                }
            ],
            "description":"the access point for this update"
        }
    }
}

ネストされたスキーマ: accessPoint

この更新のアクセス・ポイント

すべてに一致

この更新のアクセス・ポイント

ソースの表示

• object NameTypePair
  名前とタイプのペア。

{
    "allOf":[
        {
            "$ref":"#/components/schemas/NameTypePair"
        }
    ],
    "description":"the access point for this update"
}

ネストされたスキーマ: credentials

型: object

使用可能なその他のプロパティ

ソースの表示

• string

{
    "type":"object",
    "description":"the credentials to be updated",
    "additionalProperties":{
        "type":"string"
    }
}

更新する資格証明

ネストされたスキーマ: properties

型: array

更新するプロパティ

ソースの表示

• 配列: object TargetPropertySummary
  ターゲット・プロパティでは、ターゲットのプロパティがID、名前、表示名および値によって説明されます。

{
    "type":"array",
    "description":"the properties to be updated",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    }
}

ネストされたスキーマ: NameTypePair

型: object

名前とタイプのペア。

ソースの表示

• name: string
  名前
• type: string
  タイプ

{
    "x-em-sdk-level":"emSDK",
    "description":"A pair of name and type.",
    "type":"object",
    "properties":{
        "name":{
            "description":"the name",
            "type":"string"
        },
        "type":{
            "description":"the type",
            "type":"string"
        }
    }
}

ネストされたスキーマ: TargetPropertySummary

型: object

ターゲット・プロパティでは、ターゲットのプロパティがID、名前、表示名および値によって説明されます。

ソースの表示

• displayName: string
  クライアント・ロケールでのプロパティ名。クライアントロケールが不明またはサポートされていない場合、これは名前と同じです。
• id: string
  プロパティID。これはプロパティの内部名です
• name: string
  英語のプロパティ名。
• value: string
  プロパティ値。

{
    "x-em-sdk-level":"emSDK",
    "description":"A target property describes a property of a target by id, name, display name and the value",
    "type":"object",
    "properties":{
        "id":{
            "description":"the property id. This is the internal name of the property",
            "type":"string"
        },
        "name":{
            "description":"the English property name.",
            "type":"string"
        },
        "displayName":{
            "description":"the property name in the client locale. If the client locale is unknown or not supported this is the same as the name.",
            "type":"string"
        },
        "value":{
            "description":"the property value.",
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功レスポンス

本文()

ルート・スキーマ: schema

型: object

ターゲットの詳細

ソースの表示

• targetName: string
  ターゲットの名前

  例: sales_db1
• targetType: string
  ターゲットのタイプ

  例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

400レスポンス

サポート対象外のプロパティなど、処理エラーや無効な引数があったことを示しています。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

クライアントが認証されていません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

ターゲットが見つからないか、権限がありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

リクエスト処理中の内部エラー

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

必要なサービスが使用不可であることを示しています。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る