Get Catalog Items Using GET 3

Returns a paginated list of catalog items.

Request

URI

GET

https://{api_host}//sc2-10-185-6-200.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

integer

$top

Optional

Number of records you want

$top example

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

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

Returns PageOfCatalogItem of type(s) application/json

{
    "content": [
        {
            "bulkRequestLimit": 0,
            "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"
            }
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "totalElements": 0,
    "totalPages": 0
}

array of CatalogItem

content

Optional

content

boolean

empty

Optional

empty

boolean

first

Optional

first