List Resource Types Using GET

List Resource Types Using GET

Lists resource types

Request
URI
GET
https://{api_host}/blueprint/api/resource-types
COPY
Query Parameters
string
name
Optional

Filter by name

string
providerId
Optional

Filter by provider ID

string
search
Optional

Search by name and description

boolean
expand
Optional
Constraints: default: true

Expand with content

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
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about

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 on name. Sorting is supported on fields createdAt, updatedAt, createdBy, updatedBy, name.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageResourceType of type(s) application/json 
{
    "content": [
        {
            "createdAt": "string",
            "createdBy": "string",
            "description": "string",
            "displayName": "string",
            "endpointType": "string",
            "id": "string",
            "name": "string",
            "operations": {
                "operations": "string"
            },
            "orgId": "string",
            "providerId": "string",
            "providerName": "string",
            "providerVersion": "string",
            "schema": {
                "$data": "string",
                "$dynamicDefault": "string",
                "$ref": "string",
                "additionalProperties": false,
                "allOf": [
                    "PropertyDefinition Object"
                ],
                "anyOf": [
                    "PropertyDefinition Object"
                ],
                "computed": false,
                "const": {},
                "default": {},
                "dependencies": {
                    "dependencies": [
                        "string"
                    ]
                },
                "description": "string",
                "encrypted": false,
                "enum": [
                    {}
                ],
                "format": "string",
                "ignoreCaseOnDiff": false,
                "ignoreOnUpdate": false,
                "items": "PropertyDefinition Object",
                "maxItems": 0,
                "maxLength": 0,
                "maxProperties": 0,
                "maximum": 0,
                "metadata": {
                    "metadata": {}
                },
                "minItems": 0,
                "minLength": 0,
                "minProperties": 0,
                "minimum": 0,
                "not": "PropertyDefinition Object",
                "oneOf": [
                    "PropertyDefinition Object"
                ],
                "pattern": "string",
                "properties": {
                    "properties": "PropertyDefinition Object"
                },
                "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": {
            "empty": false,
            "sorted": false,
            "unsorted": false
        },
        "unpaged": false
    },
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "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

object
sort
Optional

sort

integer As int64 As int64
totalElements
Optional

totalElements

integer As int32 As int32
totalPages
Optional

totalPages


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/blueprint/api/resource-types
On This Page
Resource Types Operations
GET
List Resource Types Using GET
GET
Get Resource Type Using GET