IntroductionBefore you beginTerminologyGetting started
Authorization
Accounts
Entities
User accounts
GroupsFilesFoldersTemplatesEmail templatesAppsErrors

Entity definitions

To retrieve metadata related to an entity or entity relationship we can use a GET request to /nodes/entity-definition.

You can avoid specifying the "path" param and use the "?children=x" query param to get the entity structure.

Retrieve entity definition
GET/nodes/entity-definition/{path}


Parameters


pathstring (optional)The entity path.


Request


curl --include \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
'https://rest.smartvault.com/nodes/entity-definition/{path}'

Response


Returns a default node response if the path specified is correct.

Show success object


Returns an error object if the path specified doesn't exist.

Show error object