Get Catalog Items Using GET 1

Get Catalog Items Using GET 1

Returns a paginated list of catalog items.

Request
URI
GET
https://{api_host}//cava-s-182-041.eng.vmware.com/catalog/api/items
COPY
Query Parameters
string of array
$orderby
Optional

Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

integer
$skip
Optional

Number of records you want to skip

$skip example
1
integer
$top
Optional

Number of records you want

$top example
1
boolean
expandProjects
Optional

Whether or not to return detailed project data for each result.

string of array
projects
Optional

A list of project IDs. Results will belong to one of these projects.

string
search
Optional

Matches will have this string somewhere in their name or description.

string of array
types
Optional

A list of Catalog Item Type IDs. Results will be one of these types.

Responses
200

OK

Returns CatalogItem of type(s) application/json 
{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "iconId": "string",
    "id": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectIds": [
        "string"
    ],
    "projects": [
        {
            "id": "string",
            "link": "string",
            "name": "string"
        }
    ],
    "sourceId": "string",
    "sourceName": "string",
    "type": {
        "id": "string",
        "link": "string",
        "name": "string"
    }
}
string As date-time As date-time
createdAt
Optional

Creation time

string
createdBy
Optional

Created By

string
description
Optional

CatalogItem description

string As uuid As uuid
iconId
Optional

Icon ID

string As uuid As uuid
id
Required

CatalogItem id

string As date-time As date-time
lastUpdatedAt
Optional

Update time

string
lastUpdatedBy
Optional

Updated By

string
name
Required

CatalogItem name

array of string
projectIds
Required

Associated project IDs that can be used for requesting

array of ResourceReference
projects
Optional

Associated projects that can be used for requesting

object
schema
Optional

Json schema describing request parameters, a simplified version of http://json-schema.org/latest/json-schema-validation.html#rfc.section.5

string As uuid As uuid
sourceId
Optional

LibraryItem source ID.

string
sourceName
Optional

LibraryItem source name.

ResourceReference
type
Required

type


401

Unauthorized

Operation doesn't return any data structure

On This Page
Catalog Items Operations
GET
Get Catalog Items Using GET 1
GET
Get Catalog Item Using GET 1
GET
Get Upfront Price Response For Catalog Item Using GET
GET
Get Version By Id Using GET
GET
Get Versions Using GET
POST
Request Catalog Item Using POST
POST
Submit Upfront Price Request For Catalog Item Using POST