List Resource Types

List Resource Types

Returns a paginated list of Resource Types.

Request
URI
GET
https://{api_host}/deployment/api/resource-types
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
Constraints: default: name,ASC

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

string of array
ids
Optional

Filter by list of resource type ids

string of array
projectIds
Optional

Filter by list of project ids

string
search
Optional

Search by name and description

string
providerId
Optional

Filter by provider ID

boolean
composableOnly
Optional

Include only composable resource types

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 PageResourceType of type(s) application/json 
{
    "content": [
        {
            "accountType": "string",
            "composable": false,
            "createdAt": "string",
            "createdBy": "string",
            "description": "string",
            "displayName": "string",
            "id": "string",
            "name": "string",
            "orgId": "string",
            "projectId": "string",
            "providerId": "string",
            "schema": {
                "$data": "string",
                "$dynamicDefault": "string",
                "$ref": "string",
                "additionalProperties": false,
                "allOf": [
                    "ProviderSchemaImpl Object"
                ],
                "anyOf": [
                    "ProviderSchemaImpl Object"
                ],
                "computed": false,
                "const": {},
                "default": {},
                "dependencies": {
                    "dependencies": [
                        "string"
                    ]
                },
                "description": "string",
                "encrypted": false,
                "enum": [
                    {}
                ],
                "format": "string",
                "formatMaximum": "string",
                "formatMinimum": "string",
                "ignoreCaseOnDiff": false,
                "ignoreOnUpdate": false,
                "items": "ObjectOrListProviderSchemaImpl Object",
                "maxItems": 0,
                "maxLength": 0,
                "maxProperties": 0,
                "maximum": "number",
                "minItems": 0,
                "minLength": 0,
                "minProperties": 0,
                "minimum": "number",
                "not": "ProviderSchemaImpl Object",
                "oneOf": [
                    "ProviderSchemaImpl Object"
                ],
                "pattern": "string",
                "patternProperties": {
                    "patternProperties": "ProviderSchemaImpl Object"
                },
                "properties": {
                    "properties": "ProviderSchemaImpl Object"
                },
                "readOnly": false,
                "recreateOnUpdate": false,
                "required": [
                    "string"
                ],
                "title": "string",
                "type": "string",
                "uniqueItems": false,
                "writeOnly": false
            },
            "updatedAt": "string",
            "updatedBy": "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

content

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 PageResourceType of type(s) application/json 
"PageResourceType Object"
array of object
content
Optional

content

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}/deployment/api/resource-types
On This Page
Resource Types Operations
GET
List Resource Types
GET
Get Resource Type