REST API - find

REST API - find

com.vmware.content.library

The library service provides operations to manage and find com.vmware.content.library_model entities.

The library service provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this service will not affect the properties specific to the type of library. See also com.vmware.content.local_library and com.vmware.content.subscribed_library.

find

POST /com/vmware/content/library?~action=find

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested com.vmware.content.library.find_spec.
Request:
Representations:
{
    "spec": {
        "name": "string",
        "type": "LOCAL"
    }
}
<?xml version="1.0" ?>
<ns0:Find-Input xmlns:ns0="http://vmware.com/content/library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <spec>
    <name>string</name>
    <type>LOCAL</type>
  </spec>
</ns0:Find-Input>
POST /com/vmware/content/library?~action=find
&spec.name=string
&spec.type=LOCAL

Parameters:
Name Type Required Description
spec
 *
 find_spec Yes Specification describing what properties to filter on.

Response:
Representations:
{
    "value": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:Find-Result xmlns:ns0="http://vmware.com/content/library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </value-array>
</ns0:Find-Result>

Parameters:
Name Type Required Description
result List<ID> Yes The array of identifiers of all the visible libraries matching the given spec. Id of type com.vmware.content.Library.

Errors:
Type Description HTTP Status Code
invalid_argument if no properties are specified in the spec. 400

Copyright © 2014. All Rights Reserved.