Query Latest Properties Of Resources

Get current (latest) values of requested properties for the specified resources

Request

URI

POST

https://{api_host}/suite-api/api/resources/properties/latest/query

COPY

Request Body

The query spec

properties-query of type(s) application/json

Required

Show optional properties

{
    "resourceIds": [
        {}
    ],
    "propertyKeys": [
        {}
    ]
}

"{\n  \"resourceIds\" : [ \"adf33414-9fe2-4a8c-bad6-4a574145269b\", \"b394ba9c-e1c7-43e9-ba46-89b5784f6396\" ],\n  \"propertyKeys\" : [ \"prop|key1\", \"prop|key2\" ],\n  \"instanced\" : false\n}"

array of string

resourceIds

Required

Array of resource ids to fetch the properties for

array of string

propertyKeys

Required

Array of property keys to fetch the latest values for

boolean

instanced

Optional

Indicates whether specified property keys of query should be forcibly treated as instanced properties

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The mapping from requested resources to current (latest) values of specified properties

Returns resources-property-contents of type(s) application/json

"{\n  \"values\" : [ {\n    \"resourceId\" : \"1b0325d5-66e8-4be5-b710-723451b2366e\",\n    \"property-contents\" : {\n      \"property-content\" : [ {\n        \"statKey\" : \"system|availability\",\n        \"timestamps\" : [ 1119844280663 ],\n        \"values\" : [ \"UP\" ]\n      }, {\n        \"statKey\" : \"config|num|processes\",\n        \"timestamps\" : [ 1119844280663 ],\n        \"data\" : [ 93.0 ]\n      } ]\n    }\n  }, {\n    \"resourceId\" : \"fed119a7-d139-4ae4-ae5f-1cd43d610f0b\",\n    \"property-contents\" : {\n      \"property-content\" : [ {\n        \"statKey\" : \"system|availability\",\n        \"timestamps\" : [ 1119844280663 ],\n        \"values\" : [ \"UP\" ]\n      }, {\n        \"statKey\" : \"config|num|processes\",\n        \"timestamps\" : [ 1119844280663 ],\n        \"data\" : [ 93.0 ]\n      } ]\n    }\n  } ]\n}"

array of object

values

Optional

Collection of resource property contents

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"propertyKeys":["string"],"resourceIds":["string"]}' https://{api_host}/suite-api/api/resources/properties/latest/query

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Resources Operations