Get Page

Get Page

Returns a paginated list of catalog sources.

Request
URI
GET
https://{api_host}/catalog/api/admin/sources
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional

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

string
search
Optional

Matches will have this string in their name or description.

string
projectId
Optional

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

string
typeId
Optional

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

integer
$top
Optional

Number of records you want

$top example
1
integer
$skip
Optional

Number of records you want to skip

$skip example
1
string
$orderby
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageCatalogSource of type(s) application/json 
{
    "content": [
        {
            "config": {},
            "createdAt": "string",
            "createdBy": "string",
            "creator": {
                "email": "string",
                "firstname": "string",
                "id": "string",
                "lastname": "string",
                "type": "string"
            },
            "description": "string",
            "global": false,
            "iconId": "string",
            "id": "string",
            "itemsFound": 0,
            "itemsImported": 0,
            "lastImportCompletedAt": "string",
            "lastImportErrors": [
                "string"
            ],
            "lastImportStartedAt": "string",
            "lastUpdatedAt": "string",
            "lastUpdatedBy": "string",
            "lastUpdater": {
                "email": "string",
                "firstname": "string",
                "id": "string",
                "lastname": "string",
                "type": "string"
            },
            "name": "string",
            "originOrgId": "string",
            "projectId": "string",
            "typeId": "string"
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": [
            {
                "ascending": false,
                "direction": "string",
                "ignoreCase": false,
                "nullHandling": "string",
                "property": "string"
            }
        ],
        "unpaged": false
    },
    "size": 0,
    "sort": [
        {
            "ascending": false,
            "direction": "string",
            "ignoreCase": false,
            "nullHandling": "string",
            "property": "string"
        }
    ],
    "totalElements": 0,
    "totalPages": 0
}
array of object
content
Optional

The catalog source to be created

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


401

Unauthorized

Returns PageCatalogSource of type(s) application/json 
"PageCatalogSource Object"
array of object
content
Optional

The catalog source to be created

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/catalog/api/admin/sources
On This Page
Catalog Sources Operations
GET
Get Page
POST
Post
DELETE
Delete 2
GET
Get