Jump to

• Request
• Response

Modify an existing global target property

patch

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

This api modifies an existing global target property identified by the given id.

Request

Path Parameters

• id(required): string
  the global target property id

Supported Media Types

• application/json+merge-patch

Request Body - application/json+merge-patch ()

Root Schema : schema

Type: object

The payload used to modify an existing target

Show Source

• addValidValues: array addValidValues
  The valid values to add
• hasValidValuesEnabled: boolean
  Indicates if target property values added to targets should be checked against the valid values list

  Example: false
• isCopyValidValuesFromTargets: boolean
  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
• name: string
  The new name of the property

  Example: My Updated Property Name
• removeValidValues: array removeValidValues
  The valid values to remove

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

Nested Schema : addValidValues

Type: array

The valid values to add

Show Source

• Array of: string

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

Example:

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

Nested Schema : removeValidValues

Type: array

The valid values to remove

Show Source

• Array of: string

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

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Response

Body ()

Root Schema : GlobalTargetProperty

Type: object

This is the representation of an EM target resource.

Show Source

• displayName(required): string
  the property display name in the client locale

  Example: Location
• hasValidValuesEnabled: boolean
  Indicates if target property values added to targets should be checked against the valid values list.

  Example: true
• id(required): string
  the target property id

  Example: orcl_gtp_location
• links: object links
  the target related links
• name(required): string
  the target property name

  Example: Location
• validValues: array validValues
  the valid values for this property

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

Nested Schema : links

Type: object

the target related links

Show Source

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

Nested Schema : validValues

Type: array

the valid values for this property

Show Source

• Array of: string

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

Example:

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

Nested Schema : self

Match All

Show Source

• object Link
  Represents a link(could be self, previous or next)
• The link to the target property
• Example: { "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"
            }
        }
    ]
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /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 Response

indicates that there has been a processing error or an illegal argument, like an unsupported property.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

target not found or not authorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error 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"
        }
    }
}

Back to Top