WebHook Opportunity
- Philip Meyer (Unlicensed)
- Sofiene JUNKER
Résumé
Manipulation de l'entité Opportunity (Opportunités) en lecture/écriture/suppression via un objet métier depuis une application externe.
Remarque
Avant la Summer' 22, les opportunités étaient gérées par le webhook Deal.
Tables
Les tables utilisées sont :
sw_data_deal : Table des opportunités/affaires
Les tables liées sont :
/
Critères d'activation
WHK_Opportunity est défini dans la gestion des webhooks du studio.
Règles métier
verb: PUT
La date de création est mise par défaut à la date du jour (creationDate) si non fournie lors d'une création
Le statut est mis par défaut à 'Active' (generictype_ID_status = ACTIVE) si non fourni lors d'une création
L'ajout d'éléments (dealelement) n'est pas autorisé pour une opportunité
Fonctionnement
settings parameters
"settings":
{
"getPartners": "1" // pour le verb GET et LIST permet de retourner les informations des partenaires de l'opportunité
}verb: GET
resultType: simple
"opportunity":{
"codedeal": "PRJ000011",
"customer_ID": "C0000001",
"label": "Vitrine de magasin",
"creationDate": "2021-12-01 00:00:00"
"generictype_ID_dealType": "Type projet 1",
"generictype_ID_status": "ACTIVE",
"dealNumber": "PRJ000011"
}
verb: GET
resultType: extended
"opportunity":{
"codedeal": "AFR000011",
"customer_ID": "C0000001",
"label": "Vitrine de magasin",
"creationDate": "2021-12-01 00:00:00",
"generictype_ID_dealType": "Type projet 1",
"generictype_ID_status": "ACTIVE",
"dealNumber": "PRJ000011",
"description": "",
"closingDate": "",
"amount": "300",
"probability": "55",
"generictype_ID_lossReason": "",
"customer_ID_introducer": "",
"baseuser_ID": "MOREL",
"amount2": "",
"lossReasonComment": "",
"realClosingDate": "",
"dealstep_ID_current": "",
"deal_ID_origin": "",
"manualProbability": "0",
"marketinglead_ID_origin": "",
"customercontact_ID": "C0000001-DJ"
}verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour les tables generictype_deal_type, customer, customercontact, baseuser et generictype_status
verb: PUT
verb: LIST
resultType: simple, extended reprendre les définitions du GET
Valeurs possibles pour le tri "orderBy" :
opportunityNumberAsc : par n° d'affaire/opportunité ascendant
labelAsc : par intitulé ascendant
creationDateAsc : par date de création ascendant
creationDateDesc : par date de création descendant