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
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • POSTAdd group to form
        • POSTDelete a form by ID
        • POSTExport form
        • GETGet an element definition
        • GETGet details of form by ID
        • GETGet details of form by name
        • POSTGet service instance data
        • POSTImport form
        • GETList all elements usable in forms
        • GETList all form names
        • GETList groups for a form
        • PUTOverwrite groups for a form
        • POSTPreserve incoming form data format
        • DELRemove a group from a form
        • DELRemove all authorization restriction for a form
        • POSTSave a generated form
        • POSTSearch forms
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceFormbuilder

Get an element definition

GET
http://localhost:3000/formbuilder/getElementDefinition/:type/:id
GET
/formbuilder/getElementDefinition/:type/:id
$curl http://localhost:3000/formbuilder/getElementDefinition/service_model/id \
>     -u "<username>:<password>"
1{
2  "children": [],
3  "type": "service",
4  "name": "service-name",
5  "properties": {},
6  "key": "s-key",
7  "namespace": "",
8  "hosts": [
9    "nso1",
10    "nso2"
11  ]
12}
Returns the details about a particular element to be used in a form.
Was this page helpful?
Previous

Get details of form by ID

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

typeenumRequired
Element type
Allowed values:
idstringRequired
Type ID

Response

Definition of the element

Errors

500
Internal Server Error