Get Component Types

Get Component Types

Get a list of component types visible to the caller.

Request
URI
GET
https://{api_host}/composition-service/api/componenttypes
COPY
Query Parameters
string
blueprintId
Optional

If true, return component types only for the specified blueprint. Filter and page information will be ignored.

string
fetchSchema
Optional

If true, include component type schema data in returned list.

integer
page
Optional

Page Number

integer
limit
Optional

Number of entries per page

string
$orderby
Optional

Multiple comma-separated properties sorted in ascending or descending order

integer
$top
Optional

Sets the number of returned entries from the top of the response (total number per page in relation to skip)

integer
$skip
Optional

Sets how many entries you would like to skip

string
$filter
Optional

Boolean expression for whether a particular entry should be included in the response

Responses
200

Success - return a page of component types.

Returns ComponentType of type(s) */* 
{
    "iconId": "string",
    "schema": {
        "fields": [
            {
                "permissibleValues": {
                    "customAllowed": false
                },
                "displayAdvice": "string",
                "columns": [
                    "Field Object"
                ],
                "dataType": {
                    "typeId": "string"
                },
                "isMultiValued": false,
                "description": "string",
                "orderIndex": 0,
                "id": "string",
                "label": "string",
                "state": {
                    "dependencies": [
                        "string"
                    ],
                    "facets": [
                        {}
                    ]
                }
            }
        ]
    },
    "catalogItemTypeId": "string",
    "supportLenientDestroy": false,
    "description": "string",
    "callbacks": {
        "rollback": false,
        "allocate": false,
        "requestDetails": false,
        "listOffers": false,
        "destroy": false,
        "clusterBehavior": "string",
        "validate": false
    },
    "outputResourceTypeId": "string",
    "version": 0,
    "idForEntitlements": "string",
    "lastUpdated": "string",
    "classId": "string",
    "createdDate": "string",
    "name": "string",
    "tenantId": "string",
    "requiredPermissionIds": [
        "string"
    ],
    "serviceTypeId": "string",
    "allocationRelatedResourceTypeIds": [
        "string"
    ],
    "id": "string",
    "serviceId": "string",
    "forms": {},
    "categoryId": "string",
    "containerFieldId": "string"
}
string
iconId
Optional

iconId

Schema
schema
Optional

schema

string
catalogItemTypeId
Optional

catalogItemTypeId

boolean
supportLenientDestroy
Optional

supportLenientDestroy

string
description
Optional

description

ComponentTypeCallbackSupport
callbacks
Optional

callbacks

string
outputResourceTypeId
Optional

outputResourceTypeId

integer As int64 As int64
version
Optional

version

string
idForEntitlements
Optional

idForEntitlements

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string
classId
Optional

classId

string As date-time As date-time
createdDate
Optional

createdDate

string
name
Optional

name

string
tenantId
Optional

tenantId

array of string
requiredPermissionIds
Optional

requiredPermissionIds

string
serviceTypeId
Optional

serviceTypeId

array of string
allocationRelatedResourceTypeIds
Optional

allocationRelatedResourceTypeIds

string
id
Optional

id

string
serviceId
Optional

serviceId

ComponentTypeForms
forms
Optional

forms

string
categoryId
Optional

categoryId

string
containerFieldId
Optional

containerFieldId


403

Forbidden.

Operation doesn't return any data structure

On This Page
Component Types Operations
GET
Get Component Type
GET
Get Component Types
GET
Get Component Type Schema