Comparaison de pages

...

Permet de lister les champs étendus à exclure pour les webhooks en mode LIST et GET (par défaut on retourne tous les champs).

Syntaxe

'extendedFieldsListToExclude': 'field1,field2,field3,...'

...

Je ne veux pas retourner les champs serialnumber et location

'extendedFieldsListToExclude': 'serialnumber,location'

...

Cette propriété n’est pas présente par défaut dans le squelette de la surcharge, il faudra l’ajouter manuellement.

Syntaxe

'simpleFieldsList': 'field1,field2,field3,...'

...

La liste du standard ne me convient pas et je veux afficher les champs codecustomer, name, city et final_pricecategory_ID_tarCod.

'simpleFieldsList': 'codecustomer,name,city,final_pricecategory_ID_tarCod'

...

Il faudra également fournir le nombre de tables liées.

Syntaxe

'relatedTablesCount': xx,
'relatedTables': [ 'fieldFK1', 'fieldFK2', '...' ]

...

Je veux compléter cette liste pour afficher les valeurs de la table liée au champ final_pricecategory_ID_tarCod.

'relatedTablesCount': 4,
'relatedTables': [ 'generictype_ID_customerFamily', 'baseuser_ID', 'generictype_ID_country', 'final_pricecategory_ID_tarCod' ]

La liste proposée par le standard ne me convient pas et je ne veux afficher que les valeurs liées pour generictype_ID_customerFamily complété par le champ final_pricecategory_ID_tarCod.

'relatedTablesCount': 2,
'relatedTables': [ 'generictype_ID_customerFamily', 'final_pricecategory_ID_tarCod' ]

...

Dans la surcharge il faudra reprendre la liste des tables autorisées du standard si vous voulez les conserver, complété par vos champstables.

Il faudra également que la fonction de définition de la table autorisée correspondante existe (WebhookDefinition_xxxx) ainsi que sa surcharge (WebhookDefinitionOverload_xxxx).

Cette propriété n’est pas présente par défaut dans le squelette de la surcharge, il faudra l’ajouter manuellement.

Syntaxe

'authorizedTables': [{'tableName':'mainTableName'}, {'tableName':'additionalTableName1'}, {'tableName':'additionalTableName2'}, {'tableName':'....'}

...

Je veux compléter cette liste pour gérer la table des opérations interventionoperationrange.

'authorizedTables': [{'tableName':'intervention'}, {'tableName':'interventionequipment'}, {'tableName':'interventionpart'}, {'tableName':'interventionoperationrange'}

Liste des tables pour suppression en cascade

Permet de lister les tables qui peuvent être supprimées en cascade pour les webhooks en mode DELETE.

Dans la surcharge il faudra reprendre la liste des tables du standard si vous voulez les conserver, complété par vos tables.

Cette propriété n’est pas présente par défaut dans le squelette de la surcharge, il faudra l’ajouter manuellement.

Syntaxe

'cascadeDeleteTables': [{'tableName':'tableName1'}, {'tableName':'tableName2'}, {'tableName':'...'}]

Exemple

Pour le webhook des interventions, le standard permet la suppression en cascade des tables suivantes : interventionequipment et interventionpart.

Je veux compléter cette liste pour gérer la table des opérations interventionoperationrange.

'cascadeDeleteTables': [{'tableName':'interventionequipment'}, {'tableName':'interventionpart'}, {'tableName':'interventionoperationrange'}],

Champs

Permet de lister des champs qui demandent un traitement spécial pour être affichés en mode LIST et GET ou pour la mise à jour en mode PUT. Par défaut pour les clés étrangères spécifiques on retourne toujours le code de la table étrangère. Il n’y a donc pas besoin de traitement spécifique pour ces cas si le code suffit.

Syntaxe

'fieldsList': {
      'field1': {
          'type': '…',
          'length': '…',
          'label': '…',
          'targetTableName': '…',
          'targetFieldName': '…',
          'fieldNameToShow': '…',
          'alias': '…',
          'mandatory': 0 or 1,
          'cannotBeNull': 0 or 1,
          'canGet': 0 or 1,
          'canInsert': 0 or 1,
          'canUpdate': 0 or 1,
          'deprecated': 0 or 1,
          'foreignParent': '…'		
      },
      'field2': {
          'type': '…',
          'length': '…',
          'label': '…',
          'targetTableName': '…',
      	  'targetFieldName': '…',
	  'fieldNameToShow': '…',
	  'alias': '…',
          'mandatory': 0 or 1,
          'cannotBeNull': 0 or 1,
          'canGet': 0 or 1,
          'canInsert': 0 or 1,
          'canUpdate': 0 or 1,
          'deprecated': 0 or 1,
	  'foreignParent': '…'
      },
      'field3': {
          'type': '…',
          'length': '…',
          'label': '…',
          'targetTableName': '…',
      	  'targetFieldName': '…',
	  'fieldNameToShow': '…',
	  'alias': '…',
          'mandatory': 0 or 1,
          'cannotBeNull': 0 or 1,
          'canGet': 0 or 1,
          'canInsert': 0 or 1,
          'canUpdate': 0 or 1,
          'deprecated': 0 or 1,
	  'foreignParent': '…'
      }
      … 
},
'outOfMainTableFields': [
{
    'fieldName': '…',
    'tableName': '…'
}
],

...

Permet de rajouter des filtres spécifiques pour interroger les données en mode LIST.

Syntaxe

'strictFilters': [
{
    'fieldName': '…',
    'operator': '…',
    'targetField': '…',
    'query': '…'    	
},
{
    'fieldName': '…',
    'operator': '…'
    'targetField': '…',
    'query': '…'
},
{
    ...
}
]

...

Permet de rajouter des tris spécifiques pour interroger les données en mode LIST.

Syntaxe

'strictOrderBy': [
{
    'name': '...',
    'fields': [
    {
        'field': '...',
        'order': '...'
    },
    {
        'field': '...',
        'order': '...'
    },
    {
        ...
    }]
},
{
    'name': '...',
    'fields': [
    {
        'field': '...',
        'order': '...'
    },
    {
        ...
    }]        
}]

...