Health APIs


API	Description
`Get Health [<Resource>]`	Gets the HQI (Health QualityIndicator) of XCO
	`Get Health`	Gets Overall HQI Values
	`Get Health /App/System`	Gets HQI values at System Level
`Get Health Detail <Resource>`	`Gets Health`
`Get Health Detail <Resource>`	`Get Health Detail /App/System/Certificate`	Gets HQI values and metadata at certificate

Example

Request Get Health

Response
{
    Resource: /App
    HQI {
        Color: Yellow
        Value: 1
    }
    StatusText: [<Freeform status text>]
}
Request Get Health Detail

Response
{
    Resource: /App
    HQI {
        Color: Yellow
        Value: 1
    }
   Contributor {
        ResourceList: [/App/System/Certificate, /App/Component/Fabric]
   }
   StatusText: [<Freeform status text>]
}
Request Get Health /App/System/Certificate

Response
{
    Resource:/App/System/Certificate
    HQI {
        Color: Yellow
        Value: 1
    }
    StatusText: [Certificate x expires on <date>.]
}

Health service URI has additional query parameters to enable users to query for specific type of entity and particular asset. As part of the API validation the query parameters are validated and appropriate response is returned. Check the REST API guide for the different status and responses.