REST API - list

REST API - list

com.vmware.content.library.item

The item service provides operations for managing library items.

list

GET /com/vmware/content/library/item
POST /com/vmware/content/library/item/id:{library_id}?~action=list
POST /com/vmware/content/library/item?~action=list

Returns the identifiers of all items in the given library.
Request:
Representations:
{
    "library_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:List-Input xmlns:ns0="http://vmware.com/content/library/item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_id>obj-103</library_id>
</ns0:List-Input>
GET /com/vmware/content/library/item
?library_id=obj-103

Parameters:
Name Type Required Description
library_id
 *
 ID Yes Identifier of the library whose items should be returned. Id of type com.vmware.content.Library.

Response:
Representations:
{
    "value": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:List-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:List-Result>

Parameters:
Name Type Required Description
result List<ID> Yes The array of identifiers of the items in the library specified by library_id. Id of type com.vmware.content.library.Item.

Errors:
Type Description HTTP Status Code
not_found if the library associated with library_id does not exist. 404

Copyright © 2014. All Rights Reserved.