Create Component Type | vRealize Automation Content Service API

URI

POST

https://{api_host}/composition-service/api/componenttypes

COPY

Request Body

The new component type to create.

ComponentType of type(s) application/json

Required

{
    "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

Responses

200

successful operation

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

201

Success - return the created component type.

Operation doesn't return any data structure

400

Invalid request - bad data.

Operation doesn't return any data structure

403

Forbidden.

Operation doesn't return any data structure