Résumé
Manipulation de l'entité EquipmentType (Types d'équipement) en lecture/écriture/suppression via un objet métier depuis une application externe.
Tables
Les tables utilisées sont :
sw_data_equipmenttype : Table des types d'équipement
Critères d'activation
WHK_EquipmentType est défini dans la gestion des webhooks du studio.
Fonctionnement
verb: GET
resultType: simple
"equipmenttype": {
"codeequipmenttype": "BALL",
"label": "Ballon d'eau chaude"
}
verb: GET
resultType: extended
"equipmenttype": {
"codeequipmenttype": "BALL",
"label": "Ballons d'eau chaude",
"translationKey": "",
"equipmentkind_ID": "DEFAULT"
}
verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour la table equipmentkind
"related":[
{
"equipmentkind": {
"codeequipmentkind": "DEFAULT",
"label": "Par défaut",
"translationKey": "Gen_ByDefault"
}
}]
verb: PUT
{
"equipmenttype": {
"codeequipmenttype": "BALL", /* Code globalement unique du type d'équipement (Varchar (255))*/
"label": "Ballons d'eau chaude", /* Libellé du type d'équipement (Varchar (255)*/
"equipmentkind_ID": "DEFAULT", /* Code du genre d'équipement (ForeignKey () - sw_data_equipmentkind.codeequipmentkind)*/
"internalcodeequipmenttype": null /* codeequipmenttype original de weavy s'il y a eu transcodage (Varchar (255))*/
}
}
verb: LIST
resultType: simple, extended, extendedRelated reprendre les définitions du GET
"filters:" {
"codeEquipmentType": "value", filter is equal
"label": "value", filter is contains
"equipmentKind": "value" filter is equal
},
"orderBy": "value"
Valeur possibles pour le tri "orderBy" :
codeEquipmentTypeAsc : par code type d'équipement ascendant
labelAsc : par intitulé ascendant