For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTConvert YANG to JSON schema
        • POSTCreate a JSON form
        • POSTDecode an encoded JSON schema
        • DELDelete a forms
        • GETFind a form
        • POSTImport form documents
        • GETReturn all forms
        • PUTUpdate a form
        • POSTValidate data against a schema
        • POSTValidate form data against its schema
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceJSON Forms

Validate form data against its schema

POST
http://localhost:3000/json-forms/validate-form/:id
POST
/json-forms/validate-form/:id
$curl -X POST http://localhost:3000/json-forms/validate-form/id \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "status": 200,
3  "validation": {
4    "valid": true,
5    "errors": [
6      "string"
7    ]
8  },
9  "message": "Form data is valid."
10}
Retrieves the JSON schema for a given form ID and validates the supplied form data again it.
Was this page helpful?
Previous

Cancel an action execution

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idstringRequired
Unique ID of the form

Request

request body
formDataobjectOptional

Response

results from the form validation
statusenum
Allowed values:
validationobject
messagestring

Errors

500
Internal Server Error