Get target properties
get
https://EM_HOST:8080/em/api/targets/{targetId}/properties
This API returns the target properties of the target identified by the given id. Clients can optionally query for details of a specific set of properties by giving their names or ids. No error is reported if an unsupported property is given.
Request
Path Parameters
-
targetId(required): string
the target id
Query Parameters
-
id: array[string]
the id of the property
-
limit: integer(int32)
Minimum Value:
1
Maximum Value:2000
to limit the number of rows returned. If the result set is greater follow the previous and next links in the results.Example:20
-
name: array[string]
the name of the property
-
page: string
system generated page token used in the self, next and previous links.
-
sort: string
The sort field and direction. Allowed sort fields are name and id. Allowed directions are DESC and ASCExample:
id:ASC
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : TargetPropertyCollection
Type:
object
This is the representation of list of target references.
Show Source
-
count(required): integer
the number of items in this pageExample:
20
-
items(required): array
items
the target references
-
links(required): object
links
the result set navigation links
-
total: integer
the total number of resultsExample:
42
Nested Schema : items
Type:
array
the target references
Show Source
-
Array of:
object TargetPropertySummary
A target property describes a property of a target by id, name, display name and the value
Nested Schema : TargetPropertySummary
Type:
object
A target property describes a property of a target by id, name, display name and the value
Show Source
-
displayName: string
the property name in the client locale. If the client locale is unknown or not supported this is the same as the name.
-
id: string
the property id. This is the internal name of the property
-
name: string
the English property name.
-
value: string
the property value.
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
401 Response
client is not authenticated
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
404 Response
target not found or not authorized
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
500 Response
internal error serving the request
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
503 Response
indicates that a required service is not available.
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