Jedes Dataset (auch: Model) hat definierte Daten-Felder ("Fields").
Die Felder und jeweilige Definition-Details können ebenso über die API live abgerufen werden, über den API-Endpunkt data_getModel.
Parameter
Grundsätzliche Parameter sind wie folgt.
Parameter | Description | Example |
---|---|---|
dataset | Label des Dataset auf das zugegriffen werden soll | "product" |
dataset
Über dieses dataset wird grundsätzlich festgelegt auf welche Daten zugegriffen werden soll.
Beispiele
data_getModel
Url: https://{your hublify url}/api/eos_10/data_getModel
Parameters
{
"dataset": "person"
}
Response
Bei get-Calls wird der eigentliche Datensatz direkt unter [data] zurückgegeben.
{
"data": {
... // All field definitions
},
"status": true
}
Special fields
There are some special fields automatically made available by the dataset-engine.
The fields are readable but not writable. Usually you can retrieve simply like any other field.
hfy_dataset
(String) This field contains the dataset-label of which the data-result / -row is.
hfy_primary
(String) This field contains the value of the primary key of which the data-result / -row is. This is basically a generic "alias"-field of configured primary-field of that model.
hfy_primaryDisplay
(String) This field contains the value of the primary-display key of which the data-result / -row is. This is basically a generic "alias"-field of configured primary-display-field of that model.
dataGraphPath
(Object) This field contains the default dataGraphPath-object of which the data-result / -row is.
This is only available if the dataGraphPath is configured in the dataset's (model'sl) configuration!