This API has a deprecated equivalent from v7.0U1.
Find Item
Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested Item.FindSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.Library referenced by the attribute Item.FindSpec.library-id requires System.Read.
Request
URLURL
https://{api_host}/api/content/library/item?action=find
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
LibraryItemFindSpec of mimetype application/json
Required
Specification describing what properties to filter on.
{
"cached": false,
"library_id": "string",
"name": "string",
"source_id": "string",
"type": "string"
}
boolean
cached
Optional
Whether the item is cached. Possible values are ‘true’ or ‘false’. See ItemModel.cached. If not specified all library items are searched.
string
library_id
Optional
The identifier of the library containing the item. See ItemModel.library-id. If not specified all libraries are searched. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.
string
name
Optional
The name of the library item. The name is case-insensitive. See ItemModel.name. If not specified all library item names are searched.
string
source_id
Optional
The identifier of the library item as reported by the publisher. See ItemModel.source-id. If not specified all library items are searched. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.
string
type
Optional
The type of the library item. The type is case-insensitive. See ItemModel.type. If not specified all types are searched.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
string
of type application/json
The list of identifiers of all the visible library items matching the given spec. The result will contain identifiers for the resource type: com.vmware.content.library.Item.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LibraryItemFindSpec = Initialize-LibraryItemFindSpec -Name "MyName" -LibraryId "MyLibraryId" -SourceId "MySourceId" -Type "MyType" -Cached $false
Invoke-FindLibraryItem -LibraryItemFindSpec $LibraryItemFindSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cached":false,"library_id":"string","name":"string","source_id":"string","type":"string"}' https://{api_host}/api/content/library/item?action=find
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item?~action=find
x-vmw-doc-operation: find
Availability
Added in 7.0U2
On This Page
Item Operations
post
get
patch
delete
post
post
post
get
