Get Metadata of a Node Type
get
/nodeTypes/{id}
Returns metadata specific to a node type.
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The specified metadata has been fetched successfully.
400 Response
The server cannot process the request due to a client error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
401 Response
The client does not have the correct privileges.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
403 Response
The request was not authorized.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
404 Response
The requested resource cannot be found.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
405 Response
This method is not allowed.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
409 Response
The request could not be processed due to a conflict in the existing state of the resource.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
422 Response
The entity cannot be processed due to semantic errors.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
500 Response
The system has encountered an internal server error.
Root Schema : Error
Type:
object
Used when an API encounters an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@type: string
Defines the sub-class entity when sub-classing.
-
cause: string
Cause of the exception
-
code(required): string
Application relevant details defined in the API or a common list.
-
message: string
Details and corrective actions related to the error which is shown to a client user.
-
reason(required): string
The reason for the error, shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error Code describiing the error.
Examples
The following example shows how to fetch the metadata of a specific node type by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -X GET 'http://host:port/nodeTypes/{id}
Example of the Response Body
If successful, the response code 200 is returned with the following response body.
{
"tabs": [
{
"id": "nameAndType",
"title": "Name and Type",
"form": {
"groups": [
{
"fields": [
{
"id": "nodeType",
"label": "Node",
"type": "nodeType"
},
{
"id": "nodeName",
"label": "Node Name",
"type": "text",
"required": "true"
}
]
}
]
}
},
{
"id": "basicSettings",
"title": "Basic Settings",
"form": {
"groups": [
{
"title": "External clients",
"fields": [
{
"type": "table",
"fields": [
{
"id": "ipaddress",
"label": "IP Address",
"type": "text",
"required": "true"
},
{
"id": "sharedsecret",
"label": "Shared Secret",
"type": "password",
"required": "true"
}
],
"buttonLabel": "Add Client"
}
]
}
]
}
}
]
}
}