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

Import form documents

POST
http://localhost:3000/json-forms/import/forms
POST
/json-forms/import/forms
$curl -X POST http://localhost:3000/json-forms/import/forms \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{}'
1{
2  "status": "string",
3  "message": "2 forms imported successfully",
4  "imported": [
5    {
6      "success": true,
7      "message": "string",
8      "original": {
9        "_id": "5cb5252a1bbc5a00def564c1",
10        "created": "2019-04-16T00:43:22.038Z",
11        "createdBy": "5cb08d4f16640f00182c3890",
12        "lastUpdated": "2019-04-16T00:43:22.038Z",
13        "lastUpdatedBy": "5cb08d4f16640f00182c3890",
14        "name": "Device Form",
15        "description": "This form describes the connection information for a device."
16      },
17      "created": {
18        "_id": "5cb5252a1bbc5a00def564c1",
19        "created": "2019-04-16T00:43:22.038Z",
20        "createdBy": "5cb08d4f16640f00182c3890",
21        "lastUpdated": "2019-04-16T00:43:22.038Z",
22        "lastUpdatedBy": "5cb08d4f16640f00182c3890",
23        "name": "Device Form",
24        "description": "This form describes the connection information for a device."
25      }
26    }
27  ]
28}
Inserts form documents into the forms collection from a user supplied JSON document.
Was this page helpful?
Previous

Return all forms

Next
Built with

Authentication

AuthorizationBasic

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

Request

request body
formslist of objectsOptional

Response

Status of forms import operation
status"success"
messagestring
importedlist of objects

Errors

500
Internal Server Error