Liste des invokable datasets disponibles dans le noyau et détail des retours attendus.
Les Invokable Datasets du noyau Voozanoo4
Toutes les applications Voozanoo4 peuvent faire appel à des datasets prédéfinis disponibles dans le noyau.
Cet article en fait la liste et détaille les informations renvoyées par ces invokable datasets.
Pour plus d’informations sur les Invokable datasets, consulter l’article Invokable Datasets et Dataqueries : création et utilisation.
Axis
Récupération de la liste de tous les axes.
<!-- Liste des axes -->
<dataset id="axis" invoke_from="Axis"/>
Dataset généré :
{
"id": "axis",
"total_rows": 1,
"begin": 0,
"range": 14000,
"sort": null,
"sort_dir": null,
"mode": "rw",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_axis": {
"type": "primary_key",
"mandatory": "false",
"primary_key": [],
"source": "table",
"table": {
"name": "voo4_pj_axis",
"field": "id_axis",
"mode": "r"
}
},
"label": {
"type": "string",
"mandatory": "false",
"string": {
"length": "45"
},
"source": "table",
"table": {
"name": "voo4_pj_axis",
"field": "id_axis",
"mode": "r"
}
}
},
"variables": []
},
"rowdata": [
{
"id_axis": "1",
"label": "Main axis"
}
],
"clientdata": null
}
Exports
Récupération de la liste de tous les exports.
<!-- Liste des exports -->
<dataset id="exports" invoke_from="Exports"/>
Dataset généré :
{
"id": "exports",
"total_rows": 1,
"begin": 0,
"range": 14000,
"sort": null,
"sort_dir": null,
"mode": "rw",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_resource": {
"type": "primary_key",
"mandatory": true,
"default_label": "Identifiant",
"default_short_label": "Identifiant",
"primary_key": [],
"source": "varset",
"varset": {
"name": "resource",
"field": "id_data",
"mode": "rw"
}
},
"label": {
"type": "string",
"mandatory": true,
"default_label": "Nom",
"default_short_label": "Nom",
"string": {
"length": 45
},
"source": "varset",
"varset": {
"name": "resource",
"field": "name",
"mode": "rw"
}
}
},
"variables": [
{
"alias": "param_id_type_exp",
"value": 78,
"target_column": false,
"entries": [
{
"type": "param",
"name": "id_type_exp"
}
]
}
]
},
"rowdata": [
{
"id_resource": 51,
"label": "export_film_test"
},
{
"id_resource": 52,
"label": "export_medecin_test"
}
],
"clientdata": null
}
Filters
Récupération de la liste de tous les filtres.
<!-- Liste des filtres -->
<dataset id="filters" invoke_from="Filters"/>
Dataset généré :
{
"id": "filters",
"total_rows": 1,
"begin": 0,
"range": 14000,
"sort": null,
"sort_dir": null,
"mode": "rw",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_resource": {
"type": "primary_key",
"mandatory": true,
"default_label": "Identifiant",
"default_short_label": "Identifiant",
"primary_key": [],
"source": "varset",
"varset": {
"name": "resource",
"field": "id_data",
"mode": "rw"
}
},
"label": {
"type": "string",
"mandatory": true,
"default_label": "Nom",
"default_short_label": "Nom",
"string": {
"length": 45
},
"source": "varset",
"varset": {
"name": "resource",
"field": "name",
"mode": "rw"
}
},
"description": {
"type": "string",
"mandatory": false,
"default_label": "Description",
"string": {
"length": 255
},
"source": "varset",
"varset": {
"name": "resource",
"field": "description",
"mode": "rw"
}
}
},
"variables": [
{
"alias": "param_id_type_flt",
"value": 70,
"target_column": false,
"entries": [
{
"type": "param",
"name": "id_type_flt"
}
]
}
]
},
"rowdata": [
{
"id_resource": 38,
"label": "titre_film",
"description": ""
}
],
"clientdata": null
}
IndentedGroups
Récupération de la liste de tous les groupes autorisés pour l’utilisateur courant, avec le niveau de profondeur où se situe chaque groupe. Le filtrage des groupes autorisés se fait depuis l’id de l’utilisateur courant.
<!-- Liste des groupes -->
<dataset id="groups" invoke_from="IndentedGroups"/>
Dataset généré :
{
"id": "groups",
"total_rows": 1,
"begin": 0,
"range": 0,
"sort": null,
"sort_dir": null,
"mode": "r",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_group": {
"type": "primary_key",
"mandatory": false,
"primary_key": []
},
"name": {
"type": "string",
"mandatory": false,
"default_label": "Groupe",
"string": {
"length": 150
}
},
"level": {
"type": "integer",
"mandatory": false,
"integer": {
"max": 999,
"min": 0
}
},
"id_axis": {
"type": "integer",
"mandatory": false,
"integer": {
"max": 999,
"min": 0
}
},
"id_parent": {
"type": "integer",
"mandatory": "false",
"integer": {
"max": 9999999999,
"min": 0
}
}
},
"variables": []
},
"rowdata": [
{
"id_group": 1,
"name": "Main",
"id_axis": 1,
"level": 0,
"id_parent": null
}
],
"clientdata": null
}
IndentedGroupsUserObject
Récupération de la liste de tous les groupes autorisés pour l’utilisateur courant, avec le niveau de profondeur où se situe chaque groupe. Le filtrage des groupes autorisés se fait depuis l’objet user correspondant à l’utilisateur courant.
<!-- Liste des groupes -->
<dataset id="groups" invoke_from="IndentedGroupsUserObject"/>
Paramètres disponibles :
exclude_disabled:- permet d’exclure les groupes désactivés
- option à false par défaut
- pour activer l’option :
<value alias="exclude_disabled">0</value>
limit_to_level:- permet d’exclure les groupes dont le niveau est inférieur ou égal à la valeur passée à l’option
- aucune limite n’est activée par défaut
- pour activer l’option :
<value alias="limit_to_level">1</value>
Exemple : J’ai 3 niveaux de groupe : Monde, Pays, Ville. Je souhaite que la liste des groupes présentée aux administateurs du niveau “Monde” n’affiche pas les groupes de niveaux “Ville” ni les groupes désactivés pour plus de lisibilité ou raison fonctionnelle.
<!-- Liste des groupes -->
<dataset id="groups" invoke_from="IndentedGroupsUserObject">
<params>
<!-- Liste des groupes sans les groupes désactivés / à false par défaut, 0 pour mettre à true -->
<value alias="exclude_disabled">0</value>
<!-- Liste des groupes dont le "level" est inférieur ou égal à 1 / aucune limite par défaut -->
<value alias="limit_to_level">1</value>
</params>
</dataset>
Dataset généré (sans appliquer de paramètres) :
{
"id": "groups",
"total_rows": 1,
"begin": 0,
"range": 0,
"sort": null,
"sort_dir": null,
"mode": "r",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_group": {
"type": "primary_key",
"mandatory": false,
"primary_key": []
},
"name": {
"type": "string",
"mandatory": false,
"default_label": "Groupe",
"string": {
"length": 150
}
},
"level": {
"type": "integer",
"mandatory": false,
"integer": {
"max": 999,
"min": 0
}
},
"id_axis": {
"type": "integer",
"mandatory": false,
"integer": {
"max": 999,
"min": 0
}
},
"id_parent": {
"type": "integer",
"mandatory": "false",
"integer": {
"max": 9999999999,
"min": 0
}
},
"disabled": {
"type": "boolean",
"mandatory": false,
"boolean": []
}
},
"variables": []
},
"rowdata": [
{
"id_group": 1,
"name": "Main",
"id_axis": 1,
"level": 0,
"id_parent": null,
"disabled": 0
}
],
"clientdata": null
}
Listings
Récupération de la liste de tous les listings.
<!-- Liste des listings -->
<dataset id="listing" invoke_from="Listings"/>
Dataset généré :
{
"id": "listings",
"total_rows": 2,
"begin": 0,
"range": 14000,
"sort": null,
"sort_dir": null,
"mode": "rw",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_resource": {
"type": "primary_key",
"mandatory": true,
"default_label": "Identifiant",
"default_short_label": "Identifiant",
"primary_key": [],
"source": "varset",
"varset": {
"name": "resource",
"field": "id_data",
"mode": "rw"
}
},
"label": {
"type": "string",
"mandatory": true,
"default_label": "Nom",
"default_short_label": "Nom",
"string": {
"length": 45
},
"source": "varset",
"varset": {
"name": "resource",
"field": "name",
"mode": "rw"
}
}
},
"variables": [
{
"alias": "param_id_type_lst",
"value": 69,
"target_column": false,
"entries": [
{
"type": "param",
"name": "id_type_lst"
}
]
}
]
},
"rowdata": [
{
"id_resource": 54,
"label": "films"
},
{
"id_resource": 57,
"label": "test"
}
],
"clientdata": null
}
Roles
Récupération de tous les rôles
<!-- Liste des rôles -->
<dataset id="roles" invoke_from="Roles"/>
Dataset généré :
{
"id": "roles",
"total_rows": 2,
"begin": 0,
"range": 14000,
"sort": null,
"sort_dir": null,
"mode": "r",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_role": {
"type": "primary_key",
"mandatory": false,
"primary_key": [],
"source": "table",
"table": {
"name": "voo4_pj_role",
"field": "id_role",
"mode": "r"
}
},
"label": {
"type": "string",
"mandatory": false,
"string": {
"length": 100
},
"source": "table",
"table": {
"name": "voo4_pj_role",
"field": "label",
"mode": "r"
}
}
},
"variables": []
},
"rowdata": [
{
"id_role": 1,
"label": "Administrator"
},
{
"id_role": 2,
"label": "test"
}
],
"clientdata": null
}
Users
Récupération de tous les utilisateurs actifs.
<!-- Liste de utilisateurs -->
<dataset id="users" invoke_from="Users"/>
Le dataset généré :
{
"id": "users",
"total_rows": 2,
"begin": 0,
"range": 14000,
"sort": null,
"sort_dir": null,
"mode": "rw",
"cacheable": true,
"standby": true,
"type": "standard",
"auto_add_record": false,
"mute_refresh_event": false,
"metadata": {
"fields": {
"id_user": {
"type": "primary_key",
"mandatory": false,
"primary_key": [],
"source": "table",
"table": {
"name": "voo4_user_data",
"field": "id_group",
"mode": "r"
}
},
"label": {
"type": "string",
"mandatory": false,
"string": {
"length": 50
},
"source": "table",
"table": {
"name": "voo4_user_data",
"field": "username",
"mode": "r"
}
}
},
"variables": [
{
"alias": "param",
"value": 37,
"target_column": false,
"entries": [
{
"type": "param",
"name": "status"
}
]
}
]
},
"rowdata": [
{
"id_user": 2,
"label": "root"
},
{
"id_user": 3,
"label": "Juliette"
}
],
"clientdata": null
}