Get Page Using GET

Get Page Using GET

Returns a paginated list of catalog sources.

Request
URI
GET
https://{api_host}//api.mgmt.cloud.vmware.com/catalog/api/admin/sources
COPY
Query Parameters
integer
page
Optional

Results page you want to retrieve (0..N)

string
projectId
Optional

Find sources which contains items that can be requested in the given projectId

string
search
Optional

Matches will have this string in their name or description.

integer
size
Optional

Number of records per page.

size example 
20
string of array
sort
Optional

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

Responses
200

OK

Returns CatalogSource of type(s) */* 
{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "global": false,
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectId": "string",
    "typeId": "string"
}
object
config
Required

Source custom configuration

string As date-time As date-time
createdAt
Optional

Creation time

string
createdBy
Optional

Created By

string
description
Optional

Catalog Source description

boolean
global
Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid
id
Required

Catalog Source id

integer As int32 As int32
itemsFound
Optional

Number of items found

integer As int32 As int32
itemsImported
Optional

Number of items imported.

string As date-time As date-time
lastImportCompletedAt
Optional

Last import completion time

array of string
lastImportErrors
Optional

Last import error(s)

string As date-time As date-time
lastImportStartedAt
Optional

Last import start time

string As date-time As date-time
lastUpdatedAt
Optional

Update time

string
lastUpdatedBy
Optional

Updated By

string
name
Required

Catalog Source name

string
projectId
Optional

Project id where the source belongs

string
typeId
Required

Type of source, e.g. blueprint, CFT... etc


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Catalog Sources Operations
DELETE
Delete Using DELETE
GET
Get Page Using GET
GET
Get Using GET
POST
Post Using POST