移動先

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

既存のグローバル・ターゲット・プロパティの変更

patch

https://EM_HOST:8080/em/api/globalTargetProperties/{globalTargetPropertyID}

このAPIは、指定されたIDで特定された既存のグローバル・ターゲット・プロパティを変更します。

リクエスト

パス・パラメータ

• id(必須): string
  グローバル・ターゲット・プロパティID

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

• application/json+merge-patch

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

ルート・スキーマ: schema

型: object

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

ソースの表示

• addValidValues: array addValidValues
  追加する有効な値
• hasValidValuesEnabled: boolean
  ターゲットに追加されたターゲット・プロパティ値を有効値リストと照合するかどうかを示します

  例: false
• isCopyValidValuesFromTargets: boolean
  ターゲットの既存のターゲット・プロパティ値を有効値リストに追加するかどうかを示します。有効にすると、有効値リストに、すでに使用されている値がすべて含まれるようになります。

  例: true
• name: string
  プロパティの新しい名前

  例: My Updated Property Name
• removeValidValues: array removeValidValues
  削除する有効値

{
    "x-em-sdk-level":"emSDK",
    "description":"The payload used to modify an existing target",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The new name of the property",
            "example":"My Updated Property Name"
        },
        "hasValidValuesEnabled":{
            "type":"boolean",
            "description":"Indicates if target property values added to targets should be checked against the valid values list",
            "example":false
        },
        "addValidValues":{
            "type":"array",
            "description":"The valid values to add",
            "items":{
                "type":"string"
            },
            "example":[
                "New valid value",
                "Another new valid value"
            ]
        },
        "removeValidValues":{
            "type":"array",
            "description":"The valid values to remove",
            "items":{
                "type":"string"
            },
            "example":[
                "Old value",
                "Another old value"
            ]
        },
        "isCopyValidValuesFromTargets":{
            "type":"boolean",
            "description":"Indicates if existing target property values from targets should be added to the valid values list so that when enabled the valid values list contains all already used values",
            "example":true
        }
    }
}

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

型: array

追加する有効な値

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"The valid values to add",
    "items":{
        "type":"string"
    },
    "example":[
        "New valid value",
        "Another new valid value"
    ]
}

例:

[
    "New valid value",
    "Another new valid value"
]

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

型: array

削除する有効値

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"The valid values to remove",
    "items":{
        "type":"string"
    },
    "example":[
        "Old value",
        "Another old value"
    ]
}

例:

[
    "Old value",
    "Another old value"
]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功レスポンス

本文()

ルート・スキーマ: GlobalTargetProperty

型: object

これはEMターゲット・リソースを表すものです。

ソースの表示

• displayName(必須): string
  クライアント・ロケールでのプロパティ表示名

  例: Location
• hasValidValuesEnabled: boolean
  ターゲットに追加されたターゲット・プロパティ値を有効値リストと照合するかどうかを示します。

  例: true
• id(必須): string
  ターゲット・プロパティID

  例: orcl_gtp_location
• links: object links
  ターゲット関連リンク
• name(必須): string
  ターゲット・プロパティ名

  例: Location
• validValues: array validValues
  このプロパティの有効値

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of an EM target resource.",
    "type":"object",
    "required":[
        "id",
        "name",
        "displayName"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"the target property id",
            "example":"orcl_gtp_location"
        },
        "name":{
            "type":"string",
            "description":"the target property name",
            "example":"Location"
        },
        "displayName":{
            "type":"string",
            "description":"the property display name in the client locale",
            "example":"Location"
        },
        "hasValidValuesEnabled":{
            "type":"boolean",
            "description":"Indicates if target property values added to targets should be checked against the valid values list.",
            "example":true
        },
        "validValues":{
            "type":"array",
            "description":"the valid values for this property",
            "items":{
                "type":"string"
            },
            "example":[
                "London",
                "Paris",
                "Rome"
            ]
        },
        "links":{
            "type":"object",
            "description":"the target related links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the target property"
                        },
                        {
                            "example":{
                                "href":"/em/api/targetProperties/orcl_gtp_location"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: object

ターゲット関連リンク

ソースの表示

• self: self

{
    "type":"object",
    "description":"the target related links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the target property"
                },
                {
                    "example":{
                        "href":"/em/api/targetProperties/orcl_gtp_location"
                    }
                }
            ]
        }
    }
}

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

型: array

このプロパティの有効値

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"the valid values for this property",
    "items":{
        "type":"string"
    },
    "example":[
        "London",
        "Paris",
        "Rome"
    ]
}

例:

[
    "London",
    "Paris",
    "Rome"
]

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

すべてに一致

ソースの表示

• object Link
  リンクを表します(self、previous、nextのいずれか)
• ターゲット・プロパティへのリンク
• 例: { "href":"/em/api/targetProperties/orcl_gtp_location" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the target property"
        },
        {
            "example":{
                "href":"/em/api/targetProperties/orcl_gtp_location"
            }
        }
    ]
}

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

• href: string
  リンクのためのURL

  例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

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

先頭に戻る