595 lines
19 KiB
JSON
Executable File
595 lines
19 KiB
JSON
Executable File
{
|
|
|
|
"module": {
|
|
|
|
"POST::apiBlueprint": {
|
|
"description": "Retourne une documentation de l'API au format API Blueprint.",
|
|
"permissions": [["admin"]],
|
|
"options": { "download": true },
|
|
"parameters": {}
|
|
}
|
|
|
|
},
|
|
|
|
|
|
"motheure": {
|
|
|
|
"POST::getCount": {
|
|
"description": "Retourne le compteur horaire du moteur d'une machine donnée",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"count": { "description": "Compte horaire (en secondes)", "type": "int" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
|
|
"authentificationDefault": {
|
|
"POST::warehouse": {
|
|
"description": "Connexion de premier niveau : entrepot.",
|
|
"permissions": [],
|
|
"parameters": {
|
|
"name": { "description": "Nom de l'entrepot.", "type": "varchar(3,30,alphanumeric)" },
|
|
"password": { "description": "Mot de passe de l'entrepot.", "type": "text" }
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la connexion.", "type": "boolean" }
|
|
}
|
|
},
|
|
|
|
"POST::admin": {
|
|
"description": "Connexion de second niveau : administrateur.",
|
|
"permissions": [["warehouse"]],
|
|
"parameters": {
|
|
"username": { "description": "Identifiant de l'administrateur.", "type": "varchar(1,30,alphanumeric)" },
|
|
"password": { "description": "Mot de passe de l'administrateur'.", "type": "text" }
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la connexion.", "type": "boolean" }
|
|
}
|
|
}
|
|
},
|
|
|
|
|
|
"userDefault": {
|
|
|
|
"POST::create": {
|
|
"description": "Création d'un nouvel utilisateur.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"code": { "description": "Code RFID de l'utilisateur.", "type": "rfid" },
|
|
"username": { "description": "Identifiant de l'utilisateur.", "type": "varchar(1,30,alphanumeric)" },
|
|
"firstname": { "description": "Prénom de l'utilisateur.", "type": "varchar(3,30,letters)" },
|
|
"lastname": { "description": "Nom de l'utilisateur.", "type": "varchar(3,30,letters)" },
|
|
"mail": { "description": "Adresse mail de l'utilisateur.", "type": "mail" }
|
|
},
|
|
"output": {
|
|
"id_user": { "description": "UID de l'utilisateur créé.", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"POST::link": {
|
|
"description": "Ajout d'un utilisateur à un groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_cluster": { "description": "UID du groupe auquel rattacher.", "type": "id" },
|
|
"id_user": { "description": "UID de l'utilisateur à rattacher.", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
|
|
"POST::unlink": {
|
|
"description": "Retrait d'un utilisateur d'un groupe",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_cluster": { "description": "UID du groupe auquel détacher.", "type": "id" },
|
|
"id_user": { "description": "UID de l'utilisateur à détacher.", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
"POST::search": {
|
|
"description": "Recherche d'un utilisateur par mots-clés.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"keywords": { "description": "Mots-clés de la recherche.", "type": "text" }
|
|
},
|
|
"output": {
|
|
"users": { "description": "Liste des utilisateurs correspondants aux mots-clés.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getAll": {
|
|
"description": "Liste de tous les utilisateurs",
|
|
"permissions": [["admin"]],
|
|
"parameters": {},
|
|
"output": {
|
|
"users": { "description": "Liste de tous les utilisateurs.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::getById": {
|
|
"description": "Retourne un utilisateur spécifique.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_user": { "description": "UID de l'utilisateur.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"user": { "description": "Données de l'utilisateur.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getByCode": {
|
|
"description": "Retourne un utilisateur de Code RFID donné.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"code": { "description": "Code RFID de l'utilisateur.", "type": "rfid" }
|
|
},
|
|
"output": {
|
|
"user": { "description": "Données de l'utilisateur.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getByUsername": {
|
|
"description": "Retourne un utilisateur d'identifiant donné.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"username": { "description": "Identifiant de l'utilisateur.", "type": "varchar(1,30,alphanumeric)" }
|
|
},
|
|
"output": {
|
|
"user": { "description": "Données de l'utilisateur.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getClusters": {
|
|
"description": "Retourne les groupes d'un utilisateur.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_user": { "description": "UID de l'utilisateur.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"clusters": { "description": "Liste des groupes de l'utilisateur.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::edit": {
|
|
"description": "Modifie les attributs d'un utilisateur.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_user": { "description": "UID de l'utilisateur.", "type": "id" },
|
|
"code": { "description": "Code RFID de l'utilisateur.", "type": "rfid", "optional": true },
|
|
"username": { "description": "Identifiant de l'utilisateur.", "type": "varchar(1,30,alphanumeric)", "optional": true },
|
|
"firstname": { "description": "Prénom de l'utilisateur.", "type": "varchar(3,30,letters)", "optional": true },
|
|
"lastname": { "description": "Nom de l'utilisateur.", "type": "varchar(3,30,letters)", "optional": true },
|
|
"mail": { "description": "Adresse mail de l'utilisateur.", "type": "mail", "optional": true },
|
|
"password": { "description": "Mot de passe de l'utilisateur.", "type": "text", "optional": true },
|
|
"status": { "description": "Status de l'utilisateur.", "type": "status", "optional": true }
|
|
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la modification.", "type": "boolean" }
|
|
}
|
|
},
|
|
|
|
"POST::delete": {
|
|
"description": "Suppression d'un utilisateur.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_user": { "description": "UID de l'utilisateur.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la suppression.", "type": "boolean" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
|
|
"machineDefault": {
|
|
|
|
"POST::update": {
|
|
"description": "Mise à jour d'un SAYS++TS.",
|
|
"permissions": [["sats"]],
|
|
"parameters": {
|
|
"data": { "description": "Données (dépendent des modules).", "type": "array<mixed>" }
|
|
},
|
|
"output": {
|
|
"data": { "description": "Données (dépendent des modules).", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::sync": {
|
|
"description": "Synchronisation d'un SATS.",
|
|
"permissions": [["warehouse"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" },
|
|
"token": { "description": "Initialisation du code d'accès évolutif", "type": "hash" },
|
|
"unlock": { "description": "Code d'initialisation", "type": "hash" }
|
|
},
|
|
"output": {
|
|
"data": { "description": "Données d'initialisation.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::create": {
|
|
"description": "Création d'une nouvelle machine.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"name": { "description": "Nom de la machine.", "type": "varchar(1,30,letters)" }
|
|
},
|
|
"output": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"POST::link": {
|
|
"description": "Ajout d'une machine à un groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" },
|
|
"id_cluster": { "description": "UID du groupe de la machine.", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
"POST::unlink": {
|
|
"description": "Retrait d'une machine d'un groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" },
|
|
"id_cluster": { "description": "UID du groupe de la machine.", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
"POST::search": {
|
|
"description": "Recherche une machine par mots-clés.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"keywords": { "description": "Mots-clés de recherche de machine", "type": "text" }
|
|
},
|
|
"output": {
|
|
"machines": { "description": "Liste des machines correspondant à la recherche.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::getAll": {
|
|
"description": "Retourne la liste de toutes les machines.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {},
|
|
"output": {
|
|
"machines": { "description": "Liste de toutes les machines.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::getById": {
|
|
"description": "Retourne les données d'une machine.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"machine": { "description": "Données de la machine.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getByName": {
|
|
"description": "Retourne les données d'une machine de nom donné.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"name": { "description": "Nom de la machine.", "type": "varchar(1,30,letters)" }
|
|
},
|
|
"output": {
|
|
"machine": { "description": "Données de la machine.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getClusters": {
|
|
"description": "Retourne les groupes d'une machine.",
|
|
"permissions": [["admin"], ["sats"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"clusters": { "description": "Liste des groupes de la machine.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::edit": {
|
|
"description": "Modifie les attributs d'une machine.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" },
|
|
"name": { "description": "Nom de la machine.", "type": "varchar(1,30,letters)", "optional": true }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
"POST::delete": {
|
|
"description": "Supprime une machine.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la suppression.", "type": "boolean" }
|
|
}
|
|
},
|
|
|
|
"POST::getState": {
|
|
"description": "Retourne l'état d'une machine.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "UID de la machine", "type": "id" }
|
|
},
|
|
"output": {
|
|
"state": { "description": "Etat de la machine", "type": "text" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
|
|
"clusterDefault": {
|
|
|
|
"POST::create": {
|
|
"description": "Création d'un nouveau groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"name": { "description": "Nom du groupe.", "type": "varchar(1,30,letters)" },
|
|
"class": { "description": "Type de groupe.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"id_cluster": { "description": "UID du groupe créé.", "type": "id" }
|
|
}
|
|
},
|
|
|
|
"POST::search": {
|
|
"description": "Recherche d'un groupe par mots-clés.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"keywords": { "description": "Mots-clés de la recherche.", "type": "text" },
|
|
"class": { "description": "Type de groupe.", "type": "id", "optional": true }
|
|
},
|
|
"output": {
|
|
"clusters": { "description": "Liste des groupes correspondants aux mots-clés.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getAll": {
|
|
"description": "Liste de tous les groupes",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"class": { "description": "Type de groupe.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"clusters": { "description": "Liste de tous les groupes.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::getById": {
|
|
"description": "Retourne un groupe spécifique.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_cluster": { "description": "UID du groupe.", "type": "id" },
|
|
"class": { "description": "Type de groupe.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"cluster": { "description": "Données du groupe.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getByName": {
|
|
"description": "Retourne un groupe de nom donné.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"name": { "description": "Nom du groupe.", "type": "varchar(1,30,letters)" },
|
|
"class": { "description": "Type de groupe.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"cluster": { "description": "Données du groupe.", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getMembers": {
|
|
"description": "Retourne les membres d'un groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_cluster": { "description": "UID du groupe.", "type": "id" },
|
|
"class": { "description": "Type de groupe.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"members": { "description": "Liste des membres du groupe.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::edit": {
|
|
"description": "Modifie le nom d'un groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_cluster": { "description": "UID du groupe.", "type": "id" },
|
|
"class": { "description": "Type de groupe.", "type": "id" },
|
|
"name": { "description": "Nom du groupe.", "type": "varchar(1,30,letters)" }
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la modification.", "type": "boolean" }
|
|
}
|
|
},
|
|
|
|
"POST::delete": {
|
|
"description": "Suppression d'un groupe.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_cluster": { "description": "UID du groupe.", "type": "id" },
|
|
"class": { "description": "Type de groupe.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"status": { "description": "Status de la suppression.", "type": "boolean" }
|
|
}
|
|
},
|
|
|
|
"POST::addPermission": {
|
|
"description": "Ajout d'une permission",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_source": { "description": "Groupe d'utilisateur source.", "type": "id" },
|
|
"id_target": { "description": "Groupe de machine cible.", "type": "id" },
|
|
"id_action": { "description": "Action en question.", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
"POST::remPermission": {
|
|
"description": "Suppression d'une permission",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_source": { "description": "Groupe d'utilisateur source.", "type": "id" },
|
|
"id_target": { "description": "Groupe de machine cible.", "type": "id" },
|
|
"id_action": { "description": "Action en question.", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
|
|
"POST::getPermissions": {
|
|
"description": "Retourne la liste des permissions",
|
|
"permissions": [["admin"]],
|
|
"parameters": {},
|
|
"output": {
|
|
"permissions": { "description": "Liste des permissions", "type": "array" }
|
|
}
|
|
},
|
|
|
|
"POST::getAuthenticatedClusters": {
|
|
"description": "Retourne les groupes d'utilisateurs ayant une action sur un groupe de machine.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"id_target": { "description": "Groupe de machine cible.", "type": "id" },
|
|
"id_action": { "description": "Action en question.", "type": "id" }
|
|
},
|
|
"output": {
|
|
"clusters": { "description": "Liste des groupes d'utilisateurs.", "type": "array" }
|
|
}
|
|
},
|
|
|
|
"POST::getModules": {
|
|
"description": "Retourne les modules d'un groupe de machines",
|
|
"permissions": [["admin"], ["sats"]],
|
|
"parameters": {
|
|
"id_machine_cluster": { "description": "UID du groupe de machines", "type": "id" }
|
|
},
|
|
"output": {
|
|
"modules": { "description": "Modules du groupe", "type": "array<mixed>" }
|
|
}
|
|
},
|
|
|
|
"POST::getEtrees": {
|
|
"description": "Retourne les e-trees d'un groupe de machines",
|
|
"permissions": [["admin"], ["sats"]],
|
|
"parameters": {
|
|
"id_machine_cluster": { "description": "UID du groupe de machines", "type": "id" }
|
|
},
|
|
"output": {
|
|
"etrees": { "description": "E-trees du groupe", "type": "array<mixed>" }
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
"historyDefault": {
|
|
"POST::create": {
|
|
"description": "Retourne l'historique complet",
|
|
"permissions": [["admin"], ["sats"]],
|
|
"parameters": {
|
|
"id_machine": { "description": "Machine UID", "type": "id" },
|
|
"id_user": { "description": "User UID", "type": "id" },
|
|
"id_action": { "description": "Action UID", "type": "id" },
|
|
"timestamp": { "description": "timestamp", "type": "id" }
|
|
},
|
|
"output": {}
|
|
},
|
|
"POST::getAll": {
|
|
"description": "Retourne l'historique complet",
|
|
"permissions": [["admin"]],
|
|
"parameters": {},
|
|
"output": {
|
|
"history": { "description": "Données de l'historique", "type": "array" }
|
|
}
|
|
},
|
|
|
|
"POST::search": {
|
|
"description": "Recherche une entrée historique par mots-clés.",
|
|
"permissions": [["admin"]],
|
|
"parameters": {
|
|
"keywords": { "description": "Mots-clés de recherche d'entrée historique", "type": "text" }
|
|
},
|
|
"output": {
|
|
"history": { "description": "Liste des logs correspondant à la recherche.", "type": "array<array<mixed>>" }
|
|
}
|
|
},
|
|
|
|
"POST::archive": {
|
|
"description": "Archive de l'historique complet.",
|
|
"permissions": [["admin"]],
|
|
"options": { "download": true },
|
|
"parameters": {},
|
|
"output": {}
|
|
}
|
|
|
|
},
|
|
|
|
"fetchDefault": {
|
|
"POST::dispatch": {
|
|
"description": "Dispatche la gestion des données reçues par un SATS",
|
|
"permissions": [["sats"]],
|
|
"parameters": {
|
|
"etree": { "description": "Etree full name", "type": "text" },
|
|
"data": { "descripton": "Données reçues", "type": "mixed" }
|
|
},
|
|
"output": {
|
|
"saved": { "description": "Code de reception (nombre de lignes recues ou autre)", "type": "numeric" }
|
|
}
|
|
},
|
|
|
|
"POST::rfid_read": {
|
|
"description": "Enregistrement de l'historique de l'e-tree READ du module RFID",
|
|
"permissions": [["sats"]],
|
|
"parameters": {
|
|
"data": { "descripton": "Historique reçu", "type": "mixed" }
|
|
},
|
|
"output": {
|
|
"saved": { "description": "Nombre d'entrées enregistrées", "type": "id" }
|
|
}
|
|
}
|
|
},
|
|
|
|
"deployDefault": {
|
|
|
|
"POST::dispatch": {
|
|
"description": "Dispatche la gestion des données à synchroniser par un SATS",
|
|
"permissions": [["sats"]],
|
|
"parameters": {
|
|
"etree": { "description": "Etree full name", "type": "text" }
|
|
},
|
|
"output": {
|
|
"data": { "description": "Données à synchroniser", "type": "numeric" }
|
|
}
|
|
},
|
|
|
|
"POST::rfid_read": {
|
|
"description": "Enregistrement de l'historique de l'e-tree READ du module RFID",
|
|
"permissions": [["sats"]],
|
|
"parameters": {},
|
|
"output": {
|
|
"data": { "descripton": "Données à synchroniser", "type": "mixed" }
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
}
|