Execute External Actions

Execute External Actions

Execute multiple external actions to get a list of values (for the UI)

Request
URI
POST
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/renderer/external-values
COPY
Query Parameters
string
projectId
Optional

The projectId of the project chosen for the request.

string
sourceId
Optional

sourceId

Request Body
[
    {
        "uri": "string",
        "dataSource": "string",
        "parameters": [
            {
                "name": "string",
                "value": "string",
                "useResultFromRequestId": 0
            }
        ],
        "fieldType": {
            "dataType": "string",
            "referenceType": "string",
            "fields": [
                "ComplexTypeField Object"
            ],
            "isMultiple": false
        },
        "requestId": 0,
        "contextParameters": {
            "contextParameters": "string"
        },
        "externalSourceProviderType": "string"
    }
]
array of FormExternalDataRequest
Optional
Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with a list of external action results

[
    "FormExternalDataResponse Object"
]
array of FormExternalDataResponse
Optional

400

'Bad Request' if RunnableItem is not in specified format

[
    "FormExternalDataResponse Object"
]
array of FormExternalDataResponse
Optional

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 actions.

[
    "FormExternalDataResponse Object"
]
array of FormExternalDataResponse
Optional

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/form-service/api/forms/renderer/external-values
On This Page
Form Renderer Operations
POST
Fetch Form
POST
Fetch Model
POST
Execute External Actions
POST
Execute External Action
POST
Perform External Validation
GET
Lookup External Resource
POST
Lookup External Resources