Create Or Update Component Type
Create or update a component type.
Request
URI
PUT
https://{api_host}/composition-service/api/componenttypes/{objectId}
COPY
Path Parameters
string
objectId
Required
The objectId of the component type.
Request Body
The component type to create or update.
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
string
catalogItemTypeId
Optional
catalogItemTypeId
boolean
supportLenientDestroy
Optional
supportLenientDestroy
string
description
Optional
description
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
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
string
catalogItemTypeId
Optional
catalogItemTypeId
boolean
supportLenientDestroy
Optional
supportLenientDestroy
string
description
Optional
description
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
string
categoryId
Optional
categoryId
string
containerFieldId
Optional
containerFieldId
201
Success - return the created component type.
Operation doesn't return any data structure
204
Success - return the updated 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
On This Page
Component Types Operations
POST
Create Component Type
PUT
Create Or Update Component Type
DELETE
Delete Component Type