List Custom Resource Types
List custom resource types.
List custom resource types.
Request
URI
GET
https://vcfa-10-162-161-9.vcfd.broadcom.net/form-service/api/custom/resource-types
COPY
Query Parameters
string
propertiesFormat
Optional
propertiesFormat
Possible values are :
YAML,
JSON,
string
runnableId
Optional
runnableId
integer
page
Optional
Constraints:
default: 0
Zero-based page index (0..N)
integer
size
Optional
Constraints:
default: 20
The size of the page to be returned
string of
array
sort
Optional
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Responses
200
'Success' with list of custom resource types in org
Returns
PageCustomResourceType
of type(s)
*/*
{
"totalElements": 0,
"totalPages": 0,
"pageable": {
"paged": false,
"pageNumber": 0,
"pageSize": 0,
"offset": 0,
"sort": {
"sorted": false,
"empty": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"content": [
{
"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": [
{
"label": "string",
"description": "string",
"signpost": "string",
"type": "FormSchemaFieldType Object",
"step": "number",
"default": {},
"valueList": {},
"placeholder": "string",
"constraints": {
"matchConstraint": {
"match": {}
},
"constraints": {
"constraints": {}
}
},
"refresh": {
"type": "string"
},
"shortValueName": [
"string"
],
"id": "string",
"valueTree": {}
}
],
"isMultiple": false
},
"bindingAction": {
"actionName": "string",
"actionInputs": [
"Binding 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": [
{
"validatable": false,
"name": "string",
"isValidatable": false
}
]
}
]
},
"criteria": {
"matchExpression": [
{}
]
}
}
],
"properties": {
"type": "string",
"encrypted": false,
"additionalProperties": false,
"title": "string",
"description": "string",
"writeOnly": false,
"readOnly": false,
"anyOf": [
{
"type": "string",
"encrypted": false,
"additionalProperties": false,
"title": "string",
"description": "string",
"writeOnly": false,
"readOnly": false,
"anyOf": [
"ProviderSchemaImpl Object"
],
"oneOf": [
"ProviderSchemaImpl Object"
],
"not": "ProviderSchemaImpl Object",
"items": {
"value": "ProviderSchemaImpl Object",
"singleton": false,
"values": [
"ProviderSchemaImpl 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",
"metadata": {
"metadata": {}
}
}
],
"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",
"metadata": {
"metadata": {}
}
},
"schemaType": "string",
"propertyBindings": {
"readPropertyBindings": [
{
"schemaPropertyName": "string",
"workflowInputOrOutputName": "string"
}
],
"updatePropertyBindings": [
{
"schemaPropertyName": "string",
"workflowInputOrOutputName": "string"
}
],
"deletePropertyBindings": [
{
"schemaPropertyName": "string",
"workflowInputOrOutputName": "string"
}
]
},
"propertiesYaml": "string"
}
],
"number": 0,
"sort": {
"sorted": false,
"empty": false,
"unsorted": false
},
"first": false,
"last": false,
"numberOfElements": 0,
"empty": false
}
403
'Forbidden' no custom resource type viewing rights
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/form-service/api/custom/resource-types