Resource Description for KpiValue

Properties for KpiValue

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
basis mixed
calculationRangeEndDatetime DateTime
calculationRangeStartDatetime DateTime
kpi Kpi
kpiCategory string
kpiRange KpiRange
lastCalculatedDatetime DateTime
recalculationScheduledDatetime DateTime
recalculationStartedDatetime DateTime
referenceDatetime DateTime
value float

SDK Example for PHP

<?PHP

use Arbor\Api\Gateway\RestGateway;
use Arbor\Model\ModelBase;
use Arbor\Model\KpiValue;

ModelBase::setDefaultGateway(
    new RestGateway(
        "https://my-school.arbor.sc/rest-v2",
        "my.username@my-school.arbor.sc",
        "3bh54435v3gh45"
    )
);

$kpiValue = KpiValue::retrieve(5433);

$kpi = $kpiValue->getKpi();
$kpiCategory = $kpiValue->getKpiCategory();
$referenceDatetime = $kpiValue->getReferenceDatetime();
$calculationRangeStartDatetime = $kpiValue->getCalculationRangeStartDatetime();
$calculationRangeEndDatetime = $kpiValue->getCalculationRangeEndDatetime();
$basis = $kpiValue->getBasis();
$value = $kpiValue->getValue();
$kpiRange = $kpiValue->getKpiRange();
$recalculationScheduledDatetime = $kpiValue->getRecalculationScheduledDatetime();
$recalculationStartedDatetime = $kpiValue->getRecalculationStartedDatetime();
$lastCalculatedDatetime = $kpiValue->getLastCalculatedDatetime();

 

Related Resources

See also: Kpi, KpiRange