Execute External Action
Execute an external action to get a value (for the UI)
Execute an external action to get a value (for the UI)
Request
URI
POST
https://{vcfa-fqdn}/form-service/api/forms/renderer/external-value
COPY
Query Parameters
string
projectId
Optional
The projectId of the project chosen for the request.
string
sourceId
Optional
sourceId
Request Body
FormExternalDataRequest
of type(s)
application/json
Required
{
"uri": "string",
"dataSource": "string",
"parameters": [
{
"name": "string",
"value": "string",
"useResultFromRequestId": 0
}
],
"fieldType": {
"dataType": "string",
"referenceType": "string",
"fields": [
{
"label": "string",
"description": "string",
"signpost": "string",
"type": "FormSchemaFieldType Object",
"step": "number",
"default": {},
"valueList": {},
"placeholder": "string",
"constraints": {
"matchConstraint": {
"match": {}
}
},
"refresh": {
"type": "string"
},
"shortValueName": [
"string"
],
"id": "string",
"valueTree": {}
}
],
"isMultiple": false
},
"requestId": 0,
"contextParameters": {
"contextParameters": "string"
},
"externalSourceProviderType": "string"
}
string
uri
Optional
uri
string
dataSource
Optional
dataSource
array of
object
parameters
Optional
parameters
object
fieldType
Optional
fieldType
integer As int32
As int32
requestId
Optional
requestId
object
contextParameters
Optional
contextParameters
string
externalSourceProviderType
Optional
externalSourceProviderType
Possible values are :
orchestrator,
ABX,
Responses
200
'Success' with the result from the external action
Returns
FormExternalDataResponse
of type(s)
application/json
{
"data": {},
"error": {
"summaryMessage": "string",
"detailsMessage": "string"
},
"requestId": 0
}
object
data
Optional
data
object
error
Optional
error
integer As int32
As int32
requestId
Optional
requestId
400
'Bad Request' if request body is not in specified format
Returns
FormExternalDataResponse
of type(s)
application/json
{
"data": {},
"error": {
"summaryMessage": "string",
"detailsMessage": "string"
},
"requestId": 0
}
object
data
Optional
data
object
error
Optional
error
integer As int32
As int32
requestId
Optional
requestId
403
'Forbidden' due to insufficient access rights for form viewing or the form execution has not been created. To resolve this, ensure that the /renderer/model API is called first to load the necessary form containing the required external action.
Returns
FormExternalDataResponse
of type(s)
application/json
"FormExternalDataResponse Object"
object
data
Optional
data
object
error
Optional
error
integer As int32
As int32
requestId
Optional
requestId
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/form-service/api/forms/renderer/external-value