Jump to

• Request
• Response

Create a new global target property

post

https://EM_HOST:8080/em/api/globalTargetProperties

This api creates a new global target property resource with the given data. If the resource already exists an error is returned. Note - For user defined properties the name and the displayName are the same.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload needed for a target creation request.

Show Source

• 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: my_prop
• name(required): string
  the target property name

  Example: My Property
• validValues: array validValues
  the valid values for this property

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload needed for a target creation request.",
    "type":"object",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "description":"the target property id",
            "type":"string",
            "example":"my_prop"
        },
        "name":{
            "description":"the target property name",
            "type":"string",
            "example":"My Property"
        },
        "hasValidValuesEnabled":{
            "description":"Indicates if target property values added to targets should be checked against the valid values list.",
            "type":"boolean",
            "example":true
        },
        "validValues":{
            "type":"array",
            "description":"the valid values for this property",
            "items":{
                "type":"string"
            },
            "example":[
                "My Value",
                "My Other Value"
            ]
        }
    }
}

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":[
        "My Value",
        "My Other Value"
    ]
}

Example:

[
    "My Value",
    "My Other Value"
]

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

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

illegal arguments or incomplete resource definition

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

409 Response

not authorized or target already exists

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