Content Library Item find

Content Library Item find

Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested Content Library Item FindSpec.

Returns an authorization error 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 property Content Library Item FindSpec.library_id requires System.Read.
Request
URI
POST
https://{api_host}/api/content/library/item?action=find
COPY
Request Body

Specification describing what properties to filter on.

Content Library Item FindSpec of type(s) application/json
Required 
{
    "name": "string",
    "library_id": "string",
    "source_id": "string",
    "type": "string",
    "cached": false
}
string
name
Optional

The name of the library item. The name is case-insensitive. See Content Library ItemModel.name.

If not specified all library item names are searched.

string
library_id
Optional

The identifier of the library containing the item. See Content Library ItemModel.library_id.

If not specified all libraries are searched.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.

string
source_id
Optional

The identifier of the library item as reported by the publisher. See Content Library ItemModel.source_id.

If not specified all library items are searched.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this schema as a response, the property 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 Content Library ItemModel.type.

If not specified all types are searched.

boolean
cached
Optional

Whether the item is cached. Possible values are 'true' or 'false'. See Content Library ItemModel.cached.

If not specified all library items are searched.

Authentication
This operation uses the following authentication methods.
Responses
200

The list of identifiers of all the visible library items matching the given spec.

The response will contain identifiers for the resource type: com.vmware.content.library.Item.

[
    {}
]
array of string
Optional

400

if no properties are specified in the spec.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/content/library/item?action=find
On This Page
Content Operations
POST
Content Library Item copy
POST
Content Library Item create
GET
Content Library Item get
DELETE
Content Library Item delete
PATCH
Content Library Item update
GET
Content Library Item list
POST
Content Library Item find
POST
Content Library Item publish