Query Catalogs

Query Catalogs

Retrieves a list of Org-scoped (if applicable) catalogs. Results can be filtered by id, name. If no organization scope is provided, catalogs from all organizations are returned.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/catalogs
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Catalogs of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineCatalogs1 
{
    "0": "P",
    "1": "a",
    "2": "g",
    "3": "e",
    "4": " ",
    "5": "O",
    "6": "b",
    "7": "j",
    "8": "e",
    "9": "c",
    "10": "t",
    "values": [
        {
            "id": "string",
            "sourceId": "string",
            "name": "string",
            "description": "string",
            "org": {
                "name": "string",
                "id": "string"
            },
            "isPublished": false,
            "isSubscribed": false,
            "isShared": false,
            "creationDate": "string",
            "owner": {
                "name": "string",
                "id": "string"
            },
            "versionNumber": 0,
            "numberOfVAppTemplates": 0,
            "numberOfMedia": 0,
            "catalogStorageProfiles": [
                {
                    "name": "string",
                    "id": "string"
                }
            ],
            "publishConfig": {
                "catalogPublishedUrl": "string",
                "isCachedEnabled": false,
                "preserveIdentityInfo": false,
                "password": "string"
            },
            "subscriptionConfig": {
                "subscriptionUrl": "string",
                "password": "string",
                "needLocalCopy": false
            },
            "distributedCatalogConfig": {
                "isDistributed": false,
                "isReadOnly": false,
                "distributedCatalogId": "string"
            }
        }
    ]
}

Availability
Added in 40.0.0-alpha
On This Page
Catalog Operations
GET
Get Catalog
GET
Query Catalog Issues
GET
Query Catalog Peers
GET
Query Catalogs
POST
Refresh Catalog