REST API - find

REST API - find

com.vmware.content.library.item

The item service provides operations for managing library items.

find

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

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

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/item" 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 library items matching the given spec. Id of type com.vmware.content.library.Item.

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

Copyright © 2014. All Rights Reserved.