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

Find a form

GET
http://localhost:3000/json-forms/forms/:id
GET
/json-forms/forms/:id
$curl http://localhost:3000/json-forms/forms/id \
>     -u "<username>:<password>"
1{
2  "created": "2019-04-16T00:43:22.038Z",
3  "createdBy": "5cb08d4f16640f00182c3890",
4  "lastUpdated": "2019-04-16T00:43:22.038Z",
5  "lastUpdatedBy": "5cb08d4f16640f00182c3890",
6  "name": "Device Form",
7  "description": "This form describes the connection information for a device.",
8  "struct": {
9    "type": "string",
10    "items": [
11      {
12        "nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
13        "type": "string",
14        "title": "Connection Information",
15        "required": true,
16        "options": {},
17        "description": "This section describes the connection information for a device.",
18        "helper": "Tooltip help message goes here",
19        "items": [
20          null
21        ],
22        "collapsed": true,
23        "readOnly": true,
24        "schemaOption": true,
25        "combinationType": "string",
26        "widget": "string",
27        "uniqueItems": true,
28        "minItems": 1.1,
29        "maxItems": 1.1,
30        "customKey": "string"
31      }
32    ],
33    "nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
34    "projectId": "string"
35  },
36  "schema": {
37    "type": "string",
38    "title": "Connection Information",
39    "_id": "string",
40    "uniqueItems": true,
41    "minItems": 1.1,
42    "maxItems": 1.1,
43    "description": "This form describes the connection information for a device.",
44    "required": [
45      "kdWO-g4oS3GkzrbqDqCZUw"
46    ],
47    "readOnly": true,
48    "options": {},
49    "properties": {},
50    "items": {
51      "_id": "string",
52      "type": "string",
53      "required": [
54        "string"
55      ],
56      "readOnly": true,
57      "properties": {}
58    },
59    "anyOf": [
60      {}
61    ],
62    "oneOf": [
63      {}
64    ],
65    "allOf": [
66      {}
67    ]
68  },
69  "uiSchema": {},
70  "validationSchema": {},
71  "bindingSchema": {},
72  "version": "2020.1",
73  "_id": "5cb5252a1bbc5a00def564c1",
74  "tags": [
75    "5cb5252a1bbc5a00def564c1"
76  ],
77  "id": "5cb5252a1bbc5a00def564c1",
78  "namespace": null
79}
Finds a previously created JSON form, based on a supplied document ID.
Was this page helpful?
Previous

Import form documents

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

idstringRequired
Unique name of the form

Response

document of requested form
createdstringformat: "date-time"
createdBystring
lastUpdatedstringformat: "date-time"
lastUpdatedBystring
namestring
descriptionstring or null
structobject
schemaobject
uiSchemaobject
validationSchemaobject
bindingSchemaobject
versionstring
_idstring
tagslist of strings or maps from strings to any
idstring
namespaceobject or null

Errors

500
Internal Server Error