Perform External Validation

Perform external validations for a form (for the UI)

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/renderer/external-validation

COPY

Query Parameters

string

projectId

Optional

The projectId of the project chosen for the request.

string

sourceId

Optional

sourceId

Request Body

ExternalValidationContext of type(s) application/json

Required

{
    "externalValidations": [
        {
            "label": "string",
            "source": {
                "id": "string",
                "type": "string",
                "parameters": [
                    {
                        "$type": {
                            "dataType": "string",
                            "referenceType": "string",
                            "fields": [
                                "ComplexTypeField Object"
                            ],
                            "isMultiple": false
                        }
                    }
                ],
                "isPageable": false,
                "externalSourceProviderType": "string"
            },
            "target": [
                "string"
            ]
        }
    ],
    "context": {
        "context": {
            "dataType": "string",
            "value": "string"
        }
    }
}

array of object

externalValidations

Optional

externalValidations

object

context

Optional

context

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success' with list of validation messages

[
    "FormValidationMessage Object"
]

array of FormValidationMessage

Optional

400

'Bad Request' if the external validation context body is not in specified format

[
    "FormValidationMessage Object"
]

array of FormValidationMessage

Optional

403

'Forbidden' no forms viewer access rights

[
    "FormValidationMessage Object"
]

array of FormValidationMessage

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-validation

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Form Renderer Operations

POST

Fetch Form