Aller directement à la fin des métadonnées
Aller au début des métadonnées

Vous consultez une ancienne version de ce contenu. Consultez la version actuelle.

afficher les différences Afficher l'historique des versions

Vous regardez la version actuelle de cette page. (v. 1) afficher la version suivante »

Résumé

Manipulation de l'entité EventType (Types d'événements génériques) en lecture/écriture/suppression via un objet métier depuis une application externe.

Tables

Les tables utilisées sont :

  • sw_data_eventtype : Table des types d'événements

Les tables liées sont :
/

Critères d'activation

WHK_EventType est défini dans la gestion des webhooks du studio.

Règles métier

verb: PUT

  • Le type de parent est mis par défaut à ‘Autre' (generictype_ID_ParentType = ‘EVENT_PARENT_TYPE-OTHER’) si non fourni lors d’une création

  • Le mode de diffusion est mis par défaut à “Optionnel“ (generictype_ID_mailingmode = 'DIFFUSION_MODE-1') si non fourni lors d’une création

  • L’interdiction de la création dans le CRM Web est mise par défaut à 0 si non fourni lors d’une création

  • L’interdiction de la création dans le CRM Mobile est mise par défaut à 0 si non fourni lors d’une création

Fonctionnement

verb: GET
resultType: simple

  "eventtype": {
    "codeeventtype": "ADM",
    "label": "Administratif"
  }

verb: GET
resultType: extended

  "eventtype": {
    "codeeventtype": "ADM",
    "label": "Administratif",
    "functionName": "",
    "popupWidth": "",
    "popupHeight": "",
    "codepicture": "",
    "translationKey": "",
    "popupWidthSmartphone": "",
    "popupHeightSmartphone": "",
    "generictype_ID_ParentType": "OTHER",
    "generictype_ID_mailingmode": "Optional",
    "disallowBOcreation": "0",
    "disallowFOcreation": "0"  

verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour la table generictype_ParentType et generictype_mailingmode

"related":[
{
  "generictype_ParentType": {
    "codegenerictype": "EVENT_PARENT_TYPE-OTHER",
    "label": "Other",
    "originalCode": "OTHER",
    "dataType": "EVENT_PARENT",
    "description": "",
    "translationKey": "GenType_EVENT_PARENT_TYPE-OTHER",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  },
  "generictype_mailingmode": {
    "codegenerictype": "DIFFUSION_MODE-1",
    "label": "Optional",
    "originalCode": "1",
    "dataType": "DIFFUSION_MODE",
    "description": "",
    "translationKey": "GenType_DIFFUSION_MODE-1",
    "generictype_ID_parent": "",
    "tag": "",
    "orderNumber": ""
  }
}]

verb: PUT

{
  "eventtype": {
    "codeeventtype": "ADM", /* Code globalement unique du type d'événement (Varchar (255))*/
    "label": "Administratif", /* Libellé du type d'événement (Varchar (255))*/
    "translationKey": "", /* Clé de langue (Varchar (255))*/
    "generictype_ID_ParentType": "EVENT_PARENT_TYPE-OTHER", /* Code type de parent (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = EVENT_PARENT_TYPE)*/
    "generictype_ID_mailingmode": "DIFFUSION_MODE-1", /* Code mode de diffusion (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = DIFFUSION_MODE)*/
    "disallowBOcreation": "0", /* Intedire la création dans le CRM Web (Bool ())*/
    "disallowFOcreation": "0" /* Intedire la création dans le CRM Mobile (Bool ())*/
  }
}

verb: LIST
resultType: simple, extended reprendre les définitions du GET

"filters:" {
  "codeEventType": "value", filter is equal
  "label": "value", filter is contains
  "disallowFOcreation": "value", filter is equal
  "disallowBOcreation": "value", filter is equal
  "disallowAddinOutlookcreation": "value", filter is equal
  "functionName": "value", filter is equal
},
"orderBy": "value"

Valeurs possibles pour le tri "orderBy" :

  • codeEventTypeAsc : par code type d'événement ascendant

  • labelAsc : par intitulé ascendant

  • Aucune étiquette