Component

AnalyticsBusiness IntelligenceData VisualizationEnterpriseREST API

Properties

Name	Type	Description
name	string	Component name
version	string	Component version
status	string	Component status
hostName	string	Hostname where the component is installed
serviceType	string	Type of service (e.g., Engine, Proxy, Repository, Scheduler)
serviceState	integer	Numeric state of the service (0=Initializing, 1=CertificatesNotInstalled, 2=Running, 3=Disabled, 4=Error)
uri	string	URI of the component service

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Component",
  "title": "Component",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Component name"
    },
    "version": {
      "type": "string",
      "description": "Component version"
    },
    "status": {
      "type": "string",
      "description": "Component status"
    },
    "hostName": {
      "type": "string",
      "description": "Hostname where the component is installed"
    },
    "serviceType": {
      "type": "string",
      "description": "Type of service (e.g., Engine, Proxy, Repository, Scheduler)"
    },
    "serviceState": {
      "type": "integer",
      "description": "Numeric state of the service (0=Initializing, 1=CertificatesNotInstalled, 2=Running, 3=Disabled, 4=Error)"
    },
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "URI of the component service"
    }
  }
}