Get resource data

In order to get the data from deployed resources there are two types of requests. It is important to mention the differences since not all endpoints receive the latest data due to caching mechanism. Please note: There might be some general update limitation depending on the service. e.g. the Fileservice updates the resource informations about used storage from the hardware backend only every hours for performance reasons. This limit is appliceable for all vRA API requests.

GET

Get single resource by ID

Request

https://{{va-fqdn}}/catalog-service/api/consumer/resources/{id}

Details

Get a resource by its unique identifier. It retrieves a specific resource with its up to date Provider Data by its unique id.

{id} is the only parameter accepted.

Example

/catalog-service/api/consumer/resources/1e3e4b76-b1db-4c5f-ac74-e9126001eba7

More Details

Get API Consumer Resource

GET

Get multiple resources with filter

Request

https://{{va-fqdn}}/catalog-service/api/consumer/resourceViews$filter=((resourceType/id eq {ressourceTypeId}))

Details

This is an information message

Warning

For non-VM based (XaaS) deployments, this endpoint returns cached data and can therefore return outdated or non-existing data if a resource has not been fetched (recently) directly. We advise you to use this endpoint only to list XaaS deployments, but the single resource endpoint mentioned above to then fetch detailed information.

For VM based deployments, the withExtendedData flag can be used as mentioned below.

Usage:

Fetches the resources accessible to the current user. Adding data coming from providers can be expensive in terms of execution time, so the withExtendedData flag can be used to toggle this feature. This doesn't work for XaaS resources, only cached data will be returned. Populating operations on resources requires to evaluate the resource's state by calling its provider. This operation can be expensive in terms of execution time, so the optional withOperations flag can be used to toggle this feature.

@param withExtendedData: (optional) → doesn't work for XaaS resources

• true will populate resources' extended data by calling their provider.
• false will not populate resources' extended data.
• By default, false value is used.

@param withOperations: (optional)

• true will populate resources' operations attribute by calling the provider. This will force with ExtendedData to true.
• false will not populate resources' operations, i.e. the returned resources will not contain any resource operation.
• By default, false value is used.

Tips and restrictions:

withExtendedData=false and withOperations=false will be appended to API if not specified by user

Example

https://cmp.int-02.entcloud.swisscom.com/catalog-service/api/consumer/resourceViews?withExtendedData=false&$filter=((resourceType/id eq 'aat!::!dfb4a9e5-e0b2-424a-bfc9-86f28323d94b'))

More Details

Get API Consumer Resource

API Filtering