WebHook Deal Element (V5.4)

Résumé

Manipulation de l'entité DealElement (Eléments d'affaire) en lecture/écriture/suppression via un objet métier depuis une application externe.

Tables

Les tables utilisées sont :

sw_data_dealelement : Table des éléments d'affaire

Critères d'activation

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

Règles métier

verb: PUT

L'ajout d'éléments (dealelement) n'est pas autorisé pour une opportunité

Fonctionnement

verb: GET
resultType: simple

  "dealelement": {
    "codedealelement": "AFR000011-0-1.1",
    "deal_ID": "AFR000011",
    "label": "Elément 1.1",
    "originalCode": "1.1"
  }

verb: GET
resultType: extended

  "dealelement": {
    "codedealelement": "AFR000011-0-1.1",
    "deal_ID": "AFR000011",
    "label": "Elément 1.1",
    "originalCode": "1.1",
    "DataOrder": "11",
    "dealelementstructure_ID": "",
    "dealelement_ID_parent": "AFR000011-0-1"
  }

verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour les tables deal et dealelement_parent

"related":[
{
  "deal":{
    "codedeal": "AFR000011",
    "customer_ID": "C0000001",
    "label": "Vitrine de magasin",
    "generictype_ID_dealType": "Type affaire 1",
    "dealNumber": "PJ000011",
    "description": "",
    "creationDate": "2020-09-18 00:00:00",
    "closingDate": "",
    "amount": "300",
    "probability": "55",
    "customer_ID_introducer": "",
    "baseuser_ID": "",
    "amount2": "",
    "generictype_ID_status": "DRAFTING",
    "realClosingDate": "",
    "dealstep_ID_current": "",
    "deal_ID_origin": "",
    "manualProbability": "0",
    "marketinglead_ID_origin": "",
    "customercontact_ID": "C0000001-DJ"
  },
  "dealelement_parent": {
    "codedealelement": "AFR000011-0-1",
    "deal_ID": "AFR000011",
    "label": "Elément 1",
    "originalCode": "1",
    "DataOrder": "10",
    "dealelementstructure_ID": "",
    "dealelement_ID_parent": ""
  }
}]

verb: PUT

{
  "dealelement": {
    "codedealelement": "AFR000011-0-1.1", /* Code globalement unique de l'élément d'affaire (Varchar (255))*/ 
    "deal_ID": "AFR000011", /* Code affaire (ForeignKey () - sw_data_deal.codedeal)*/
    "label" : "Elément 1.1", /* Libellé (Varchar (255))*/  
    "DataOrder": "11", /* Ordre d'affichage (Int ())*/ 
    "originalCode": "1.1", /* Code de l'élément d'affaire à afficher (Varchar (255))*/
    "dealelementstructure_ID": "", /* Code structure (ForeignKey () - sw_data_dealelementstructure.codedealelementstructure)*/
    "dealelement_ID_parent": "AFR000011-0-1" /* Code élément d'affaire parent (nécessite que le parent a été créé avant celui-ci) (ForeignKey () - sw_data_dealelement.codedealelement)*/
  }
}

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

"filters:" {
  "codeDealElement": "value", filter is equal
  "label": "value", filter is contains
  "originalCode": "value", filter is equal
  "codeDeal": "value" filter is equal
},
"orderBy": "value"

Valeurs possibles pour le tri "orderBy" :

labelAsc : par intitulé ascendant
originalCodeAsc : par code d'origine ascendant
dataOrderAsc : par n° d'ordre ascendant