Get Custom Resource Type
Get custom resource type.
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/custom/resource-types/{id}
COPY
Path Parameters
string
id
Required
id
Query Parameters
string
propertiesFormat
Optional
propertiesFormat
Possible values are :
YAML,
JSON,
Responses
200
'Success' with found custom resource type
Returns
CustomResourceType
of type(s)
*/*
{
"id": "string",
"displayName": "string",
"description": "string",
"resourceType": "string",
"externalType": "string",
"status": "string",
"orgId": "string",
"projectId": "string",
"mainActions": {
"allocate": {
"id": "string",
"name": "string",
"description": "string",
"projectId": "string",
"type": "string",
"inputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"outputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"endpointLink": "string",
"inputBindings": [
{
"inputKey": "string",
"value": "string",
"type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
},
"bindingAction": "BindingAction Object"
}
]
},
"create": {
"id": "string",
"name": "string",
"description": "string",
"projectId": "string",
"type": "string",
"inputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"outputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"endpointLink": "string",
"inputBindings": [
{
"inputKey": "string",
"value": "string",
"type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
},
"bindingAction": "BindingAction Object"
}
]
},
"read": {
"id": "string",
"name": "string",
"description": "string",
"projectId": "string",
"type": "string",
"inputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"outputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"endpointLink": "string",
"inputBindings": [
{
"inputKey": "string",
"value": "string",
"type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
},
"bindingAction": "BindingAction Object"
}
]
},
"update": {
"id": "string",
"name": "string",
"description": "string",
"projectId": "string",
"type": "string",
"inputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"outputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"endpointLink": "string",
"inputBindings": [
{
"inputKey": "string",
"value": "string",
"type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
},
"bindingAction": "BindingAction Object"
}
]
},
"delete": {
"id": "string",
"name": "string",
"description": "string",
"projectId": "string",
"type": "string",
"inputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"outputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"endpointLink": "string",
"inputBindings": [
{
"inputKey": "string",
"value": "string",
"type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
},
"bindingAction": "BindingAction Object"
}
]
}
},
"additionalActions": [
{
"id": "string",
"name": "string",
"displayName": "string",
"description": "string",
"providerName": "string",
"resourceType": "string",
"status": "string",
"projectId": "string",
"orgId": "string",
"runnableItem": {
"id": "string",
"name": "string",
"description": "string",
"projectId": "string",
"type": "string",
"inputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"outputParameters": [
{
"type": "string",
"name": "string",
"description": "string"
}
],
"endpointLink": "string",
"inputBindings": [
{
"inputKey": "string",
"value": "string",
"type": {
"dataType": "string",
"referenceType": "string",
"fields": [
"ComplexTypeField Object"
],
"isMultiple": false
},
"bindingAction": "BindingAction Object"
}
]
},
"formDefinition": {
"tenant": "string",
"id": "string",
"name": "string",
"form": "string",
"styles": "string",
"sourceType": "string",
"sourceId": "string",
"type": "string",
"status": "string",
"createdDate": "string",
"modifiedDate": "string",
"formFormat": "string",
"providerRef": "string",
"externalSourceFormSchemas": [
{
"externalSourceId": "string",
"parentId": "string",
"elementId": "string",
"elementType": "string",
"facet": "string",
"parameters": [
{
"name": "string",
"isValidatable": false
}
]
}
]
},
"criteria": {
"matchExpression": [
{}
]
}
}
],
"properties": {
"type": "string",
"encrypted": false,
"additionalProperties": false,
"title": "string",
"description": "string",
"writeOnly": false,
"readOnly": false,
"anyOf": [
"ProviderSchemaImpl Object"
],
"oneOf": [
"ProviderSchemaImpl Object"
],
"not": "ProviderSchemaImpl Object",
"items": "ObjectOrListProviderSchemaImpl Object",
"uniqueItems": false,
"maxItems": 0,
"minItems": 0,
"maximum": "number",
"minimum": "number",
"properties": {
"properties": "ProviderSchemaImpl Object"
},
"required": [
"string"
],
"maxProperties": 0,
"minProperties": 0,
"patternProperties": {
"patternProperties": "ProviderSchemaImpl Object"
},
"maxLength": 0,
"minLength": 0,
"pattern": "string",
"format": "string",
"formatMinimum": "string",
"formatMaximum": "string",
"computed": false,
"recreateOnUpdate": false,
"ignoreOnUpdate": false,
"ignoreCaseOnDiff": false,
"dependencies": {
"dependencies": [
"string"
]
},
"enum": [
{}
],
"const": {},
"default": {},
"$data": "string",
"$dynamicDefault": "string"
},
"schemaType": "string",
"propertyBindings": {
"readPropertyBindings": [
{
"schemaPropertyName": "string",
"workflowInputOrOutputName": "string"
}
],
"updatePropertyBindings": [
{
"schemaPropertyName": "string",
"workflowInputOrOutputName": "string"
}
],
"deletePropertyBindings": [
{
"schemaPropertyName": "string",
"workflowInputOrOutputName": "string"
}
]
},
"propertiesYaml": "string"
}
string As uuid
As uuid
id
Optional
id
string
displayName
Optional
displayName
string
description
Optional
description
string
resourceType
Optional
resourceType
string
externalType
Optional
externalType
string
status
Optional
status
Possible values are :
released,
draft,
string
orgId
Optional
orgId
string
projectId
Optional
projectId
object
mainActions
Optional
mainActions
array of
object
additionalActions
Optional
The resource action
object
properties
Optional
properties
string
schemaType
Optional
schemaType
object
propertyBindings
Optional
propertyBindings
string
propertiesYaml
Optional
propertiesYaml
400
'Bad Request' if ID is not in specified format
Returns
CustomResourceType
of type(s)
*/*
"CustomResourceType Object"
string As uuid
As uuid
id
Optional
id
string
displayName
Optional
displayName
string
description
Optional
description
string
resourceType
Optional
resourceType
string
externalType
Optional
externalType
string
status
Optional
status
Possible values are :
released,
draft,
string
orgId
Optional
orgId
string
projectId
Optional
projectId
object
mainActions
Optional
mainActions
array of
object
additionalActions
Optional
The resource action
object
properties
Optional
properties
string
schemaType
Optional
schemaType
object
propertyBindings
Optional
propertyBindings
string
propertiesYaml
Optional
propertiesYaml
403
'Forbidden' no custom resource type viewing rights
Returns
CustomResourceType
of type(s)
*/*
"CustomResourceType Object"
string As uuid
As uuid
id
Optional
id
string
displayName
Optional
displayName
string
description
Optional
description
string
resourceType
Optional
resourceType
string
externalType
Optional
externalType
string
status
Optional
status
Possible values are :
released,
draft,
string
orgId
Optional
orgId
string
projectId
Optional
projectId
object
mainActions
Optional
mainActions
array of
object
additionalActions
Optional
The resource action
object
properties
Optional
properties
string
schemaType
Optional
schemaType
object
propertyBindings
Optional
propertyBindings
string
propertiesYaml
Optional
propertiesYaml
404
'Not Found' if there is no custom resource type for the ID
Returns
CustomResourceType
of type(s)
*/*
"CustomResourceType Object"
string As uuid
As uuid
id
Optional
id
string
displayName
Optional
displayName
string
description
Optional
description
string
resourceType
Optional
resourceType
string
externalType
Optional
externalType
string
status
Optional
status
Possible values are :
released,
draft,
string
orgId
Optional
orgId
string
projectId
Optional
projectId
object
mainActions
Optional
mainActions
array of
object
additionalActions
Optional
The resource action
object
properties
Optional
properties
string
schemaType
Optional
schemaType
object
propertyBindings
Optional
propertyBindings
string
propertiesYaml
Optional
propertiesYaml
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/form-service/api/custom/resource-types/{id}
On This Page
Custom Resource Types Operations
GET
List Custom Resource Types
POST
Create Or Update Custom Resource Type
GET
Get R Esource Action For Custom Resource
GET
Get Custom Resource Type
DELETE
Delete Custom Resource Type