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

Update a form

PUT
http://localhost:3000/json-forms/forms/:id
PUT
/json-forms/forms/:id
$curl -X PUT http://localhost:3000/json-forms/forms/id \
> -H "Content-Type: application/json" \
> -u "<username>:<password>" \
> -d '{}'
1{
2 "status": "success",
3 "message": "Form updated"
4}
Updates a previously created JSON form, based on a supplied document ID and an object of fields to update.
Was this page helpful?
Previous

Validate data against a schema

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

idstringRequired
The ID of the form.

Request

request body
optionsobjectOptional

Response

A response object containing the request status and a message
statusenum
Allowed values:
messagestring

Errors

500
Internal Server Error