REST API - fingerprint

REST API - fingerprint

com.vmware.vapi.metadata.metamodel.component

The component service providers operations to retrieve metamodel information of a component element.

A component defines a set of functionality that is deployed together and versioned together. For example, all the services that belong to VMware Content Library are part of a single component. A component element describes a component. A component element contains one or more package elements.

The operations for package elements are provided by service com.vmware.vapi.metadata.metamodel.package.

fingerprint

POST /com/vmware/vapi/metadata/metamodel/component/id:{component_id}?~action=fingerprint
POST /com/vmware/vapi/metadata/metamodel/component?~action=fingerprint

Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to component_id.

The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get.

Request:
Representations:
{
    "component_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Fingerprint-Input xmlns:ns0="http://vmware.com/vapi/metadata/metamodel/component" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <component_id>obj-103</component_id>
</ns0:Fingerprint-Input>
POST /com/vmware/vapi/metadata/metamodel/component?~action=fingerprint
&component_id=obj-103

Parameters:
Name Type Required Description
component_id
 *
 ID Yes Identifier of the component element. Id of type com.vmware.vapi.component.

Response:
Representations:
{
    "value": "string"
}
<?xml version="1.0" ?>
<ns0:Fingerprint-Result xmlns:ns0="http://vmware.com/vapi/metadata/metamodel/component" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>string</value>
</ns0:Fingerprint-Result>

Parameters:
Name Type Required Description
result string Yes The fingerprint computed from the metamodel metadata of the component element.

Errors:
Type Description HTTP Status Code
not_found if the component element associated with component_id is not registered with the infrastructure. 404

Copyright © 2014. All Rights Reserved.