移動先

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

ターゲットのプロパティの更新または作成

post

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

指定されたIDで特定されたターゲットのプロパティを更新します

リクエスト

パス・パラメータ

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

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

• application/json

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

ルート・スキーマ: schema

型: object

ターゲット・プロパティを作成または更新するペイロード

ソースの表示

• propagateToMembers: boolean
  プロパティの変更をメンバー・ターゲットに伝播するかどうかを示します。

  例: false
• properties: array properties
  設定するターゲット・プロパティ

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to create or update target properties",
    "type":"object",
    "properties":{
        "propagateToMembers":{
            "description":"indicates if the property changes shall get propagated to member targets.",
            "type":"boolean",
            "example":false
        },
        "properties":{
            "description":"the target properties to set",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TargetPropertySummary"
            },
            "example":[
                {
                    "id":"orcl_gtp_os",
                    "name":"Operating System",
                    "displayName":"Betriebssystem",
                    "value":"Linux"
                },
                {
                    "id":"orcl_gtp_platform",
                    "name":"Platform",
                    "displayName":"Plattform",
                    "value":"x86_64"
                }
            ]
        }
    }
}

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

型: array

設定するターゲット・プロパティ

ソースの表示

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

{
    "description":"the target properties to set",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TargetPropertySummary"
    },
    "example":[
        {
            "id":"orcl_gtp_os",
            "name":"Operating System",
            "displayName":"Betriebssystem",
            "value":"Linux"
        },
        {
            "id":"orcl_gtp_platform",
            "name":"Platform",
            "displayName":"Plattform",
            "value":"x86_64"
        }
    ]
}

例:

[
    {
        "id":"orcl_gtp_os",
        "name":"Operating System",
        "displayName":"Betriebssystem",
        "value":"Linux"
    },
    {
        "id":"orcl_gtp_platform",
        "name":"Platform",
        "displayName":"Plattform",
        "value":"x86_64"
    }
]

ネストされたスキーマ: 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レスポンス

OK

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"
        }
    }
}

先頭に戻る