Get Component Type Extension

Get Component Type Extension

Retrieve details of component type extension that the current user may access. This API checks for component type extension in the current tenant and if not found then checks global component type extensions.

Request
URI
GET
https://{api_host}/composition-service/api/typeextensions/{id}
COPY
Path Parameters
string
id
Required

The objectId of the component type extension.


Responses
200

Success - return the component type extension.

Returns ComponentTypeExtension of type(s) */*
{
    "componentType": {
        "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"
    },
    "lastUpdated": "string",
    "createdDate": "string",
    "tenantId": "string",
    "name": "string",
    "description": "string",
    "id": "string",
    "version": 0,
    "fieldIds": [
        "string"
    ]
}
componentType
Optional

componentType

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
createdDate
Optional

createdDate

string
tenantId
Optional

tenantId

string
name
Optional

name

string
description
Optional

description

string
id
Optional

id

integer As int64 As int64
version
Optional

version

array of string
fieldIds
Optional

fieldIds


403

Forbidden.

Operation doesn't return any data structure

404

Component type extension not found.

Operation doesn't return any data structure