REST API - result

cis data provider resource model: result set

Contains the data returned in response to a particular query instance.

Representation:

JSON

{
    "total_count" : 1,
    "items" : [
        {
            "property_values" : [
                "opaque_string_value",
                "opaque_string_value"
            ]
        },
        {
            "property_values" : [
                "opaque_string_value",
                "opaque_string_value"
            ]
        }
    ],
    "properties" : [
        "string",
        "string"
    ]
}

Attributes:

Name	Type	Description
Required
properties	string[]	The names of the (resource model) properties (as requested in cis.data.provider.resource_model.query_spec.properties) returned for each resource item in the result set. The position (index) of each model property in this list corresponds to the position of the model property value in each resource item's values list. That is, the name of each resource model property in the cis.data.provider.resource_model.resource_item.property_values list is given by the string with the same index (position) in this list. Could be empty only in case the cis.data.provider.resource_model.result_set.items list is empty.
items	resource_item[]	The list of result items. Each item corresponds to a particular resource that matched the conditions in the specified cis.data.provider.resource_model.query_spec instance and containing the property data retrieved for that resource. Could be empty if no items matched the query.
items[].property_values	opaque[]	The model property values for the resource. The name of each model property value is given by the model property name with the same index in cis.data.provider.resource_model.result_set.properties. In other words, the position of a property value in this list should be the same as the position of the property in the cis.data.provider.resource_model.result_set.properties list.
Optional
total_count	long	The total number of resources that matched the query, regardless of the actual number that is returned in cis.data.provider.resource_model.result_set.items. Optional. This value is set if and only if it has been explicitly requested in the query, i.e. if the cis.data.provider.resource_model.query_spec.return_total_count flag has been set to `true`.