Find Item
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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}/rest/com/vmware/content/library/item?~action=find
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains LibraryItemFindRequestBody
of type application/json
(required)
{
"spec": {
"cached": false,
"library_id": "string",
"name": "string",
"source_id": "string",
"type": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | LibraryItemFindSpec |
Specification describing what properties to filter on. |
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemFindResponseBody
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.
{
"value": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of string |
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. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"cached":false,"library_id":"string","name":"string","source_id":"string","type":"string"}}' https://{api_host}/rest/com/vmware/content/library/item?~action=find
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if no properties are specified in the spec. |
| default | ErrorRest | Not available |
On This Page
Item Operations
get
post
get
patch
delete
post
post
post
