Expressions adaptatives et fonctions prédéfinies

S’APPLIQUE À : SDK v4

Cet article présente les fonctions prédéfinies disponibles classées selon leur usage général. Pour en savoir plus sur les opérateurs utilisés dans les fonctions prédéfinies et la syntaxe d’expression, reportez-vous à Opérateurs.

Les expressions prédéfinies se répartissent en plusieurs types de fonctions :

• Chaîne
• Collection
• Comparaison logique
• Conversion
• Mathématique
• Date
• Timex
• Analyse d’URI
• Manipulation et construction d’objet
• Expression régulière
• Contrôle de type

Vous pouvez également consulter la liste par ordre alphabétique.

Fonctions de chaînes

Fonction	Explication
length	Retourne la longueur d'une chaîne.
replace	Remplace une sous-chaîne par la chaîne spécifiée et retourne la chaîne mise à jour. Cette fonction respecte la casse.
replaceIgnoreCase	Remplacer une sous-chaîne par la chaîne spécifiée et renvoyer la chaîne mise à jour. Cette fonction ne respecte pas la casse.
split	Retourne un tableau contenant les sous-chaînes obtenues en fonction du délimiteur spécifié.
substring	Retourne les caractères d’une chaîne.
toLower	Retourne une chaîne en minuscules dans une mise en forme locale facultative.
toUpper	Retourne une chaîne en capitales dans un format de paramètres régionaux facultatif.
trim	Supprime les espaces blancs de début et de fin d’une chaîne.
addOrdinal	Retourne le numéro ordinal du nombre d’entrée.
endsWith	Vérifie si une chaîne se termine par une sous-chaîne spécifique. Retourne true si la sous-chaîne est trouvée, false sinon. Cette fonction ne respecte pas la casse.
startsWith	Vérifie si une chaîne commence par une sous-chaîne spécifique. Retourne true si la sous-chaîne est trouvée, false sinon. Cette fonction ne respecte pas la casse.
countWord	Retourne le nombre de mots de la chaîne donnée.
concat	Combine au moins deux chaînes et retourne la chaîne obtenue.
newGuid	Retourne une nouvelle chaîne GUID.
indexOf	Retourne la position ou la valeur d’index de départ d’une sous-chaîne ou recherche l’objet spécifié et retourne l’index en base zéro de la première occurrence dans toute la liste. Cette fonction ne respecte pas la casse, et les index commencent par le chiffre 0.
lastIndexOf	Retourne la position ou la valeur d’index de départ de la dernière occurrence d’une sous-chaîne ou recherche l’objet spécifié et retourne l’index en base zéro de la dernière occurrence dans la plage d’éléments de la liste. Cette fonction ne respecte pas la casse, et les index commencent par le chiffre 0.
sentenceCase	Mettre en majuscule la première lettre du premier mot dans une chaîne dans une mise en forme locale facultative.
titleCase	Mettre en majuscule la première lettre de chaque mot dans une chaîne dans une mise en forme locale facultative.
inverser	Inverse l’ordre des éléments dans une chaîne ou un tableau.

Fonctions de collection

Fonction	Explication
contains	Permet de rechercher un élément dans une chaîne, un élément dans un tableau ou un paramètre dans un objet complexe. Exemples : contains('hello world', 'hello') contains(createArray('1','2'), '1') contains(json("{'foo':'bar'}"), 'foo')
first	Retourne le premier élément de la collection.
join	Retourne une chaîne qui contient tous les éléments d’un tableau, et dont tous les caractères sont séparés par un séparateur. Exemple : join(createArray(’a’,’b’), ’.’) = « a.b »
last	Retourne le dernier élément de la collection.
count	Retourne le nombre d'éléments de la collection.
foreach	S’applique à chaque élément et retourne la nouvelle collection.
union	Retourne une collection qui contient tous les éléments des collections spécifiées.
skip	Supprime des éléments du début d’une collection et retourne les autres éléments.
take	Retourne des éléments du début d’une collection.
intersection	Retourne une collection qui contient uniquement les éléments communs aux collections spécifiées.
subArray	Retourne un sous-tableau à partir des positions de début et de fin spécifiées. Les valeurs d’index commencent par le chiffre 0.
select	S’applique à chaque élément et retourne la nouvelle collection d’éléments transformés.
where	Filtre sur chaque élément et retourne la nouvelle collection d’éléments filtrés qui respectent la condition spécifiée.
sortBy	Trie les éléments de la collection par ordre croissant et retourne la collection triée.
sortByDescending	Trie les éléments de la collection par ordre décroissant et retourne la collection triée.
indicesAndValues	Transforme un tableau ou un objet en tableau d’objets avec la propriété d’index et de valeur.
aplatir	Aplatit les tableaux dans un tableau dont les valeurs ne sont pas des tableaux.
unique	Supprime tous les doublons d’un tableau.
any	Détermine si certains éléments d’une séquence remplissent une condition.
all	Détermine si tous les éléments d’une séquence remplissent une condition.
inverser	Inverse l’ordre des éléments dans une chaîne ou un tableau.
merge	Fusionne plusieurs objets ou éléments JSON dans un tableau.

Fonctions de comparaison logique

Fonction	Explication
and	Opérateur AND logique. Retourne true si toutes les expressions spécifiées donnent true.
equals	Opérateur de comparaison égal à. Retourne true si les valeurs spécifiées sont égales.
empty	Vérifiez si la cible est vide.
greater	Opérateur de comparaison supérieur à. Retourne true si la première valeur est supérieure, false si elle est inférieure.
greaterOrEquals	Opérateur de comparaison supérieur ou égal à. Retourne true si la première valeur est supérieure ou égale, false si elle est inférieure.
if	Vérifie si une expression est vraie ou fausse. En fonction du résultat, retourne une valeur spécifiée.
less	Comparaison inférieure à l’opération. Retourne true si la première valeur est inférieure, false si elle est supérieure.
lessOrEquals	Opérateur de comparaison inférieur ou égal à. Retourne true si la première valeur est inférieure ou égale, false si elle est supérieure.
not	Opérateur NOT logique. Retourne true si l’expression est fausse, false si elle est vraie.
ou	Opération OR logique. Retourne true si au moins une expression est vraie, false si elles sont toutes fausses.
exists	Évalue la vérité d’une expression.

Fonctions de conversion

Fonction	Explication
float	Retourne la représentation de virgule flottante de la chaîne spécifiée.
int	Retourne la représentation entière de la chaîne spécifiée.
string	Retourne la version de chaîne de la valeur spécifiée dans une mise en forme locale facultative.
bool	Retourne la représentation booléenne de la chaîne spécifiée.
createArray	Crée un tableau à partir de plusieurs entrées.
json	Retourne la valeur ou l’objet de type JavaScript Object Notation (JSON) d’une chaîne ou d’un élément XML.
base64	Retourne la version encodée en base64 d’une chaîne ou d’un tableau d’octets.
base64ToBinary	Retourne la version binaire d’une chaîne encodée en Base64.
base64ToString	Retourne la version de type chaîne d’une chaîne encodée en base64.
binary	Renvoyer la version binaire d’une valeur d’entrée.
dataUri	Retourne l’URI d’une valeur d’entrée.
dataUriToBinary	Retourne la version binaire d’un URI de données.
dataUriToString	Retourne la version de type chaîne d’un URI de données.
uriComponent	Renvoyer la version encodée dans un URI d’une valeur d’entrée en remplaçant les caractères non sécurisés pour les URL par des caractères d’échappement.
uriComponentToString	Retourne la version de type chaîne d’une chaîne encodée dans un URI.
xml	Retourne la version XML d’une chaîne.
formatNumber	Met en forme une valeur au nombre le plus proche en fonction du nombre de chiffres de fraction spécifié et d’un paramètre local facultatif spécifié.
jsonStringify	Retourne la chaîne JSON d’une valeur.
stringOrValue Inclure dans un wrapper l’interpolation de la chaîne de caractères pour obtenir la valeur réelle. Par exemple, stringOrValue('${1}') retourne le nombre 1, tandis que stringOrValue('${1} item') retourne la chaîne « 1 élément ».

Fonctions mathématiques

Fonction	Explication
abs	Retourne la valeur absolue du nombre spécifié.
add	AND mathématique. Retourne le résultat de l’addition de deux nombres (dans le cas de nombres purs), ou de la concaténation de deux chaînes ou plus.
div	Division mathématique. Retourne l’entier résultant de la division de deux nombres.
max	Retourne la plus grande valeur d’une collection.
min	Retourne la plus petite valeur d’une collection.
mod	Retourne le reste de la division de deux nombres.
mul	Multiplication mathématique. Retourne le produit de la multiplication de deux nombres.
rand	Retourne un nombre aléatoire compris entre la valeur minimale et la valeur maximale spécifiées.
sqrt	Retourne la racine carrée d’un nombre spécifié.
sub	Soustraction mathématique. Retourne le résultat de la soustraction du second nombre du premier.
sum	Retourne la somme des nombres d’un tableau.
range	Retourne un tableau d’entiers qui commence par un entier spécifique.
exp	Retourne l’élévation d’un nombre à la puissance d’un autre.
average	Retourne le nombre moyen d’un tableau numérique.
floor	Retourne le plus grand nombre entier qui est inférieur ou égal au nombre spécifié.
ceiling	Retourne le plus petit nombre entier supérieur ou égal au nombre spécifié.
round	Arrondit une valeur à l’entier le plus proche ou au nombre spécifié de chiffres fractionnaires.

Fonctions de date et heure

Fonction	Explication
addDays	Ajoute le nombre de jours spécifié à un horodateur donné dans une mise en forme locale facultative.
addHours	Ajoute un nombre d’heures spécifié à un horodateur donné dans une mise en forme locale facultative.
addMinutes	Ajoute un nombre de minutes spécifié à un horodateur donné dans une mise en forme locale facultative.
addSeconds	Ajoute un nombre de secondes spécifié à un timestamp donné.
dayOfMonth	Retourne le jour d’un mois pour un timestamp ou une expression Timex donné.
dayOfWeek	Retourne le jour de la semaine d’un timestamp donné.
dayOfYear	Retourne le jour de l’année d’un timestamp donné.
formatDateTime	Retourne un horodateur dans une mise en forme locale facultative.
formatEpoch	Retourne un horodateur dans une mise en forme locale facultative à partir de l’heure Epoch UNIX (heure Unix, heure POSIX).
formatTicks	Retourne un horodateur dans une mise en forme locale facultative sous une forme cyclique.
subtractFromTime	Soustrait un nombre d’unités de temps d’un horodateur dans une mise en forme locale facultative.
utcNow	Retourne l’horodateur actuel dans une mise en forme locale facultative sous forme de chaîne.
dateReadBack	Utilise la bibliothèque date-heure pour fournir une relecture de date.
month	Retourne le mois du timestamp donné.
date	Retourne la date du timestamp donné.
year	Retourne l’année du timestamp donné.
getTimeOfDay	Retourne l’heure de la journée du timestamp donné.
getFutureTime	Retourne l’horodateur actuel dans une mise en forme locale facultative, plus les unités de temps spécifiées.
getPastTime	Retourne l’horodateur actuel dans une mise en forme locale facultative, moins les unités de temps spécifiées.
addToTime	Ajoute un nombre d’unités de temps à un horodateur dans une mise en forme locale facultative.
convertFromUTC	Convertit un horodateur dans une mise en forme locale facultative à partir du temps universel coordonné (UTC).
convertToUTC	Convertit un horodateur dans une mise en forme locale facultative en temps universel coordonné (UTC).
startOfDay	Retourne le début de la journée pour un horodateur dans une mise en forme locale facultative.
startOfHour	Retourne le début de l’heure pour un horodateur dans une mise en forme locale facultative.
startOfMonth	Retourne le début du mois pour un horodateur dans une mise en forme locale facultative.
ticks	Retourne la valeur de la propriété Ticks d’un timestamp spécifié.
ticksToDays	Convertissez une valeur de propriété de cycles en nombre de jours.
ticksToHours	Convertit une valeur de propriété de cycles en nombre d’heures.
ticksToMinutes	Convertit une valeur de propriété de cycles en nombre de minutes.
DateTimeDiff	Retourne la différence de cycles entre deux horodateurs.
getPreviousViableDate	Retourne la date viable précédente d’une expression Timex en fonction de la date actuelle et d’un fuseau horaire spécifié éventuellement.
getNextViableDate	Retourne la date viable suivante d’une expression Timex en fonction de la date actuelle et d’un fuseau horaire spécifié éventuellement.
getPreviousViableTime	Retourne l’heure viable précédente d’une expression Timex en fonction de l’heure actuelle et d’un fuseau horaire spécifié éventuellement.
getNextViableTime	Retourne l’heure viable suivante d’une expression Timex en fonction de l’heure actuelle et d’un fuseau horaire spécifié éventuellement.

Fonctions Timex

Fonction	Explication
isPresent	Retourne true si l’expression TimexProperty ou Timex fait référence au moment présent.
isDuration	Retourne true si l’expression TimexProperty ou Timex fait référence à une durée.
isTime	Retourne true si l’expression TimexProperty ou Timex fait référence à une heure.
isDate	Retourne true si l’expression TimexProperty ou Timex fait référence à une date.
isTimeRange	Retourne true si l’expression TimexProperty ou Timex fait référence à un intervalle de temps.
isDateRange	Retourne true si l’expression TimexProperty ou Timex fait référence à une plage de dates.
isDefinite	Retourne true si l’expression TimexProperty ou Timex fait référence à un jour défini.
resolve	Retourne une chaîne d’expressions TimexProperty ou Timex données si elle fait référence à une heure valide. L’heure valide comporte des heures, des minutes et des secondes.

Fonctions d’analyse des URI

Fonction	Explication
uriHost	Retourne la valeur d’hôte d’un URI (Uniform Resource Identifier).
uriPath	Retourne la valeur de chemin d’un Uniform Resource Identifier (URI).
uriPathAndQuery	Retourne les valeurs de chemin et de requête d’un URI (Uniform Resource Identifier).
uriPort	Retourne la valeur de port d’un URI (Uniform Resource Identifier).
uriQuery	Retourne la valeur de requête d’un Uniform Resource Identifier (URI).
uriScheme	Retourne la valeur de schéma d’un URI (Uniform Resource Identifier).

Fonctions de manipulation et de construction d’objet

Fonction	Explication
addProperty	Ajoute une propriété et sa valeur, ou sa paire nom-valeur, à un objet JSON et retourne l’objet mis à jour.
removeProperty	Supprime une propriété d’un objet JSON et retourne l’objet mis à jour.
setProperty	Définit la valeur d’une propriété d’un objet JSON et retourne l’objet mis à jour.
getProperty	Retourne la valeur d’une propriété ou d’une propriété racine spécifiée à partir d’un objet JSON.
coalesce	Retourne la première valeur autre que Null d’un ou plusieurs paramètres.
xPath	Vérifie si le code XML contient des valeurs ou des nœuds qui correspondent à une expression de langage XPath et retourne les valeurs ou les nœuds correspondants.
jPath	Vérifie si les nœuds ou la valeur d’un code ou d’une chaîne JSON correspondent à une expression de chemin, et retourne les nœuds correspondants.
setPathToValue	Définit la valeur d’un chemin spécifié et retourne la valeur.

Fonctions d’expression régulière

Fonction	Explication
isMatch	Retourne true si une chaîne correspond à un modèle de regex courant.

Fonctions de vérification du type

Fonction	Explication
EOL	Retourne le texte de séquence de fin de ligne (EOL).
isInteger	Retourne true si l’entrée donnée est un nombre entier.
isFloat	Retourne true si l’entrée donnée est un nombre à virgule flottante.
isBoolean	Retourne true si l’entrée donnée est un booléen.
isArray	Retourne true si l’entrée donnée est un tableau.
isObject	Retourne true si l’entrée donnée est un objet.
isDateTime	Retourne true si l’entrée donnée est un timestamp au format ISO UTC.
isString	Retourne true si l’entrée donnée est une chaîne.

Fonctions prédéfinies triées par ordre alphabétique

abs

Retourne la valeur absolue du nombre spécifié.

abs(<number>)

Paramètre	Obligatoire	Type	Description
<number>	Oui	nombre	Nombre pour obtenir la valeur absolue de

Valeur retournée	Type	Description
<result>	nombre	Résultat du calcul de la valeur absolue.

Exemples

Ces exemples calculent la valeur absolue :

abs(3.12134)
abs(-3.12134)

Le résultat retourné est 3,12134 dans les deux cas.

add

Retourne le résultat de l’addition de deux nombres ou plus (dans le cas de nombres purs), ou de la concaténation de deux chaînes ou plus (autre cas).

add(<item1>, <item2>, ...)

Paramètre	Obligatoire	Type	Description
<élément 1>, <élément 2>, etc.	Oui	n'importe laquelle	items

Valeur retournée	Type	Description
<result-sum>	nombre ou chaîne	Résultat de l’addition des nombres spécifiés ou résultat de la concaténation.

Exemple

Cet exemple illustre l’addition des nombres spécifiés :

add(1, 1.5)

Le résultat retourné est 2.5.

Cet exemple concatène les éléments spécifiés :

add('hello',null)
add('hello','world')

Et retourne les résultats

• hello
• helloworld

addDays

Ajoute le nombre de jours à un horodateur dans une mise en forme locale facultative.

addDays('<timestamp>', <days>, '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne contenant le timestamp qui doit être au format ISO UTC standard. AAAA-MM-JJTHH:mm:ss.fffZ
<days>	Oui	entier	Nombre de jours positif ou négatif à ajouter
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage plus le nombre de jours spécifié

Exemple 1

Cet exemple illustre l’ajout de 10 jours à l’horodateur spécifié :

addDays('2018-03-15T13:00:00.000Z', 10)

Le résultat retourné est 2018-03-25T00:00:00.000Z.

Exemple 2

Cet exemple illustre le retrait de cinq jours de l’horodatage spécifié :

addDays('2018-03-15T00:00:00.000Z', -5)

Le résultat retourné est 2018-03-10T00:00:00.000Z.

Exemple 3

Cet exemple ajoute 1 jour à l’horodateur spécifié au format de-DE :

addDays('2018-03-15T13:00:00.000Z', 1, '', 'de-dE')

Le résultat retourné est 16.03.18 13:00:00.

addHours

Ajoute le nombre d’heures à un horodateur dans une mise en forme locale facultative.

addHours('<timestamp>', <hours>, '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<hours>	Oui	entier	Nombre d’heures positif ou négatif à ajouter
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage plus le nombre d’heures spécifié

Exemple 1

Cet exemple illustre l’ajout de 10 heures à l’horodateur spécifié :

addHours('2018-03-15T00:00:00.000Z', 10)

Le résultat retourné est 2018-03-15T10:00:00.000Z.

Exemple 2

Cet exemple illustre le retrait de cinq heures de l’horodatage spécifié :

addHours('2018-03-15T15:00:00.000Z', -5)

Le résultat retourné est 2018-03-15T10:00:00.000Z.

Exemple 3

Cet exemple illustre l’ajout de 2 heures à l’horodateur spécifié au format de-DE :

addHours('2018-03-15T13:00:00.000Z', 2, '', 'de-DE')

Le résultat retourné est 15.03.18 15:00:00.

addMinutes

Ajoute le nombre de minutes à un horodateur dans une mise en forme locale facultative.

addMinutes('<timestamp>', <minutes>, '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<minutes>	Oui	entier	Nombre de minutes positif ou négatif à ajouter
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage plus le nombre de minutes spécifié

Exemple 1

Cet exemple illustre l’ajout de 10 minutes à l’horodateur spécifié :

addMinutes('2018-03-15T00:10:00.000Z', 10)

Le résultat retourné est 2018-03-15T00:20:00.000Z.

Exemple 2

Cet exemple illustre le retrait de cinq minutes de l’horodatage spécifié :

addMinutes('2018-03-15T00:20:00.000Z', -5)

Le résultat retourné est 2018-03-15T00:15:00.000Z.

Exemple 3

Cet exemple illustre l’ajout de 30 minutes à l’horodateur spécifié au format de-DE :

addMinutes('2018-03-15T00:00:00.000Z', 30, '', 'de-DE')

Le résultat retourné est 15.03.18 13:30:00.

addOrdinal

Retourne le numéro ordinal du nombre d’entrée.

addOrdinal(<number>)

Paramètre	Obligatoire	Type	Description
<number>	Oui	entier	Nombres à convertir en nombre ordinal

Valeur retournée	Type	Description
<result>	string	Nombre ordinal converti à partir du nombre d’entrée

Exemple

addOrdinal(11)
addOrdinal(12)
addOrdinal(13)
addOrdinal(21)
addOrdinal(22)
addOrdinal(23)

Les résultats retournés sont respectivement :

• 11th
• 12th
• 13th
• 21st
• 22nd
• 23rd

addProperty

Ajouter une propriété et sa valeur, ou paire nom-valeur, à un objet JSON et renvoyer l’objet mis à jour. Si l’objet existe déjà à l’exécution, la fonction génère une erreur.

addProperty('<object>', '<property>', value)

Paramètre	Obligatoire	Type	Description
<object>	Oui	object	Objet JSON dans lequel vous souhaitez ajouter une propriété
<property>	Oui	string	Nom de la propriété à ajouter
<valeur>	Oui	n'importe laquelle	Valeur de la propriété

Valeur retournée	Type	Description
<updated-object>	object	Objet JSON mis à jour après l’ajout d’une nouvelle propriété

Exemple

Dans cet exemple, la propriété accountNumber est ajoutée à l’objet customerProfile, qui est converti au format JSON avec la fonction json(). La fonction affecte une valeur qui est générée par la fonction newGuid(), et retourne l’objet mis à jour :

addProperty(json('customerProfile'), 'accountNumber', newGuid())

addSeconds

Ajoute un nombre de secondes à un horodatage.

addSeconds('<timestamp>', <seconds>, '<format>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<seconds>	Oui	entier	Nombre de secondes positif ou négatif à ajouter
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage plus le nombre de secondes spécifié

Exemple 1

Cet exemple illustre l’ajout de 10 secondes à l’horodatage spécifié :

addSeconds('2018-03-15T00:00:00.000Z', 10)

Le résultat retourné est 2018-03-15T00:00:10.000Z.

Exemple 2

Cet exemple illustre le retrait de cinq secondes de l’horodatage spécifié :

addSeconds('2018-03-15T00:00:30.000Z', -5)

Le résultat retourné est 2018-03-15T00:00:25.000Z.

addToTime

Ajoute un nombre d’unités de temps à un horodateur dans une mise en forme locale facultative. Voir aussi getFutureTime().

addToTime('<timestamp>', '<interval>', <timeUnit>, '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<interval>	Oui	entier	Nombre d’unités de temps spécifiées à ajouter
<timeUnit>	Oui	string	Unité de temps à utiliser avec interval. Unités possibles : « Second » (seconde), « Minute » (minute), « Hour » (heure), « Day » (jour), « Week » (semaine), « Month » (mois) et « Year » (année).
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<updated-timestamp>	string	Timestamp plus le nombre d’unités de temps spécifiées au format donné.

Exemple 1 :

Dans cet exemple, un jour est ajouté au timestamp spécifié.

addToTime('2018-01-01T00:00:00.000Z', 1, 'Day')

Le résultat retourné est 2018-01-02T00:00:00.000Z.

Exemple 2

Dans cet exemple, deux semaines sont ajoutées au timestamp spécifié.

addToTime('2018-01-01T00:00:00.000Z', 2, 'Week', 'MM-DD-YY')

Le résultat, retourné au format « MM-JJ-AA », est 01-15-18.

all

Détermine si tous les éléments d’une séquence remplissent une condition.

all(<sequence>, <item>, <condition>)

Paramètre	Obligatoire	Type	Description
<Séquence>	Oui	object	Séquence à évaluer.
<item>	Oui	string	Fait référence aux éléments à évaluer dans la séquence.
<condition>	Oui	expression	Expression permettant d’évaluer la condition.

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si tous les éléments répondent à une condition. Retourne false si au moins un n’en a pas.

Exemples

Ces exemples déterminent si tous les éléments d’une séquence remplissent une condition :

all(createArray(1, 'cool'), item, isInteger(item))
all(createArray(1, 2), item => isInteger(item))

Les résultats retournés sont respectivement :

• false, car les deux éléments de la séquence ne sont pas des entiers.
• true, car les deux éléments de la séquence sont des entiers.

et

Vérifie si toutes les expressions sont vraies. Retourne true si toutes les expressions sont vraies, false si au moins une expression est fausse.

and(<expression1>, <expression2>, ...)

Paramètre	Obligatoire	Type	Description
<expression1>, <expression2>, …	Oui	Boolean	Expressions à vérifier

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si toutes les expressions sont vraies. Retourne false si au moins une expression est fausse.

Exemple 1 :

Ces exemples vérifient si toutes les valeurs booléennes spécifiées sont vraies :

and(true, true)
and(false, true)
and(false, false)

Les résultats retournés sont respectivement :

• Comme les deux expressions sont vraies, la fonction retourne true.
• Comme l’une des expressions est fausse, la fonction retourne false.
• comme les deux expressions sont fausses, la fonction retourne false.

Exemple 2

Ces exemples vérifient si toutes les expressions spécifiées sont vraies :

and(equals(1, 1), equals(2, 2))
and(equals(1, 1), equals(1, 2))
and(equals(1, 2), equals(1, 3))

Les résultats retournés sont respectivement :

• Comme les deux expressions sont vraies, la fonction retourne true.
• Comme l’une des expressions est fausse, la fonction retourne false.
• Comme les deux expressions sont fausses, la fonction retourne false.

n'importe laquelle

Détermine si certains éléments d’une séquence remplissent une condition.

all(<sequence>, <item>, <condition>)

Paramètre	Obligatoire	Type	Description
<Séquence>	Oui	object	Séquence à évaluer.
<item>	Oui	string	Fait référence aux éléments à évaluer dans la séquence.
<condition>	Oui	expression	Expression permettant d’évaluer la condition.

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si tous les éléments répondent à la condition. Retourne false si au moins un n’en a pas.

Exemples

Ces exemples déterminent si tous les éléments d’une séquence remplissent une condition :

any(createArray(1, 'cool'), item, isInteger(item))
any(createArray('first', 'cool'), item => isInteger(item))

Les résultats retournés sont respectivement :

• true, car au moins un élément de la séquence est un entier
• false, car aucun élément de la séquence n’est un entier.

average

Retourne le nombre moyen d’un tableau numérique.

average(<numericArray>)

Paramètre	Obligatoire	Type	Description
<numericArray>	Oui	tableau de nombres	Tableau d’entrée pour calculer la moyenne

Valeur retournée	Type	Description
<average-of-array>	nombre	Valeur moyenne du tableau donné

Exemple

Dans cet exemple, la moyenne du tableau est calculée dans createArray() :

average(createArray(1,2,3))

Le résultat retourné est 2.

base64

Retourne la version encodée en base64 d’une chaîne ou d’un tableau d’octets.

base64('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	Chaîne ou tableau d’octets	Chaîne d’entrée

Valeur retournée	Type	Description
<base64-string>	string	Version encodée en base64 de la chaîne d’entrée

Exemple 1 :

Dans cet exemple, la chaîne hello est convertie en chaîne encodée en base64 :

base64('hello')

Le résultat retourné est "aGVsbG8=".

Exemple 2

Cet exemple prend byteArr, ce qui est égal à new byte[] { 3, 5, 1, 12 } :

base64('byteArr')

Le résultat retourné est "AwUBDA==".

base64ToBinary

Retourne le tableau binaire d’une chaîne encodée en base64.

base64ToBinary('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne encodée en Base64 à convertir

Valeur retournée	Type	Description
<binary-for-base64-string>	tableau d’octets	Version binaire de la chaîne encodée en base64

Exemple

Dans cet exemple, la chaîne AwUBDA== encodée en base64 est convertie en chaîne binaire :

base64ToBinary('AwUBDA==')

Le résultat retourné est new byte[] { 3, 5, 1, 12 }.

base64ToString

Retourne la version de type chaîne d’une chaîne encodée en base64, en décodant la chaîne base64.

base64ToString('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne encodée en Base64 à décoder

Valeur retournée	Type	Description
<decoded-base64-string>	string	Version de type chaîne d’une chaîne encodée en base64

Exemple

Dans cet exemple, la chaîne aGVsbG8= encodée en base64 est convertie en chaîne décodée :

base64ToString('aGVsbG8=')

Le résultat retourné est hello.

binary

Retourne la version binaire d’une chaîne.

binary('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne à convertir

Valeur retournée	Type	Description
<binary-for-input-value>	tableau d’octets	Version binaire de la chaîne spécifiée

Exemple

Dans cet exemple, la chaîne hello est convertie en chaîne binaire :

binary('hello')

Le résultat retourné est new byte[] { 104, 101, 108, 108, 111 }.

bool

Retourne la version booléenne d’une valeur.

bool(<value>)

Paramètre	Obligatoire	Type	Description
<value>	Oui	n'importe laquelle	Valeur à convertir

Valeur retournée	Type	Description
True ou False	Boolean	Version booléenne de la valeur spécifiée

Exemple

Ces exemples illustrent la conversion des valeurs spécifiées en valeurs booléennes :

bool(1)
bool(0)

Les résultats retournés sont respectivement :

• true
• false

ceiling

Retourne le plus grand nombre entier qui est inférieur ou égal au nombre spécifié.

ceiling('<number>')

Paramètre	Obligatoire	Type	Description
<number>	Oui	nombre	Un nombre d’entrée

Valeur retournée	Type	Description
<Integer-value>	entier	L’entier le plus grand supérieur ou égal au nombre d’entrée

Exemple

Cet exemple retourne l’entier le plus élevé inférieur ou égal au nombre 10,333 :

ceiling(10.333)

Et retourne l’entier 11.

coalesce

Retourne la première valeur autre que Null d’un ou plusieurs paramètres. Les chaînes vides, les tableaux vides et les objets vides ne sont pas null.

coalesce(<object**1>, <object**2>, ...)

Paramètre	Obligatoire	Type	Description
<object**1>, <object**2>, etc.	Oui	Indifférent (types mixtes acceptés)	Recherche de la valeur Null dans un ou plusieurs éléments

Valeur retournée	Type	Description
<first-non-null-item>	n'importe laquelle	Premier élément ou valeur autre que Null. Si tous les paramètres ont la valeur Null, cette fonction retourne la valeur Null.

Exemple

Ces exemples retournent la première valeur autre que Null à partir des valeurs spécifiées ou la valeur Null lorsque toutes les valeurs le sont :

coalesce(null, true, false)
coalesce(null, 'hello', 'world')
coalesce(null, null, null)

Et retournent respectivement :

• true
• hello
• null

concat

Combine au moins deux objets et les retourne sous forme de liste ou de chaîne.

concat('<text1>', '<text2>', ...)

Paramètre	Obligatoire	Type	Description
<object1>, <object2>, ...	Oui	n'importe laquelle	Au moins deux objets à concaténer.

Valeur retournée	Type	Description
<object1object2…>	chaîne ou liste	Chaîne ou liste combinée. Les valeurs Null sont ignorées.

Valeurs renvoyées attendues :

• Si tous les éléments sont des listes, une liste est retournée.
• S’il existe un élément qui n’est pas une liste, une chaîne est retournée.
• Si une valeur est nulle, elle est ignorée et n’est pas concaténée.

Exemple

Dans cet exemple, les chaînes Hello et World sont combinées :

concat('Hello', 'World')

Le résultat retourné est HelloWorld.

Exemple 2

Cet exemple combine les listes [1,2] et [3,4] :

concat([1,2],[3,4])

Le résultat retourné est [1, 2, 3, 4].

Exemple 3

Ces exemples combinent des objets de différents types :

concat('a', 'b', 1, 2)
concat('a', [1,2])

Les résultats retournés sont respectivement :

• Chaîne ab12.
• Objet aSystem.Collections.Generic.List 1[System.Object]. Objet illisible qu’il vaut mieux éviter.

Exemple 4

Ces exemples combinent des objets null :

concat([1,2], null)
concat('a', 1, null)

Les résultats retournés sont respectivement :

• Liste [1,2].
• Chaîne a1.

contains

Vérifie si une collection contient un élément spécifique. Retourne true si l’élément est trouvé, false sinon. Cette fonction respecte la casse.

contains('<collection>', '<value>')
contains([<collection>], '<value>')

Cette fonction agit sur ces types de collections suivants :

• Une chaîne pour y rechercher une sous-chaîne
• Un tableau pour y rechercher une valeur
• Un ensemble de clés pour y rechercher une clé

Paramètre	Obligatoire	Type	Description
<collection>	Oui	Chaîne, tableau ou dictionnaire	Collection à vérifier
<value>	Oui	Respectivement chaîne, tableau ou dictionnaire	Élément à rechercher

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si l’élément est trouvé. Retourne false s’il n’est pas trouvé.

Exemple 1 :

Dans cet exemple, la sous-chaîne world est recherchée dans la chaîne hello world :

contains('hello world', 'world')

Le résultat retourné est true.

Exemple 2

Dans cet exemple, la sous-chaîne universe est recherchée dans la chaîne hello world :

contains('hello world', 'universe')

Le résultat retourné est false.

count

Retourne le nombre d’éléments d’une collection.

count('<collection>')
count([<collection>])

Paramètre	Obligatoire	Type	Description
<collection>	Oui	chaîne ou tableau	Collection contenant les éléments à comptabiliser

Valeur retournée	Type	Description
<length-or-count>	entier	Nombre d’éléments de la collection

Exemples :

Ces exemples illustrent le comptage du nombre d’éléments contenus dans ces collections :

count('abcd')
count(createArray(0, 1, 2, 3))

Le résultat retourné est 4 dans les deux cas.

countWord

Retourne le nombre de mots d’une chaîne.

countWord('<text>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne sur laquelle porte le comptage

Valeur retournée	Type	Description
<count>	entier	Nombre de mots de la chaîne

Exemple

Dans cet exemple, le nombre de mots de la chaîne Hello World est compté :

countWord("hello word")

Le résultat retourné est 2.

convertFromUTC

Convertit un horodatage dans une mise en forme locale facultative du Temps Universel Coordonné (UTC) vers un fuseau horaire cible.

convertFromUTC('<timestamp>', '<destinationTimeZone>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<destinationTimeZone>	Oui	string	Nom du fuseau horaire source. Les fuseaux horaires Windows et IANA sont pris en charge.
<format>	Non	string	Modèle de format personnalisé. Le format par défaut de l’horodateur est le format « o », aaaa-MM-jjTHH:mm:ss.fffffffK, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<converted-timestamp>	string	Horodatage converti au fuseau horaire cible

Exemples :

Dans ces exemples, l’heure UTC est convertie en heure normale du Pacifique :

convertFromUTC('2018-02-02T02:00:00.000Z', 'Pacific Standard Time', 'MM-DD-YY')
convertFromUTC('2018-02-02T02:00:00.000Z', 'Pacific Standard Time')

Les résultats retournés sont respectivement :

• 02-01-18
• 2018-01-01T18:00:00.0000000

Exemple 2

Cet exemple convertit un horodateur au format en-US de UTC en heure standard du Pacifique :

convertFromUTC('2018-01-02T02:00:00.000Z', 'Pacific Standard Time', 'D', 'en-US')

Le résultat retourné est lundi 1er janvier 2018.

convertToUTC

Convertit un horodateur dans un format local facultatif en temps universel coordonné (UTC) à partir du fuseau horaire source.

convertToUTC('<timestamp>', '<sourceTimeZone>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<sourceTimeZone>	Oui	string	Nom du fuseau horaire source. Les fuseaux horaires Windows et IANA sont pris en charge.
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<converted-timestamp>	string	Horodatage converti au fuseau horaire cible

Exemple

Cet exemple convertit un horodateur au format UTC à partir de l’heure standard du Pacifique

convertToUTC('01/01/2018 00:00:00', 'Pacific Standard Time')

Le résultat retourné est 2018-01-01T08:00:00.000Z.

Exemple 2

Cet exemple convertit un horodateur au format de-DE en UTC à partir de l’heure standard du Pacifique :

convertToUTC('01/01/2018 00:00:00', 'Pacific Standard Time', '', 'de-DE')

Le résultat retourné est 01.01.18 08:00:00.

createArray

Retourne un tableau à partir de plusieurs entrées.

createArray('<object1>', '<object2>', ...)

Paramètre	Obligatoire	Type	Description
<object1>, <object2>, ...	Oui	N’importe lequel (non mixte)	Au moins deux éléments pour créer le tableau

Valeur retournée	Type	Description
[<object1>, <object2>, ...]	tableau	Tableau créé à partir de tous les éléments d’entrée

Exemple

Dans cet exemple, un tableau est créé à partir des entrées suivantes :

createArray('h', 'e', 'l', 'l', 'o')

Le résultat retourné est [h ,e, l, l, o].

dataUri

Retourne un URI (Uniform Resource Identifier) de données d’une chaîne.

dataUri('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne à convertir

Valeur retournée	Type	Description
[<date-uri>]	string	URI de données de la chaîne d’entrée

Exemple

dataUri('hello')

Le résultat retourné est data:text/plain;charset=utf-8;base64,aGVsbG8=.

dataUriToBinary

Retourne la version binaire d’un URI (Uniform Resource Identifier) de données.

dataUriToBinary('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	URI de données à convertir

Valeur retournée	Type	Description
[<binary-for-data-uri>]	tableau d’octets	Version binaire de l’URI de données

Exemple

Dans cet exemple, une version binaire est créée pour l’URI de données suivant :

dataUriToBinary('aGVsbG8=')

Le résultat retourné est new byte[] { 97, 71, 86, 115, 98, 71, 56, 61 }.

dataUriToString

Retourne la version de type chaîne d’un URI (Uniform Resource Identifier) de données.

dataUriToString('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	URI de données à convertir

Valeur retournée	Type	Description
[<string-for-data-uri>]	string	Version de type chaîne de l’URI de données

Exemple

Dans cet exemple, une chaîne est créée à partir de l’URI de données suivant :

dataUriToString('data:text/plain;charset=utf-8;base64,aGVsbG8=')

Le résultat retourné est hello.

date

Retourne la date d’un timestamp spécifié au format m/jj/aaaa.

date('<timestramp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage

Valeur retournée	Type	Description
<d>ate	string	Date du timestamp spécifié

date('2018-03-15T13:00:00.000Z')

Le résultat retourné est 3-15-2018.

dateReadBack

Utilise la bibliothèque date-heure pour fournir une relecture de date.

dateReadBack('<currentDate>', '<targetDate>')

Paramètre	Obligatoire	Type	Description
<currentDate>	Oui	string	Chaîne contenant la date actuelle
<targetDate>	Oui	string	Chaîne contenant la date cible

Valeur retournée	Type	Description
<date-readback>	string	Relecture entre la date actuelle et la date cible

Exemple 1 :

dateReadBack('2018-03-15T13:00:00.000Z', '2018-03-16T13:00:00.000Z')

Le résultat retourné est tomorrow.

dateTimeDiff

Retourne la différence de cycles entre deux horodateurs.

dateTimeDiff('<timestamp1>', '<timestamp2>')

Paramètre	Obligatoire	Type	Description
<horodateur 1>	Oui	string	Première chaîne d’horodateur à comparer
<horodateur 2>	Oui	string	Seconde chaîne d’horodateur à comparer

Valeur retournée	Type	Description
<ticks>	nombre	Différence en termes de cycles entre deux horodateurs

Exemple 1 :

Cet exemple retourne la différence en termes de cycles entre deux horodateurs :

dateTimeDiff('2019-01-01T08:00:00.000Z','2018-01-01T08:00:00.000Z')

Retourne le nombre 315360000000000.

Exemple 2

Cet exemple retourne la différence en termes de cycles entre deux horodateurs :

dateTimeDiff('2018-01-01T08:00:00.000Z', '2019-01-01T08:00:00.000Z')

Retourne le résultat -315360000000000. La valeur est un nombre négatif.

dayOfMonth

Retourne le jour du mois d’un horodatage.

dayOfMonth('<timestamp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage

Valeur retournée	Type	Description
<day-of-month>	entier	Jour du mois de l’horodatage spécifié

Exemple

Dans cet exemple, le numéro du jour du mois est retourné à partir du timestamp suivant :

dayOfMonth('2018-03-15T13:27:36Z')

Le résultat retourné est 15.

dayOfWeek

Retourne le jour de la semaine à partir d’un horodatage.

dayOfWeek('<timestamp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage

Valeur retournée	Type	Description
<day-of-week>	entier	Jour de la semaine à partir du timestamp spécifié. Le dimanche correspond à la valeur 0, le lundi à la valeur 1 et ainsi de suite.

Exemple

Dans cet exemple, le numéro du jour de la semaine est retourné à partir du timestamp suivant :

dayOfWeek('2018-03-15T13:27:36Z')

Le résultat retourné est 3.

dayOfYear

Retourne le jour de l’année à partir d’un horodatage.

dayOfYear('<timestamp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage

Valeur retournée	Type	Description
<day-of-year>	entier	Jour de l’année à partir de l’horodatage spécifié

Exemple

Dans cet exemple, le numéro du jour de l’année est retourné à partir du timestamp suivant :

dayOfYear('2018-03-15T13:27:36Z')

Le résultat retourné est 74.

div

Retourne l’entier résultant de la division de deux nombres. Pour retourner le reste, consultez mod().

div(<dividend>, <divisor>)

Paramètre	Obligatoire	Type	Description
<dividend>	Oui	nombre	Nombre à diviser par le diviseur
<divisor>	Oui	nombre	Nombre qui divise dividend. Ne peut pas être 0.

Valeur retournée	Type	Description
<quotient-result>	nombre	Résultat de la division du premier nombre par le second

Exemple

Les deux exemples illustrent la division du premier nombre par le second :

div(10, 5)
div(11, 5)

Le résultat retourné est 2.

Il existe un certain écart entre JavaScript et le Kit de développement logiciel (SDK) .NET. Par exemple, l’expression suivante retourne différents résultats dans le Kit de développement logiciel (SDK) JavaScript et .NET :

Si l’un des paramètres est un float, le résultat sera également un FLOAT avec le kit de développement logiciel (SDK) .NET.

Exemple

div(11.2, 2)

Le résultat retourné est 5.6.

Si l’un des paramètres est un float, le résultat sera un INT avec le kit de développement logiciel (SDK) JavaScript.

Exemple

div(11.2, 2)

Le résultat retourné est 5.

La solution de contournement pour JavaScript afin de conserver un certain nombre de décimales dans les résultats consiste à utiliser cette expression. Par exemple, pour conserver 3 décimales :

float(concat(string(div(a, b)),'.',string(mod(div(a*1000, b), 1000))))

empty

Vérifie si une instance est vide. Retourne true si l’entrée est vide. « Vide » signifie :

• l’entrée est null ou n’est pas définie
• l’entrée est null ou est une chaîne vide
• l’entrée est une collection de taille « zéro »
• l’entrée est un objet sans propriété.

empty('<instance>')
empty([<instance>])

Paramètre	Obligatoire	Type	Description
<instance>	Oui	n'importe laquelle	Instance à vérifier

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true quand l’instance est vide.

Exemple

Ces exemples vérifient si l’instance spécifiée est vide :

empty('')
empty('abc')
empty([1])
empty(null)

Les résultats retournés sont respectivement :

• comme une chaîne vide est passée, la fonction retourne true.
• Comme la chaîne abc est passée, la fonction retourne false.
• Passe la collection avec un seul élément, de sorte que la fonction retourne false.
• Passe l’objet null, de sorte que la fonction retourne true.

endsWith

Vérifie si une chaîne se termine par une sous-chaîne spécifique. Retourne true si la sous-chaîne est trouvée, false sinon. Cette fonction ne respecte pas la casse.

endsWith('<text>', '<searchText>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne à vérifier
<searchText>	Oui	string	Sous-chaîne de fin à rechercher

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si la sous-chaîne de fin est trouvée. Retourne false si elle n’est pas trouvée.

Exemple 1 :

Dans cet exemple, la chaîne hello world est examinée pour savoir si elle se termine par la chaîne world :

endsWith('hello world', 'world')

Le résultat retourné est true.

Exemple 2

Dans cet exemple, la chaîne hello world est examinée pour savoir si elle se termine par la chaîne universe :

endsWith('hello world', 'universe')

Le résultat retourné est false.

EOL

Retourne le texte de séquence de fin de ligne (EOL).

EOL()

Valeur retournée	Type	Description
<IsOSPlatform>	string	Retourne \r\n dans Windows et \n dans Mac et Linux.

Exemple

Cet exemple vérifie la fin du texte de séquence de lignes :

EOL()

Les chaînes retournées sont les suivantes :

• Windows : \r\n
• Mac ou Linux : \n

equals

Vérifie si les deux valeurs, expressions ou objets sont équivalents. Retourne true si les deux sont équivalents, false sinon.

equals('<object1>', '<object2>')

Paramètre	Obligatoire	Type	Description
<object1>, <object2>	Oui	n'importe laquelle	Valeurs, expressions ou objets à comparer

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si les deux sont équivalents. Retourne false s’ils ne sont pas équivalents.

Exemple

Dans ces exemples, les entrées spécifiées sont examinées pour savoir si elles sont équivalentes :

equals(true, 1)
equals('abc', 'abcd')

Les résultats retournés sont respectivement :

• comme les deux valeurs sont équivalentes, la fonction retourne true.
• comme les deux valeurs ne sont pas équivalentes, la fonction retourne false.

exists

Évalue la vérité d’une expression.

exists(expression)

Paramètre	Obligatoire	Type	Description
expression	Oui	expression	Expression dont la vérité est évaluée

Valeur retournée	Type	Description
<true ou false>	Boolean	Résultat de l’évaluation de l'expression

Exemple

Dans ces exemples, la vérité de foo = {"bar":"value"} est évaluée :

exists(foo.bar)
exists(foo.bar2)

Les résultats retournés sont respectivement :

• true
• false

exp

Retourne l’élévation d’un nombre à la puissance d’un autre.

exp(realNumber, exponentNumber)

Paramètre	Obligatoire	Type	Description
realNumber	Oui	nombre	Nombre réel pour calculer l’exposant de
exponentNumber	Oui	nombre	Nombre d’exposant

Valeur retournée	Type	Description
<result-exp>	nombre	Résultat du calcul de l’exposant de realNumber

Exemple

Dans cet exemple, l’exposant est calculé :

exp(2, 2)

Le résultat retourné est 4.

first

Retourne le premier élément d’une chaîne ou d’un tableau.

first('<collection>')
first([<collection>])

Paramètre	Obligatoire	Type	Description
<collection>	Oui	chaîne ou tableau	Collection dans laquelle est recherché le premier élément

Valeur retournée	Type	Description
<first-collection-item>	n'importe laquelle	Premier élément de la collection

Exemple

Dans ces exemples, le premier élément est recherché dans les collections suivantes :

first('hello')
first(createArray(0, 1, 2))

Les résultats retournés sont respectivement :

• h
• 0

aplatir

Aplatit un tableau en valeurs qui ne sont pas des tableaux. Vous pouvez éventuellement définir la profondeur maximale à aplatir.

flatten([<collection>], '<depth>')

Paramètre	Obligatoire	Type	Description
<collection>	Oui	tableau	Collection à aplatir
<depth>	Non	nombre	Profondeur maximale à aplatir. La valeur par défaut est l’infini.

Valeur retournée	Type	Description
<new-collection>	tableau	Nouvelle collection dont les éléments ont été aplatis en un élément qui n’est pas un tableau à la profondeur spécifiée

Exemple 1 :

Dans cet exemple, le tableau suivant est aplati :

flatten(createArray(1, createArray(2), createArray(createArray(3, 4), createArray(5, 6)))

Le résultat retourné est [1, 2, 3, 4, 5, 6].

Exemple 2

Dans cet exemple, le tableau est aplati à une profondeur de 1 :

flatten(createArray(1, createArray(2), createArray(createArray(3, 4), createArray(5, 6)), 1)

Le résultat retourné est [1, 2, [3, 4], [5, 6]].

virgule flottante

Convertit la version de type chaîne d’un nombre à virgule flottante en nombre à virgule flottante. Vous pouvez utiliser cette fonction uniquement lors de la transmission de paramètres personnalisés à une application, telle qu’une application logique. Si la chaîne ne peut pas être convertie en float, une exception sera levée.

float('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne contenant un nombre valide à virgule flottante à convertir

Valeur retournée	Type	Description
<float-value>	virgule flottante	Nombre à virgule flottante de la chaîne spécifiée

Exemple

Cet exemple convertit la version float d’une chaîne :

float('10.333')

Retourne le float 10.333.

floor

Retourne le plus grand nombre entier qui est inférieur ou égal au nombre spécifié.

floor('<number>')

Paramètre	Obligatoire	Type	Description
<number>	Oui	nombre	Un nombre d’entrée

Valeur retournée	Type	Description
<Integer-value>	entier	L’entier le plus grand inférieur ou égal au nombre d’entrée

Exemple

Cet exemple calcule la valeur de plancher du nombre 10,333 :

floor(10.333)

Et retourne l’entier 10.

foreach

S’applique à chaque élément et retourne la nouvelle collection.

foreach([<collection/instance>], <iteratorName>, <function>)

Paramètre	Obligatoire	Type	Description
<collection/instance>	Oui	objet ou tableau	Collection contenant les éléments
<iteratorName>	Oui	Nom de l’itérateur	Élément clé de la fonction fléchée
<function>	Oui	expression	Fonction contenant iteratorName

Valeur retournée	Type	Description
<new-collection>	tableau	Nouvelle collection dans laquelle chaque élément a été évalué par la fonction

Exemple 1 :

Dans cet exemple, une nouvelle collection est générée :

foreach(createArray(0, 1, 2, 3), x, x + 1)

Le résultat retourné est [1, 2, 3, 4].

Exemple 2

Dans ces exemples, une nouvelle collection est générée :

foreach(json("{'name': 'jack', 'age': '15'}"), x, concat(x.key, ':', x.value))
foreach(json("{'name': 'jack', 'age': '15'}"), x=> concat(x.key, ':', x.value))

Le résultat retourné est [’name:jack’, ’age:15’]. La deuxième expression est une expression lambda, que certains trouvent plus lisible.

formatDateTime

Retourne un horodateur dans une mise en forme locale facultative.

formatDateTime('<timestamp>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<reformatted-timestamp>	string	Horodatage mis à jour au format spécifié

Exemple 1 :

Cet exemple illustre la conversion d’un horodatage au format spécifié :

formatDateTime('03/15/2018 12:00:00', 'yyyy-MM-ddTHH:mm:ss')

Le résultat retourné est 2018-03-15T12:00:00.

Exemple 2

Cet exemple convertit un horodateur au format de-DE :

formatDateTime('2018-03-15', '', 'de-DE')

Le résultat retourné est 15.03.18 00:00:00.

formatEpoch

Retourne un horodateur dans une mise en forme locale facultative dans le format spécifié à partir de l’heure UNIX (également appelée heure Epoch, heure POSIX, heure Epoch UNIX).

formatEpoch('<epoch>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<epoch>	Oui	nombre	Nombre correspondant à l’heure Epoch
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<reformatted-timestamp>	string	Horodatage mis à jour au format spécifié

Exemple

Cet exemple illustre la conversion d’un horodatage Unix au format spécifié :

formatEpoch(1521118800, 'yyyy-MM-ddTHH:mm:ss.fffZ)'

Et retourne le résultat 2018-03-15T12:00:00.000Z.

Exemple

Cet exemple convertit un horodateur Unix au format de-DE :

formatEpoch(1521118800, '', 'de-DE')

Le résultat retourné est 15.03.18 13:00:00.

formatNumber

Met en forme une valeur en fonction du nombre de chiffres de fraction spécifié et d’un paramètre local facultatif spécifié.

formatNumber('<number>', '<precision-digits>', '<locale>'?)

Paramètre	Obligatoire	Type	Description
<number>	Oui	nombre	Un nombre d’entrée
<chiffres de précision>	Oui	entier	Nombre spécifié de chiffres fractionnels
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<return-value>	nombre	Valeur renvoyée de l’entrée mise en forme à un nombre spécifié de chiffres fractionnaires et de paramètres régionaux spécifiés

Exemple 1 :

Cet exemple montre comment mettre en forme le nombre 10.333 à 2 chiffres fractionnaires :

formatNumber(10.333, 2)

Le résultat retourné est la chaîne 10.33.

Exemple 2

Ces exemples mettent en forme des nombres selon le nombre de chiffres spécifiés dans les paramètres régionaux correspondant à en-US :

formatNumber(12.123, 2, 'en-US')
formatNumber(1.551, 2, 'en-US')
formatNumber(12.123, 4, 'en-US')

Les résultats retournés sont respectivement :

• 12.12
• 1.55
• 12.1230

formatTicks

Retourne un horodateur dans une mise en forme locale facultative dans le format spécifié sous une forme cyclique.

formatTicks('<ticks>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<epoch>	Oui	nombre (ou bigint en JavaScript)	Nombre de cycles
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<reformatted-timestamp>	string	Horodatage mis à jour au format spécifié

Exemple 1 :

Cet exemple convertit les cycles au format spécifié :

formatTicks(637243624200000000, 'yyyy-MM-ddTHH:mm:ss.fffZ')

Et retourne le résultat 2020-05-06T11:47:00.000Z.

Exemple 2

Cet exemple convertit les cycles au format spécifié au format de-DE :

formatTicks(637243624200000000, '', 'de-DE')

Le résultat retourné est 06.05.20 11:47:00.

getFutureTime

Retourne l’horodateur actuel dans une mise en forme locale facultative, plus les unités de temps spécifiées.

getFutureTime(<interval>, <timeUnit>, '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<interval>	Oui	entier	Nombre d’unités de temps spécifiées à ajouter
<timeUnit>	Oui	string	Unité de temps à utiliser avec interval. Unités possibles : « Second » (seconde), « Minute » (minute), « Hour » (heure), « Day » (jour), « Week » (semaine), « Month » (mois) et « Year » (année).
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage actuel plus nombre d’unités de temps spécifié

Exemple 1 :

Supposons que le timestamp actuel soit 2019-03-01T00:00:00.000Z. Dans cet exemple, cinq jours sont ajoutés à ce timestamp :

getFutureTime(2, 'Week')

Le résultat retourné est 2019-03-15T00:00:00.000Z.

Exemple 2

Supposons que le timestamp actuel soit 2018-03-01T00:00:00.000Z. Dans cet exemple, cinq jours sont ajoutés à ce timestamp et le résultat est converti au format MM-JJ-AA :

getFutureTime(5, 'Day', 'MM-DD-YY')

Le résultat retourné est 03-06-18.

Exemple 3

Supposons que l’horodateur actuel soit 2020-05-01T00:00:00.000Z et que le format soit de-DE. Dans cet exemple, 1 jours sont ajoutés à cet horodateur :

getFutureTime(1,'Day', '', 'de-DE')

Le résultat retourné est 02.05.20 00:00:00.

getNextViableDate

Retourne la date viable suivante d’une expression Timex en fonction de la date actuelle et d’un fuseau horaire spécifié éventuellement.

getNextViableDate(<timexString>, <timezone>?)

Paramètre	Obligatoire	Type	Description
<timexString>	Oui	string	Chaîne Timex de la date à évaluer.
<timezone>	Non	string	Fuseau horaire facultatif.

Valeur retournée	Type	Description
<nextViableTime>	string	La prochaine date viable.

Exemples

Supposons que la date est 2020-06-12 et que l’heure actuelle est 15:42:21.

Ces exemples évaluent la chaîne Timex pour la date viable suivante en fonction de la date et de l’heure ci-dessus :

getPreviousViableDate("XXXX-12-20", "America/Los_Angeles")
getPreviousViableDate("XXXX-02-29")

Et retourne les chaînes suivantes respectivement :

• 2020-12-20
• 2024-02-29

getNextViableTime

Retourne l’heure viable suivante d’une expression Timex en fonction de l’heure actuelle et d’un fuseau horaire spécifié éventuellement.

getNextViableTime(<timexString>, <timezone>?)

Paramètre	Obligatoire	Type	Description
<timexString>	Oui	string	Chaîne Timex de l’heure à évaluer.
<timezone>	Non	string	Fuseau horaire facultatif.

Valeur retournée	Type	Description
<nextViableTime>	string	La prochaine heure viable.

Exemples

Supposons que la date est 2020-06-12 et que l’heure actuelle est 15:42:21.

Ces exemples évaluent une chaîne Timex pour la prochaine heure viable en fonction de la date et de l’heure ci-dessus :

getNextViableTime("TXX:12:14", "Asia/Tokyo")
getNextViableTime("TXX:52:14")

Et retourne les chaînes suivantes respectivement :

• T16:12:14
• T15:52:14

getPastTime

Retourne l’horodatage actuel moins les unités de temps spécifiées.

getPastTime(<interval>, <timeUnit>, '<format>'?)

Paramètre	Obligatoire	Type	Description
<interval>	Oui	entier	Nombre d’unités de temps spécifiées à soustraire
<timeUnit>	Oui	string	Unité de temps à utiliser avec interval. Unités possibles : « Second » (seconde), « Minute » (minute), « Hour » (heure), « Day » (jour), « Week » (semaine), « Month » (mois) et « Year » (année).
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage actuel moins nombre d’unités de temps spécifié

Exemple 1 :

Supposons que le timestamp actuel soit 2018-02-01T00:00:00.000Z. Cet exemple illustre le retrait de cinq jours de cet horodatage :

getPastTime(5, 'Day')

Le résultat retourné est 2019-01-27T00:00:00.000Z.

Exemple 2

Supposons que le timestamp actuel soit 2018-03-01T00:00:00.000Z. Cet exemple soustrait cinq jours à l’horodateur au format MM-JJ-AA :

getPastTime(5, 'Day', 'MM-DD-YY')

Le résultat retourné est 02-26-18.

Exemple 3

Supposons que l’horodateur actuel soit 2020-05-01T00:00:00.000Z et que le format soit de-DE. L’exemple ci-dessous soustrait 1 jour de l’horodateur :

getPastTime(1,'Day', '', 'de-DE')

Le résultat retourné est 31.04.20 00:00:00.

getPreviousViableDate

Retourne la date viable précédente d’une expression Timex en fonction de la date actuelle et d’un fuseau horaire spécifié éventuellement.

getPreviousViableDate(<timexString>, <timezone>?)

Paramètre	Obligatoire	Type	Description
<timexString>	Oui	string	Chaîne Timex de la date à évaluer.
<timezone>	Non	string	Fuseau horaire facultatif.

Valeur retournée	Type	Description
<previousViableDate>	string	Date viable précédente.

Exemples

Supposons que la date est 2020-06-12 et que l’heure actuelle est 15:42:21.

Ces exemples évaluent une chaîne Timex pour la précédente date viable en fonction de la date et de l’heure ci-dessus :

getPreviousViableDate("XXXX-12-20", "Eastern Standard Time")
getPreviousViableDate("XXXX-02-29")

Et retourne les chaînes suivantes respectivement :

• 2019-12-20
• 2020-02-29

getPreviousViableTime

Retourne l’heure viable précédente d’une expression Timex en fonction de la date actuelle et d’un fuseau horaire spécifié éventuellement.

getPreviousViableTime(<timexString>, <timezone>?)

Paramètre	Obligatoire	Type	Description
<timexString>	Oui	string	Chaîne Timex de l’heure à évaluer.
<timezone>	Non	string	Fuseau horaire facultatif.

Valeur retournée	Type	Description
<previousViableTime>	string	Heure viable précédente.

Exemples

Supposons que la date est 2020-06-12 et que l’heure actuelle est 15:42:21.

Ces exemples évaluent une chaîne Timex pour la précédente heure viable en fonction de la date et de l’heure ci-dessus :

getPreviousViableTime("TXX:52:14")
getPreviousViableTime("TXX:12:14", 'Europe/London')

Et retourne les chaînes suivantes respectivement :

• T14:52:14
• T15:12:14

getProperty

Retourne la valeur d’une propriété ou d’une propriété racine spécifiée à partir d’un objet JSON.

Retourne la valeur d’une propriété spécifiée

getProperty(<JSONObject>, '<propertyName>')

Paramètre	Obligatoire	Type	Description
<JSONObject>	Oui	object	L’objet JSON contenant la propriété et les valeurs.
<propertyName>	Non	string	Nom de la propriété facultative à partir duquel accéder aux valeurs.

Valeur retournée	Type	Description
valeur	string	Valeur de la propriété spécifiée pour l’objet JSON.

Exemple

Prenons l’objet JSON suivant :

{
   "a:b" : "a:b value",
   "c":
   {
        "d": "d key"
    }
}

Ces exemples permettent d’extraire une propriété spécifiée de l’objet JSON ci-dessus :

getProperty({"a:b": "value"}, 'a:b')
getProperty(c, 'd')

Et retourne les chaînes suivantes respectivement :

• Valeur a:b
• clé d

Retourner la propriété racine

getProperty('<propertyName>')

Paramètre	Obligatoire	Type	Description
<propertyName>	Oui	string	Nom de la propriété facultative à partir duquel accéder aux valeurs de l’étendue de la mémoire racine.

Valeur retournée	Type	Description
valeur	string	Valeur de la propriété racine d’un objet JSON.

Exemple

Prenons l’objet JSON suivant :

{
   "a:b" : "a:b value",
   "c":
   {
        "d": "d key"
    }
}

Cet exemple permet de récupérer la propriété racine de l’objet JSON ci-dessus :

getProperty("a:b")

Et retourne la valeur a:b de la chaîne.

getTimeOfDay

Retourne l’heure de la journée du timestamp donné.

getTimeOfDay('<timestamp>')

L’heure retournée est l’une des chaînes suivantes :

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne contenant le timestamp spécifié

Valeur retournée	Type	Description
<time-of-day>	string	Heure de la journée du timestamp spécifié

Voici la liste des chaînes associées à l’heure de la journée :

Heure de la journée	Timestamp
midnight	00:00
matin	00:01 – 23:59
afternoon	12:00
evening	18:00 – 22:00
nuit	22:01 – 23:59

Exemple

getTimeOfDay('2018-03-15T08:00:00.000Z')

Le résultat retourné est morning.

greater

Vérifie si la première valeur est supérieure à la seconde. Retourne true si la première valeur est supérieure, false si elle est inférieure.

greater(<value>, <compareTo>)
greater('<value>', '<compareTo>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	Entier, flottant ou chaîne	Première valeur à vérifier pour déterminer si elle est supérieure à la seconde
<compareTo>	Oui	Respectivement entier, flottant ou chaîne	Valeur de comparaison

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si la première valeur est supérieure à la seconde. Retourne false si la première valeur est inférieure ou égale à la seconde.

Exemple

Ces exemples vérifient si la première valeur est supérieure à la seconde :

greater(10, 5)
greater('apple', 'banana')

Les résultats retournés sont respectivement :

• true
• false

greaterOrEquals

Vérifie si la première valeur est supérieure ou égale à la seconde. Retourne true si la première valeur est supérieure ou égale, false si elle est inférieure.

greaterOrEquals(<value>, <compareTo>)
greaterOrEquals('<value>', '<compareTo>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	Entier, flottant ou chaîne	Première valeur à vérifier pour déterminer si elle est supérieure ou égale à la seconde
<compareTo>	Oui	Respectivement entier, flottant ou chaîne	Valeur de comparaison

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si la première valeur est supérieure ou égale à la seconde. Retourne false si la première valeur est inférieure à la seconde.

Exemple

Ces exemples vérifient si la première valeur est supérieure ou égale à la seconde :

greaterOrEquals(5, 5)
greaterOrEquals('apple', 'banana')

Les résultats retournés sont respectivement :

• true
• false

if

Vérifie si une expression est vraie ou fausse. En fonction du résultat, retourne une valeur spécifiée.

if(<expression>, <valueIfTrue>, <valueIfFalse>)

Paramètre	Obligatoire	Type	Description
<expression>	Oui	Boolean	Expression à vérifier
<valueIfTrue>	Oui	n'importe laquelle	Valeur à retourner si l’expression est vraie
<valueIfFalse>	Oui	n'importe laquelle	Valeur à retourner si l’expression est fausse

Valeur retournée	Type	Description
<specified-return-value>	n'importe laquelle	Valeur spécifiée retournée selon que l’expression est true ou false

Exemple

Dans cet exemple, la vérité de equals(1,1) est évaluée :

if(equals(1, 1), 'yes', 'no')

Le résultat est yes, car l’expression spécifiée retourne true. Sinon, l’exemple retourne no.

indexOf

Retourne la position ou la valeur d’index de départ d’une sous-chaîne. Cette fonction ne respecte pas la casse, et les index commencent par le chiffre 0.

indexOf('<text>', '<searchText>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	chaîne ou tableau	Chaîne comportant la sous-chaîne à rechercher
<searchText>	Oui	string	Sous-chaîne à rechercher

Valeur retournée	Type	Description
<index-value>	entier	Position ou valeur d’index de départ de la sous-chaîne spécifiée.
Si la chaîne est introuvable, retourne le chiffre -1.

Exemple 1 :

Dans cet exemple, la valeur d’index de départ de la sous-chaîne world est recherchée dans la chaîne hello world :

indexOf('hello world', 'world')

Le résultat retourné est 6.

Exemple 2

Dans cet exemple, la valeur d’index de départ de la sous-chaîne def est recherchée dans le tableau ['abc', 'def', 'ghi'] :

indexOf(createArray('abc', 'def', 'ghi'), 'def')

Le résultat retourné est 1.

indicesAndValues

Transforme un tableau ou un objet en tableau d’objets avec la propriété d’index (actuel) et de valeur. Pour les tableaux, l’index correspond à la position dans le tableau. Pour les objets, il s’agit de la clé de la valeur.

indicesAndValues('<collection or object>')

Paramètre	Obligatoire	Type	Description
<collection or object>	Oui	objet ou tableau	Tableau ou objet d’origine

Valeur retournée	Type	Description
<collection>	tableau	Nouveau tableau. Chaque élément possède deux propriétés : l’index avec la position dans un tableau ou la clé d’un objet ainsi que la valeur correspondante.

Exemple 1 :

Prenons la liste { items: ["zero", "one", "two"] }. La fonction suivante prend cette liste :

indicesAndValues(items)

Et en retourne une nouvelle :

[
  {
    index: 0,
    value: 'zero'
  },
  {
    index: 1,
    value: 'one'
  },
  {
    index: 2,
    value: 'two'
  }
]

Exemple 2

Prenons la liste { items: ["zero", "one", "two"] }. La fonction suivante prend cette liste :

where(indicesAndValues(items), elt, elt.index >= 1)

Et en retourne une nouvelle :

[
  {
    index: 1,
    value: 'one'
  },
  {
    index: 2,
    value: 'two'
  }
]

Exemple 3

Prenons la liste { items: ["zero", "one", "two"] }. La fonction suivante prend cette liste :

join(foreach(indicesAndValues(items), item, item.value), ',')

Le résultat retourné est zero,one,two. Cette expression a le même effet que join(items, ',').

Exemple 4

Prenons l’objet { user: {name: ’jack’, age: 20} }. La fonction suivante prend cet objet :

indicesAndValues(user)

Elle retourne un nouvel objet :

[
  {
    index: 'name',
    value: 'jack'
  },
  {
    index: 'age',
    value: 20
  }
]

int

Retourne la version entière d’une chaîne. Si la chaîne ne peut pas être convertie en entier, une exception sera levée.

int('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne à convertir

Valeur retournée	Type	Description
<integer-result>	entier	Version entière de la chaîne spécifiée

Exemple

Dans cet exemple, une version entière de la chaîne 10 est créée :

int('10')

Le résultat retourné est l’entier 10.

intersection

Retourne une collection qui contient uniquement les éléments communs aux collections spécifiées. Pour qu’il apparaisse dans le résultat, un élément doit apparaître dans toutes les collections transmises à cette fonction. Si un ou plusieurs éléments portent le même nom, le dernier élément de ce nom apparaît dans le résultat.

intersection([<collection1>], [<collection2>], ...)
intersection('<collection1>', '<collection2>', ...)

Paramètre	Obligatoire	Type	Description
<collection1>, <collection2>	Oui	Tableau ou objet, mais pas les deux	Collections dont les éléments communs uniquement sont récupérés

Valeur retournée	Type	Description
<common-items>	Respectivement tableau ou objet	Collection qui contient uniquement les éléments communs aux collections spécifiées

Exemple

Dans cet exemple, les éléments communs aux tableaux suivants sont recherchés :

intersection(createArray(1, 2, 3), createArray(101, 2, 1, 10), createArray(6, 8, 1, 2))

Un tableau comportant uniquement les éléments [1, 2] est retourné.

isArray

Retourne true si une entrée donnée est un tableau.

isArray('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une entrée donnée est un tableau, sinon false.

Exemples

Dans ces exemples, l’entrée est examinée pour savoir s’il s’agit d’un tableau :

isArray('hello')
isArray(createArray('hello', 'world'))

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne false.
• Comme l’entrée est un tableau, la fonction retourne true.

isBoolean

Retourne true si une entrée donnée est un booléen.

isBoolean('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une entrée donnée est un booléen, false sinon.

Exemples

Dans ces exemples, l’entrée est examinée pour savoir s’il s’agit d’un booléen :

isBoolean('hello')
isBoolean(32 > 16)

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne false.
• Comme l’entrée est un booléen, la fonction retourne true.

isDate

Retourne true si une expression TimexProperty ou Timex donnée fait référence à une date valide. Les dates valides contiennent le mois et le jour du mois (dayOfMonth), ou bien le jour de la semaine (dayOfWeek).

isDate('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée fait référence à une date valide, false si la date n’est pas valide.

Exemples

Dans ces exemples, les entrées suivantes sont examinées pour savoir s’il s’agit de dates valides :

isDate('2020-12')
isDate('xxxx-12-21')

Les résultats retournés sont les suivants :

• false
• true

isDateRange

Retourne true si une expression TimexProperty ou Timex donnée fait référence à une plage de dates valide.

isDateRange('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée donnée fait référence à une plage de dates valide, sinon false.

Exemples

Dans ces exemples, l’entrée suivante est examinée pour savoir s’il s’agit d’une plage de dates valide :

isDateRange('PT30M')
isDateRange('2012-02')

Les résultats retournés sont les suivants :

• false
• true

isDateTime

Retourne true si une entrée donnée est une chaîne de timestamp au format ISO UTC (AAAA-MM-JJTHH:mm:ss.fffZ).

isDateTime('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une entrée donnée est une chaîne de horodateur au format ISO UTC, sinon false.

Exemples

Dans ces exemples, l’entrée est examinée pour savoir s’il s’agit d’une chaîne au format ISO UTC :

isDateTime('hello world!')
isDateTime('2019-03-01T00:00:00.000Z')

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne false.
• Comme l’entrée est une chaîne au format ISO UTC, la fonction retourne true.

isDefinite

Retourne true si une expression TimexProperty ou Timex donnée fait référence à une date valide. Les dates valides contiennent l’année, le mois et le jour du mois (dayOfMonth).

isDefinite('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée donnée fait référence à une date complète valide, sinon false.

Exemples

Prenons un objet TimexProperty validFullDate = new TimexProperty("2020-02-20"), avec la propriété Now définie sur true. Dans ces exemples, l’objet est examiné pour savoir s’il fait référence à une date complète valide :

isDefinite('xxxx-12-21')
isDefinite(validFullDate)

Les résultats retournés sont respectivement :

• false
• true

isDuration

Retourne true si une expression TimexProperty ou Timex donnée fait référence à une durée valide.

isDuration('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée fait référence à une durée valide, false sinon.

Exemples

Dans ces exemples, l’entrée suivante est examinée pour savoir si elle fait référence à une durée valide :

isDuration('PT30M')
isDuration('2012-02')

Les résultats retournés sont respectivement :

• true
• false

isFloat

Retourne true si une entrée donnée est un nombre à virgule flottante. En raison de l’alignement entre C# et JavaScript, un nombre dont le reste du modulo 1 est différent de zéro est traité comme un nombre à virgule flottante.

isFloat('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une entrée donnée est un nombre à virgule flottante, sinon false.

Exemples

Dans ces exemples, l’entrée est examinée pour savoir s’il s’agit d’un nombre à virgule flottante :

isFloat('hello world!')
isFloat(1.0)
isFloat(12.01)

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne false.
• Comme l’entrée a un modulo égal à 0, la fonction retourne false.
• Comme l’entrée est un nombre à virgule flottante, la fonction retourne true.

isInteger

Retourne true si une entrée donnée est un nombre entier. En raison de l’alignement entre C# et JavaScript, un nombre dont le reste du modulo 1 est égal à zéro est traité comme un nombre entier.

isInteger('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée est un nombre entier.

Exemples

Dans ces exemples, l’entrée est examinée pour savoir s’il s’agit d’un entier :

isInteger('hello world!')
isInteger(1.0)
isInteger(12)

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne false.
• Comme l’entrée a un modulo égal à 0, la fonction retourne true.
• Comme l’entrée est un entier, la fonction retourne true.

isMatch

Retourne true si une chaîne donnée correspond à un modèle d’expression régulière spécifié.

isMatch('<target**string>', '<pattern>')

Paramètre	Obligatoire	Type	Description
<target**string>	Oui	string	Chaîne de correspondance
<pattern>	Oui	string	Modèle d’expression régulière

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une chaîne donnée correspond à un modèle d’expression régulière courant, sinon false.

Exemples

Dans ces exemples, l'entrée est examinée pour savoir si elle correspond au modèle d'expression régulière spécifié :

isMatch('ab', '^[a-z]{1,2}$')
isMatch('FUTURE', '(?i)fortune|future')
isMatch('12abc34', '([0-9]+)([a-z]+)([0-9]+)')
isMatch('abacaxc', 'ab.*?c')

Le résultat retourné est true dans tous les cas.

isObject

Retourne true si une entrée donnée est un objet complexe, false s’il s’agit d’un objet primitif. Les objets primitifs sont notamment les chaînes, les nombres et les booléens. Les types complexes, comme les classes, contiennent des propriétés.

isObject('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une entrée donnée est un objet complexe, false s’il s’agit d’un objet primitif.

Exemples

Dans ces exemples, l’entrée donnée est examinée pour savoir s’il s’agit d’un objet :

isObject('hello world!')
isObject({userName: "Sam"})

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne false.
• Comme l’entrée est un objet, la fonction retourne true.

isPresent

Retourne true si une expression TimexProperty ou Timex donnée fait référence au moment présent.

isPresent('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée fait référence au moment présent, sinon false.

Exemples Prenons un objet TimexProperty validNow = new TimexProperty() { Now = true }, avec la propriété Now définie sur true. Dans ces exemples, l’entrée suivante est examinée pour savoir si elle fait référence au moment présent :

isPresent('PT30M')
isPresent(validNow)

Les résultats retournés sont respectivement :

• false
• true

isString

Retourne true si une entrée donnée est une chaîne.

isString('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	n'importe laquelle	Entrée à tester

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si une entrée donnée est une chaîne, false sinon.

Exemples

Dans ces exemples, l’entrée donnée est examinée pour savoir s’il s’agit d’une chaîne :

isString('hello world!')
isString(3.14)

Les résultats retournés sont respectivement :

• Comme l’entrée est une chaîne, la fonction retourne true.
• Comme l’entrée est un flottant, la fonction retourne false.

isTime

Retourne true si une expression TimexProperty ou Timex donnée fait référence à une heure valide. L’heure valide comporte des heures, des minutes et des secondes.

isTime('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée fait référence à une heure valide, false sinon.

Exemples

Dans ces exemples, l’entrée suivante est examinée pour savoir si elle fait référence à une heure valide :

isTime('PT30M')
isTime('2012-02-21T12:30:45')

Les résultats retournés sont respectivement :

• false
• true

isTimeRange

Retourne true si une expression TimexProperty ou Timex donnée fait référence à un intervalle de temps valide. Les intervalles de temps valides contiennent un moment de la journée (partOfDay).

isTime('<input>')

Paramètre	Obligatoire	Type	Description
<input>	Oui	Objet ou chaîne	Objet TimexProperty ou chaîne d’expression Timex d’entrée

Valeur retournée	Type	Description
<Boolean-result>	Boolean	Retourne true si l’entrée fait référence à un intervalle de temps valide, false sinon.

Exemples

Prenons un objet TimexProperty validTimeRange = new TimexProperty() { PartOfDay = "morning" }, avec la propriété Now définie sur true. Dans ces exemples, les entrées suivantes sont examinées pour savoir s’il s’agit d’intervalles de temps valides :

isTimeRange('PT30M')
isTimeRange(validTimeRange)

Les résultats retournés sont respectivement :

• false
• true

join

Retourne une chaîne contenant tous les éléments d’un tableau, dont les caractères sont séparés par un délimiteur.

join([<collection>], '<delimiter>')

Paramètre	Obligatoire	Type	Description
<collection>	Oui	tableau	Tableau qui comporte les éléments à joindre
<delimiter>	Oui	string	Séparateur affiché entre chaque caractère de la chaîne obtenue

Valeur retournée	Type	Description
<char1><delimiter><char2><delimiter>...	string	Chaîne obtenue créée à partir de tous les éléments du tableau spécifié

Exemple

Cet exemple illustre la création d’une chaîne à partir de tous les éléments de ce tableau avec le caractère spécifié . comme séparateur :

join(createArray('a', 'b', 'c'), '.')

Le résultat retourné est a.b.c.

jPath

Vérifie si les nœuds ou les valeurs d’un code ou d’une chaîne JSON correspondent à une expression de chemin, et retourne les nœuds correspondants.

jPath(<json>, '<path>')

Paramètre	Obligatoire	Type	Description
<json>	Oui	n'importe laquelle	Objet JSON ou chaîne dans lequel sont recherchés des nœuds ou des valeurs qui correspondent à la valeur de l’expression de chemin
<path>	Oui	n'importe laquelle	Expression de chemin d’accès utilisée pour rechercher des nœuds ou des valeurs JSON correspondants

Valeur retournée	Type	Description
[<json-node>]	tableau	Liste de nœuds JSON ou de valeurs qui correspond à l’expression de chemin spécifiée

Exemple C#

Prenons le JSON suivant :

{
    "Stores": [
        "Lambton Quay",
        "Willis Street"
    ],
    "Manufacturers": [
        {
            "Name": "Acme Co",
            "Products": [
                {
                    "Name": "Anvil",
                    "Price": 50
                }
            ]
        },
        {
            "Name": "Contoso",
            "Products": [
                {
                    "Name": "Elbow Grease",
                    "Price": 99.95
                },
                {
                    "Name": "Headlight Fluid",
                    "Price": 4
                }
            ]
        }
    ]
}

L’expression de chemin d’accès est $..Products[?(@.Price >= 50)].Name

jPath(jsonStr, path)

Le résultat retourné est ["Anvil", "Elbow Grease"].

Exemple JavaScript

Prenons le JSON suivant :

{
    "automobiles": [
        {
            "maker": "Nissan",
            "model": "Teana",
            "year": 2011
        },
        {
            "maker": "Honda",
            "model": "Jazz",
            "year": 2010
        },
        {
            "maker": "Honda",
            "model": "Civic",
            "year": 2007
        },
        {
            "maker": "Toyota",
            "model": "Yaris",
            "year": 2008
        },
        {
            "maker": "Honda",
            "model": "Accord",
            "year": 2011
        }
    ],
    "motorcycles": [
        {
            "maker": "Honda",
            "model": "ST1300",
            "year": 2012
        }
    ]
}

L’expression de chemin est .automobiles{.maker === « Honda » && .year > 2009}.model.

jPath(jsonStr, path)

Le résultat retourné est ['Jazz', 'Accord'].

json

Retourne la valeur ou l’objet de type JavaScript Object Notation (JSON) d’une chaîne ou d’un élément XML.

json('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	Chaîne ou élément XML	Chaîne ou élément XML à convertir

Valeur retournée	Type	Description
<JSON-result>	string	Objet JSON résultant créé à partir de la chaîne ou du code XML spécifié.

Exemple 1 :

Dans cet exemple, une chaîne est convertie au format JSON :

json('{"fullName": "Sophia Owen"}')

Le résultat retourné est :

{
  "fullName": "Sophia Owen"
}

Exemple 2

Dans cet exemple, un élément XML est converti au format JSON :

json(xml('<?xml version="1.0"?> <root> <person id='1'> <name>Sophia Owen</name> <occupation>Engineer</occupation> </person> </root>'))

Le résultat retourné est :

{
   "?xml": { "@version": "1.0" },
   "root": {
      "person": [ {
         "@id": "1",
         "name": "Sophia Owen",
         "occupation": "Engineer"
      } ]
   }
}

jsonStringify

Retourne la chaîne JSON d’une valeur.

Paramètre	Obligatoire	Type	Description
<value>	Oui	object	Objet à convertir en chaîne JSON

Valeur retournée	Type	Description
<JSON-result>	string	Chaîne JSON résultante.

Exemples

Ces exemples montrent les objets convertis en chaînes JSON :

jsonStringify(null)
jsonStringify({a:'b'})

Les résultats de chaîne retournés sont respectivement :

• null
• {"a":"b"}

last

Retourne le dernier élément d’une collection.

last('<collection>')
last([<collection>])

Paramètre	Obligatoire	Type	Description
<collection>	Oui	chaîne ou tableau	Collection dans laquelle est recherché le dernier élément

Valeur retournée	Type	Description
<last-collection-item>	Respectivement chaîne ou tableau	Dernier élément de la collection

Exemple

Ces exemples illustrent la recherche du dernier élément dans ces collections :

last('abcd')
last(createArray(0, 1, 2, 3))

Les résultats retournés sont respectivement :

• d
• 3

lastIndexOf

Retourne la position ou la valeur d’index de départ de la dernière occurrence d’une sous-chaîne. Cette fonction ne respecte pas la casse, et les index commencent par le chiffre 0.

lastIndexOf('<text>', '<searchText>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	chaîne ou tableau	Chaîne comportant la sous-chaîne à rechercher
<searchText>	Oui	string	Sous-chaîne à rechercher

Valeur retournée	Type	Description
<ending-index-value>	entier	Position ou valeur d’index de départ de la dernière occurrence de la sous-chaîne spécifiée. Si la chaîne est introuvable, retourne le chiffre -1.

Exemple 1 :

Dans cet exemple, la valeur d’index de départ de la dernière occurrence de la sous-chaîne world est recherchée dans la chaîne hello world :

lastIndexOf('hello world', 'world')

Le résultat retourné est 6.

Exemple 2

Dans cet exemple, la valeur d’index de départ de la dernière occurrence de la sous-chaîne def est recherchée dans le tableau ['abc', 'def', 'ghi', 'def'].

lastIndexOf(createArray('abc', 'def', 'ghi', 'def'), 'def')

Le résultat retourné est 3.

length

Retourne la longueur d'une chaîne.

length('<str>')

Paramètre	Obligatoire	Type	Description
<str>	Oui	string	Chaîne dont la longueur doit être calculée

Valeur retournée	Type	Description
<length>	entier	Longueur de cette chaîne

Exemples

Dans ces exemples, la longueur des chaînes est calculée :

length('hello')
length('hello world')

Les résultats retournés sont respectivement :

• 5
• 11

less

Vérifie si la première valeur est inférieure à la seconde. Retourne true si la première valeur est inférieure, false si elle est supérieure.

less(<value>, <compareTo>)
less('<value>', '<compareTo>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	Entier, flottant ou chaîne	Première valeur à vérifier pour déterminer si elle est inférieure à la seconde
<compareTo>	Oui	Respectivement entier, flottant ou chaîne	Élément de comparaison

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si la première valeur est inférieure à la seconde. Retourne false si la première valeur est supérieure ou égale à la seconde.

Exemples

Ces exemples vérifient si la première valeur est inférieure à la seconde.

less(5, 10)
less('banana', 'apple')

Les résultats retournés sont respectivement :

• true
• false

lessOrEquals

Vérifie si la première valeur est inférieure ou égale à la seconde. Retourne true si la première valeur est inférieure ou égale, false si elle est supérieure.

lessOrEquals(<value>, <compareTo>)
lessOrEquals('<value>', '<compareTo>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	Entier, flottant ou chaîne	Première valeur à vérifier pour déterminer si elle est inférieure ou égale à la seconde
<compareTo>	Oui	Respectivement entier, flottant ou chaîne	Élément de comparaison

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si la première valeur est inférieure ou égale à la seconde. Retourne false si la première valeur est supérieure à la seconde.

Exemple

Dans ces exemples, la première valeur est examinée pour savoir si elle est inférieure ou égale à la seconde.

lessOrEquals(10, 10)
lessOrEquals('apply', 'apple')

Les résultats retournés sont respectivement :

• true
• false

max

Retourne la valeur la plus élevée d’une liste ou d’un tableau. La liste ou le tableau est inclusif aux deux extrémités.

max(<number1>, <number2>, ...)
max([<number1>, <number2>, ...])

Paramètre	Obligatoire	Type	Description
<number1>, <number2>, ...	Oui	nombre	Ensemble de nombres dont vous voulez la valeur la plus élevée
[<number1>, <number2>, ...]	Oui	Tableau de nombres	Tableau de nombres dont vous voulez la valeur la plus élevée

Valeur retournée	Type	Description
<max-value>	nombre	Valeur la plus élevée dans le tableau ou l’ensemble de nombres spécifié

Exemples

Ces exemples illustrent l’obtention de la valeur la plus élevée de l’ensemble des nombres et du tableau :

max(1, 2, 3)
max(createArray(1, 2, 3))

Le résultat retourné est 3.

merge

Fusionne plusieurs objets JSON ou un tableau d’objets.

merge(<json1>, <json2>, ...)

Paramètre	Obligatoire	Type	Description
<json 1>, <json 2>, etc.	Oui	Objets ou tableau	Ensemble d’objets JSON ou de tableau à fusionner.

Valeur retournée	Type	Description
<result>	object	Objet JSON combiné ou objets de tableau combinés.

Exemples

Prenons les objets JSON suivants :

json1 = @"{
            'FirstName': 'John',
            'LastName': 'Smith',
            'Enabled': false,
            'Roles': [ 'User' ]
          }"
json2 =@"{
            'Enabled': true,
            'Roles': [ 'User', 'Admin' ]
          }"

Cet exemple fusionne les objets JSON :

string(merge(json(json1), json(json2)))

Et retourne l’objet {"FirstName":"John","LastName":"Smith","Enabled":true,"Roles":["User","Admin"]} résultant.

Supposons que vous souhaitez combiner des objets et une liste d’objets. L’exemple suivant combine un objet JSON et un tableau d’objets :

merge({k1:'v1'}, [{k2:'v2'}, {k3: 'v3'}], {k4:'v4'})

Et retourne l’objet { "k1": "v1", "k2": "v2", "k3": "v3", "k4": "v4" }.

min

Retourne la plus petite valeur d’un ensemble de nombres ou d’un tableau.

min(<number1>, <number2>, ...)
min([<number1>, <number2>, ...])

Paramètre	Obligatoire	Type	Description
<number1>, <number2>, ...	Oui	nombre	Ensemble de nombres dont vous voulez la valeur la plus petite
[<number1>, <number2>, ...]	Oui	Tableau de nombres	Tableau de nombres dont vous voulez la valeur la plus petite

Valeur retournée	Type	Description
<min-value>	nombre	Valeur la moins élevée dans le tableau ou l’ensemble de nombres spécifié

Exemples

Ces exemples illustrent l’obtention de la valeur la plus petite de l’ensemble des nombres et du tableau :

min(1, 2, 3)
min(createArray(1, 2, 3))

Le résultat retourné est 1.

mod

Retourne le reste de la division de deux nombres. Pour obtenir le résultat sous forme d’un entier, consultez div().

mod(<dividend>, <divisor>)

Paramètre	Obligatoire	Type	Description
<dividend>	Oui	nombre	Nombre à diviser par le diviseur
<divisor>	Oui	nombre	Nombre qui divise dividend. Ne peut pas être 0.

Valeur retournée	Type	Description
<modulo-result>	nombre	Reste de la division du premier nombre par le second nombre

Exemple

Cet exemple illustre la division du premier nombre par le second nombre :

mod(3, 2)

Le résultat retourné est 1.

mois

Retourne le mois du timestamp spécifié.

month('<timestamp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage

Valeur retournée	Type	Description
<number-of-month>	entier	Numéro du mois du timestamp spécifié

Exemple

month('2018-03-15T13:01:00.000Z')

Le résultat retourné est 3.

mul

Retourne le produit de la multiplication de deux nombres.

mul(<multiplicand1>, <multiplicand2>)

Paramètre	Obligatoire	Type	Description
<multiplicand1>	Oui	Entier ou flottant	Nombre à multiplier par multiplicand2
<multiplicand2>	Oui	Entier ou flottant	Nombre qui multiplie multiplicand1

Valeur retournée	Type	Description
<product-result>	Entier ou flottant	Produit de la multiplication du premier nombre par le second nombre

Exemples

Ces exemples illustrent la multiplication du premier nombre par le second nombre :

mul(1, 2)
mul(1.5, 2)

Les résultats retournés sont respectivement :

• 2
• 3

newGuid

Retourne une nouvelle chaîne GUID.

newGuid()

Valeur retournée	Type	Description
<Guid-string>	string	Nouvelle chaîne GUID, de longueur 36 et au format xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx

Exemple

newGuid()

Le résultat retourné suit le format xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx.

not

Vérifie si une expression est fausse. Retourne true si l’expression est fausse, false si elle est vraie.

not(<expression>)

Paramètre	Obligatoire	Type	Description
<expression>	Oui	Boolean	Expression à vérifier

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si l’expression est fausse. Retourne false si l’expression est vraie.

Exemple 1 :

Ces exemples vérifient si les expressions spécifiées sont fausses :

not(false)
not(true)

Les résultats retournés sont respectivement :

• comme l’expression est fausse, la fonction retourne true.
• comme l’expression est vraie, la fonction retourne false.

Exemple 2

Ces exemples vérifient si les expressions spécifiées sont fausses :

not(equals(1, 2))
not(equals(1, 1))

Les résultats retournés sont respectivement :

• comme l’expression est fausse, la fonction retourne true.
• comme l’expression est vraie, la fonction retourne false.

or

Vérifie si au moins une expression est vraie. Retourne true si au moins une expression est vraie, false si elles sont toutes fausses.

or(<expression1>, <expression2>, ...)

Paramètre	Obligatoire	Type	Description
<expression1>, <expression2>, …	Oui	Boolean	Expressions à vérifier

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si au moins une expression est vraie. Retourne false si toutes les expressions sont fausses.

Exemple 1 :

Ces exemples vérifient si au moins une expression est vraie :

or(true, false)
or(false, false)

Les résultats retournés sont respectivement :

• comme au moins une expression est vraie, la fonction retourne true.
• comme les deux expressions sont fausses, la fonction retourne false.

Exemple 2

Ces exemples vérifient si au moins une expression est vraie :

or(equals(1, 1), equals(1, 2))
or(equals(1, 2), equals(1, 3))

Les résultats retournés sont respectivement :

• comme au moins une expression est vraie, la fonction retourne true.
• comme les deux expressions sont fausses, la fonction retourne false.

rand

Retourne un entier aléatoire à partir d’une plage spécifiée, qui est inclus uniquement au point de départ.

rand(<minValue>, <maxValue>)

Paramètre	Obligatoire	Type	Description
<minValue>	Oui	entier	Entier le plus petit de la plage
<maxValue>	Oui	entier	Entier qui suit l’entier le plus élevé dans la plage que la fonction peut retourner

Valeur retournée	Type	Description
<random-result>	entier	Entier aléatoire retourné à partir de la plage spécifiée

Exemple

Cet exemple illustre l’obtention d’un entier aléatoire à partir de la plage spécifiée, en excluant la valeur maximale :

rand(1, 5)

Le résultat retourné est 1, 2, 3 ou 4.

range

Retourne un tableau d’entiers qui commence par un entier spécifique.

range(<startIndex>, <count>)

Paramètre	Obligatoire	Type	Description
<startIndex>	Oui	entier	Une valeur entière qui constitue le premier élément du tableau
<count>	Oui	entier	Nombre d’entiers du tableau

Valeur retournée	Type	Description
<range-result>	entier	Tableau dont les entiers commencent à partir de l’index spécifié

Exemple

Dans cet exemple, un tableau d’entiers commençante à partir de l’index spécifié 1 et possédant le nombre spécifié d’entiers 4 est créé :

range(1, 4)

Le résultat retourné est [1, 2, 3, 4].

removeProperty

Supprime une propriété dans un objet et retourne l’objet mis à jour.

removeProperty(<object>, '<property>')

Paramètre	Obligatoire	Type	Description
<object>	Oui	object	Objet JSON dont une propriété doit être supprimée
<propriété>	Oui	string	Nom de la propriété à supprimer

Valeur retournée	Type	Description
<updated-object>	object	Objet JSON mis à jour sans la propriété spécifiée

Exemple

Dans cet exemple, la propriété accountLocation est supprimée d’un objet customerProfile, qui est converti au format JSON avec la fonction json(). L’objet mis à jour est retourné :

removeProperty(json('customerProfile'), 'accountLocation')

remplacer

Remplace une sous-chaîne par la chaîne spécifiée et retourne la chaîne de résultat. Cette fonction respecte la casse.

replace('<text>', '<oldText>', '<newText>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne comportant la sous-chaîne à remplacer
<oldText>	Oui	string	Sous-chaîne à remplacer
<newText>	Oui	string	Chaîne de remplacement

Valeur retournée	Type	Description
<updated-text>	string	Chaîne mise à jour après le remplacement de la sous-chaîne. Si le substring est introuvable, la fonction retourne la chaîne d’origine.

Exemple 1 :

Dans cet exemple, la sous-chaîne old est recherchée dans la chaîne the old string et old est remplacé par new :

replace('the old string', 'old', 'new')

Le résultat est la chaîne the new string.

Exemple 2

En présence de caractères d’échappement, le moteur d’expression gère automatiquement la suppression de l’échappement. Cette fonction remplace les chaînes par des caractères d’échappement.

replace('hello\"', '\"', '\n')
replace('hello\n', '\n', '\\\\')
@"replace('hello\\', '\\', '\\\\')"
@"replace('hello\n', '\n', '\\\\')"

Les résultats retournés sont respectivement :

• hello\n
• hello\\
• @"hello\\"
• @"hello\\"

replaceIgnoreCase

Remplace une sous-chaîne par la chaîne spécifiée et retourne la chaîne de résultat. Cette fonction ne respecte pas la casse.

replaceIgnoreCase('<text>', '<oldText>', '<newText>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne comportant la sous-chaîne à remplacer
<oldText>	Oui	string	Sous-chaîne à remplacer
<newText>	Oui	string	Chaîne de remplacement

Valeur retournée	Type	Description
<updated-text>	string	Chaîne mise à jour après le remplacement de la sous-chaîne. Si la sous-chaîne est introuvable, retourne la chaîne d’origine.

Exemple

Dans cet exemple, la sous-chaîne old est recherchée dans la chaîne the old string et old est remplacé par new :

replace('the old string', 'old', 'new')

Le résultat retourné est the new string.

resolve

Retourne une chaîne d’expressions TimexProperty ou Timex données si elle fait référence à une heure valide. L’heure valide comporte des heures, des minutes et des secondes.

resolve('<timestamp')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage.

Valeur retournée	Type	Description
<return>	string	Chaîne de l’expression TimexProperty ou Timex évaluée.

Exemples

Ces exemples montrent si les chaînes données font référence à l’heure valide :

resolve(T14)
resolve(2020-12-20)
resolve(2020-12-20T14:20)

Les résultats retournés sont respectivement :

• 14:00:00
• 2020-12-20
• 2020-12-20 14:20:00

inverser

Inverse l’ordre des éléments dans une chaîne ou un tableau.

reverse(<value>)

Paramètre	Obligatoire	Type	Description
<value>	Oui	chaîne ou tableau	Chaîne à tableaux à inverser.

Valeur retournée	Type	Description
<return>	chaîne ou tableau	Éléments inversés d’une chaîne ou d’un tableau.

Exemples

Ces exemples inversent les éléments d’une chaîne ou d’un tableau :

reverse(hello)
reverse(concat(hello,world))

Ils retournent les chaînes suivantes respectivement :

- La chaîne olleh. - La chaîne dlrowolleh.

round

Arrondit une valeur à l’entier le plus proche ou au nombre spécifié de chiffres fractionnaires.

round('<number>', '<precision-digits>')

Paramètre	Obligatoire	Type	Description
<number>	Oui	nombre	Un nombre d’entrée
<chiffres de précision>	Non	entier	Nombre spécifié de chiffres fractionnaires. La valeur par défaut est 0.

Valeur retournée	Type	Description
<return-value>	nombre	La valeur renvoyée de l’entrée est arrondie à un nombre spécifié de chiffres fractionnaires

Exemple 1 :

Cet exemple arrondit le nombre 10.333 :

round(10.333)

Retourne le nombre 10.

Exemple 2

Cet exemple arrondit le nombre 10.3313 à 2 chiffres fractionnaires :

round(10.3313, 2)

Retourne le nombre 10.33.

select

S’applique à chaque élément et retourne la nouvelle collection d’éléments transformés.

select([<collection/instance>], <iteratorName>, <function>)

Paramètre	Obligatoire	Type	Description
<collection/instance>	Oui	tableau	Collection contenant les éléments
<iteratorName>	Oui	Nom de l’itérateur	Élément clé
<function>	Oui	expression	Fonction pouvant contenir iteratorName

Valeur retournée	Type	Description
<new-collection>	tableau	Nouvelle collection dans laquelle chaque élément a été évalué avec la fonction

Exemple 1 :

Dans cet exemple, une nouvelle collection est générée :

select(createArray(0, 1, 2, 3), x, x + 1)

Le résultat retourné est [1, 2, 3, 4].

Exemple 2

Dans ces exemples, une nouvelle collection est générée :

select(json("{'name': 'jack', 'age': '15'}"), x, concat(x.key, ':', x.value))
select(json("{'name': 'jack', 'age': '15'}"), x=> concat(x.key, ':', x.value))

Le résultat retourné est [’name:jack’, ’age:15’]. La deuxième expression est une expression lambda, que certains trouvent plus lisible.

sentenceCase

Mettre en majuscule la première lettre du premier mot dans une chaîne dans une mise en forme locale facultative.

sentenceCase('<text>', '<locale>'?)

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne originale
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
Chaîne de résultat	string	Retourne le résultat de la casse de phrase

Exemple 1 :

Dans ces exemples, la première lettre d’une chaîne de caractères est mise en majuscule :

sentenceCase('a')
sentenceCase('abc def')
sentenceCase('aBC dEF')

Les résultats retournés sont respectivement :

• A
• Abc def
• Abc def

Exemple 2

Dans ces exemples, la première lettre d’une chaîne de caractères est mise en majuscule dans la mise en forme locale spécifiée :

sentenceCase('a', 'fr-FR')
sentenceCase('abc', 'en-US')
sentenceCase('aBC', 'fr-FR')

Les résultats retournés sont respectivement :

• A
• Abc
• Abc

setPathToValue

Récupère la valeur de la propriété spécifiée à partir de l’objet JSON.

setPathToValue(<path>, <value>)

Paramètre	Obligatoire	Type	Description
<Chemin d’accès>	Oui	object	Chemin à définir
<valeur>	Oui	object	Valeur à donner au chemin

Valeur retournée	Type	Description
valeur	object	Valeur définie

Exemple 1 :

Dans cet exemple, la valeur du chemin est définie sur 1 :

setPathToValue(path.x, 1)

Le résultat retourné est 1. path.x est défini sur 1.

Exemple 2

Dans cet exemple, la valeur est définie :

setPathToValue(path.array[0], 7) + path.array[0]

Le résultat retourné est 14.

SetProperty

Définit la valeur d’une propriété d’un objet et retourne l’objet mis à jour. Pour ajouter une nouvelle propriété, utilisez cette fonction ou la fonction addProperty().

setProperty(<object>, '<property>', <value>)

Paramètre	Obligatoire	Type	Description
<object>	Oui	object	Objet JSON dont une propriété doit être définie
<propriété>	Oui	string	Nom de la propriété à définir
<valeur>	Oui	n'importe laquelle	Valeur à définir pour la propriété spécifiée

Valeur retournée	Type	Description
<updated-object>	object	Objet JSON mis à jour dont vous définissez la propriété

Exemple

Dans cet exemple, la propriété accountNumber est défini sur un objet customerProfile, qui est converti au format JSON avec la fonction json(). La fonction attribue une valeur générée par la fonction newGuid()L’objet JSON mis à jour est retourné :

setProperty(json('customerProfile'), 'accountNumber', newGuid())

skip

Supprime des éléments du début d’une collection et retourne tous les autres éléments.

skip([<collection>], <count>)

Paramètre	Obligatoire	Type	Description
<collection>	Oui	tableau	Collection dont vous voulez supprimer des éléments
<count>	Oui	entier	Entier positif correspondant au nombre d’éléments à supprimer au début

Valeur retournée	Type	Description
<updatedCollection>	tableau	Collection mise à jour à l’issue de la suppression des éléments spécifiés

Exemple

Dans cet exemple, un élément (le nombre 1) est supprimé au début du tableau spécifié :

skip(createArray(0, 1, 2, 3), 1)

Un tableau comportant les éléments restants est retourné : [1,2,3].

sortBy

Trie les éléments de la collection par ordre croissant et retourne la collection triée.

sortBy([<collection>], '<property>')

Paramètre	Obligatoire	Type	Description
<collection>	Oui	chaîne ou tableau	Collection à trier
<propriété>	Non	string	Propriété spécifiée servant à fixer l’ordre de tri de l’élément d’objet dans la collection, si elle est définie

Valeur retournée	Type	Description
<new-collection>	tableau	Nouvelle collection dont les éléments ont été triés

Exemple 1 :

Dans cet exemple, la collection suivante est triée :

sortBy(createArray(1, 2, 0, 3))

Le résultat retourné est [0, 1, 2, 3].

Exemple 2

Prenons la collection suivante :

{
  'nestedItems': [
    {'x': 2},
    {'x': 1},
    {'x': 3}
  ]
}

Dans cet exemple, une nouvelle collection triée est générée en fonction de la propriété de l’objet x.

sortBy(nestedItems, 'x')

Le résultat retourné est :

{
  'nestedItems': [
    {'x': 1},
    {'x': 2},
    {'x': 3}
  ]
}

sortByDescending

Trie les éléments de la collection par ordre décroissant et retourne la collection triée.

sortBy([<collection>], '<property>')

Paramètre	Obligatoire	Type	Description
<collection>	Oui	chaîne ou tableau	Collection à trier
<propriété>	Non	string	Propriété spécifiée servant à fixer l’ordre de tri de l’élément d’objet dans la collection, si elle est définie

Valeur retournée	Type	Description
<new-collection>	tableau	Nouvelle collection dont les éléments ont été triés

Exemple 1 :

Dans cet exemple, une nouvelle collection triée est générée :

sortByDescending(createArray(1, 2, 0, 3))

Le résultat retourné est [3, 2, 1, 0].

Exemple 2

Prenons la collection suivante :

{
  'nestedItems': [
    {'x': 2},
    {'x': 1},
    {'x': 3}
  ]
}

Dans cet exemple, une nouvelle collection triée est générée en fonction de la propriété de l’objet x :

sortByDescending(nestedItems, 'x')

Et retourne ce résultat :

{
  'nestedItems': [
    {'x': 3},
    {'x': 2},
    {'x': 1}
  ]
}

split

Retourne un tableau qui contient des sous-chaînes, séparées par des virgules, extraites sur la base du caractère délimiteur spécifié dans la chaîne d’origine.

split('<text>', '<delimiter>'?)

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne à séparer en sous-chaînes en fonction du délimiteur spécifié dans la chaîne d’origine. Si le texte est une valeur Null, il sera considéré comme une chaîne vide.
<delimiter>	Non	string	Caractère présent dans la chaîne d’origine à utiliser comme délimiteur. Si aucun délimiteur n’est fourni ou si le délimiteur est une valeur Null, la valeur par défaut est une chaîne vide.

Valeur retournée	Type	Description
[<substring1>,<substring2>,...]	tableau	Un tableau qui contient les sous-chaînes extraites de la chaîne d’origine, séparées par des virgules

Exemples

Dans ces exemples, un tableau comportant des sous-chaînes extraites de la chaîne spécifiée en fonction du caractère délimiteur spécifié est créé :

split('a**b**c', '**')
split('hello', '')
split('', 'e')
split('', '')
split('hello')

Les tableaux retournés sous forme de résultats sont respectivement :

• ["a", "b", "c"]
• ["h", "e", "l", "l", "o"]
• [""], [ ]
• ["h", "e", "l", "l", "o"]

sqrt

Retourne la racine carrée d’un nombre spécifié.

sqrt(<number>)

Paramètre	Obligatoire	Type	Description
<number>	Oui	nombre	Nombre dont obtenir la racine carrée

Valeur retournée	Type	Description
<result>	nombre	Résultat du calcul de la racine carrée.

Exemples

Ces exemples calculent la racine carrée des nombres spécifiés :

sqrt(9)
sqrt(0)

Les résultats retournés sont respectivement :

• 3
• 0

startOfDay

Retourne le début de la journée pour un horodateur dans une mise en forme locale facultative.

startOfDay('<timestamp>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
’<updated-timestamp>’	string	Timestamp spécifié, commençant à la marque zéro heure du jour

Exemple 1 :

Dans cet exemple, le début du jour est recherché :

startOfDay('2018-03-15T13:30:30.000Z')

Le résultat retourné est 2018-03-15T00:00:00.000Z.

Exemple 2

Cet exemple recherche le début de la journée avec les paramètres régionaux correspondants à fr-FR :

startOfDay('2018-03-15T13:30:30.000Z', '', 'fr-FR')

Le résultat retourné est 15/03/2018 00:00:00.

startOfHour

Retourne le début de l’heure pour un horodateur dans une mise en forme locale facultative.

startOfHour('<timestamp>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
’<updated-timestamp>’	string	Timestamp spécifié, commençant à la marque zéro minute du jour

Exemple 1 :

Dans cet exemple, le début de l’heure est recherché :

startOfHour('2018-03-15T13:30:30.000Z')

Le résultat retourné est 2018-03-15T13:00:00.000Z.

Exemple 2

Cet exemple recherche le début de l’heure avec les paramètres régionaux correspondants à fr-FR :

startOfHour('2018-03-15T13:30:30.000Z', '', 'fr-FR')

Le résultat retourné est 15/03/2018 13:00:00.

startOfMonth

Retourne le début du mois pour un horodateur dans une mise en forme locale facultative.

startOfMonth('<timestamp>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
’<updated-timestamp>’	string	Timestamp spécifié, commençant le premier jour du mois à la marque zéro heure

Exemple 1 :

Dans cet exemple, le début du mois est recherché :

startOfMonth('2018-03-15T13:30:30.000Z')

Le résultat retourné est 2018-03-01T00:00:00.000Z.

Exemple 2

Cet exemple recherche le début du mois avec pour format fr-FR :

startOfMonth('2018-03-15T13:30:30.000Z', '', 'fr-FR')

Le résultat retourné est 01/03/2018 00:00:00.

startsWith

Vérifie si une chaîne commence par une sous-chaîne spécifique. Retourne true si la sous-chaîne est trouvée, false sinon. Cette fonction ne respecte pas la casse.

startsWith('<text>', '<searchText>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne à vérifier
<searchText>	Oui	string	Sous-chaîne de départ à rechercher

Valeur retournée	Type	Description
True ou False	Boolean	Retourne true si la sous-chaîne de début est trouvée. Retourne false si elle n’est pas trouvée.

Exemple 1 :

Dans cet exemple, la chaîne hello world est examinée pour savoir si elle commence par la chaîne hello :

startsWith('hello world', 'hello')

Le résultat retourné est true.

Exemple 2

Dans cet exemple, la chaîne hello world est examinée pour savoir si elle commence par la chaîne greeting :

startsWith('hello world', 'greeting')

Le résultat retourné est false.

string

Retourne la version de chaîne d’une valeur dans une mise en forme locale facultative.

string(<value>, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<value>	Oui	n'importe laquelle	Valeur à convertir
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<string-value>	string	Version de type chaîne de la valeur spécifiée

Exemple 1 :

Dans cet exemple, la version de type chaîne du nombre 10 est créée :

string(10)

Le résultat retourné est la chaîne 10.

Exemple 2

Dans cet exemple, une chaîne est créée pour l’objet JSON spécifié avec le caractère de barre oblique inverse (\\) comme caractère d’échappement pour le caractère guillemet double (").

string( { "name": "Sophie Owen" } )

Le résultat retourné est { "name": "Sophie Owen" }

Exemple 3

Cet exemple crée une version de chaîne du numéro 10 dans des paramètres régionaux spécifiques :

string(100.1, 'fr-FR')
string(100.1, 'en-US')

Retourne les chaînes suivantes respectivement :

• 100,1
• 100.1

stringOrValue

Inclure dans un wrapper l’interpolation de la chaîne de caractères pour obtenir la valeur réelle. Par exemple, stringOrValue('${1}') retourne le nombre 1, tandis que stringOrValue('${1} item') retourne la chaîne « 1 élément ».

stringOrValue(<string>)

Paramètre	Obligatoire	Type	Description
<string>	Oui	string	Chaîne à partir de laquelle obtenir la valeur réelle.

Valeur retournée	Type	Description
<result>	n'importe laquelle	Résultat de l’obtention de la valeur réelle de la chaîne spécifiée.

Exemples

Ces exemples obtiennent la valeur réelle de la chaîne :

stringOrValue('${one}')
stringOrValue('${one} item')

Les résultats retournés sont respectivement :

• Nombre 1.0.
• Chaîne 1 article.

sub

Retourne le résultat de la soustraction du second nombre du premier.

sub(<minuend>, <subtrahend>)

Paramètre	Obligatoire	Type	Description
<minuend>	Oui	nombre	Nombre à partir duquel soustraire le plus petit terme
<subtrahend>	Oui	nombre	Nombre à soustraire du plus petit terme

Valeur retournée	Type	Description
<result>	nombre	Résultat de la soustraction du second nombre du premier

Exemple

Cet exemple illustre la soustraction du second nombre du premier :

sub(10.3, .3)

Le résultat retourné est 10.

subArray

Retourne un sous-tableau à partir des positions de début et de fin spécifiées. Les valeurs d’index commencent par le chiffre 0.

subArray(<Array>, <startIndex>, <endIndex>)

Paramètre	Obligatoire	Type	Description
<array>	Oui	tableau	Tableau à partir duquel le sous-tableau est créé
<startIndex>	Oui	entier	Nombre positif supérieur ou égal à 0 à utiliser comme position ou valeur d’index de départ
<endIndex>	Oui	entier	Nombre positif supérieur ou égal à 0 à utiliser comme position ou valeur d’index de fin

Valeur retournée	Type	Description
<subarray-result>	tableau	Sous-tableau contenant le nombre spécifié d’éléments, en commençant à la position d’index spécifiée dans la chaîne source

Exemple

Dans cet exemple, un sous-tableau est créé à partir du tableau spécifié :

subArray(createArray('H','e','l','l','o'), 2, 5)

Le résultat retourné est ["l", "l", "o"].

substring

Retourne les caractères d’une chaîne, en commençant à partir de la position ou de l’index spécifié. Les valeurs d’index commencent par le chiffre 0.

substring('<text>', <startIndex>, <length>)

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne à partir de laquelle la sous-chaîne est créée
<startIndex>	Oui	entier	Nombre positif supérieur ou égal à 0 à utiliser comme position ou valeur d’index de départ
<length>	Oui	entier	Nombre positif de caractères dans la sous-chaîne

Valeur retournée	Type	Description
<substring-result>	string	Sous-chaîne contenant le nombre spécifié de caractères, en commençant à la position d’index spécifiée dans la chaîne source

Exemple

Cet exemple illustre la création d’une sous-chaîne de cinq caractères à partir de la chaîne spécifiée, en commençant à partir de la valeur d’index 6 :

substring('hello world', 6, 5)

Le résultat retourné est world.

subtractFromTime

Soustrait un nombre d’unités de temps d’un horodateur dans une mise en forme locale facultative. Voir aussi getPastTime().

subtractFromTime('<timestamp>', <interval>, '<timeUnit>', '<format>'?, '<locale>'?)

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage
<interval>	Oui	entier	Nombre d’unités de temps spécifiées à soustraire
<timeUnit>	Oui	string	Unité de temps à utiliser avec interval. Unités possibles : « Second » (seconde), « Minute » (minute), « Hour » (heure), « Day » (jour), « Week » (semaine), « Month » (mois) et « Year » (année).
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<updated-timestamp>	string	Horodatage moins le nombre d’unités de temps spécifié

Exemple 1 :

Dans cet exemple, un jour est soustrait de l’horodateur suivant :

subtractFromTime('2018-01-02T00:00.000Z', 1, 'Day')

Le résultat retourné est 2018-01-01T00:00:00.000Z.

Exemple 2

Dans cet exemple, un jour est soustrait d’un horodateur au format D :

subtractFromTime('2018-01-02T00:00.000Z', 1, 'Day', 'D')

Le résultat retourné est lundi 1er janvier 2018.

Exemple 3

Cet exemple soustrait 1 heure d’un horodateur dans les paramètres régionaux de correspondants au format de-DE :

subtractFromTime('2018-03-15T13:00:00.000Z', 1, 'Hour', '', 'de-DE')

Le résultat retourné est 15.03.18 12:00:00.

somme

Retourne le résultat de l’addition des nombres d’une liste.

sum([<list of numbers>])

Paramètre	Obligatoire	Type	Description
[<list of numbers>]	Oui	Tableau de nombres	Nombres à ajouter

Valeur retournée	Type	Description
<result-sum>	nombre	Résultat de l’addition des nombres spécifiés

Exemple

Cet exemple illustre l’addition des nombres spécifiés :

sum(createArray(1, 1.5))

Le résultat retourné est 2.5.

take

Retourne des éléments du début d’une collection.

take('<collection>', <count>)
take([<collection>], <count>)

Paramètre	Obligatoire	Type	Description
<collection>	Oui	chaîne ou tableau	Collection dont vous souhaitez des éléments
<count>	Oui	entier	Entier positif correspondant au nombre d’éléments souhaités à partir du début

Valeur retournée	Type	Description
<subset> or [<subset>]	Chaîne ou tableau, respectivement	Chaîne ou tableau qui comporte le nombre spécifié d’éléments obtenus à partir du début de la collection d’origine

Exemple

Ces exemples illustrent l’obtention du nombre spécifié d’éléments à partir du début de ces collections :

take('abcde', 3)
take(createArray(0, 1, 2, 3, 4), 3)

Les résultats retournés sont respectivement :

• abc
• [0, 1, 2]

ticks

Retourne la valeur de la propriété Ticks d’un timestamp spécifié. Un tick est un intervalle de 100 nanosecondes.

ticks('<timestamp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne d’un horodatage

Valeur retournée	Type	Description
<ticks-number>	entier (bigint en JavaScript)	Nombre de graduations depuis l’horodatage spécifié

Exemple

Dans cet exemple, un timestamp est converti en sa propriété cyclique :

ticks('2018-01-01T08:00:00.000Z')

Le résultat retourné est 636503904000000000.

ticksToDays

Convertissez une valeur de propriété de cycles en nombre de jours.

ticksToDays('ticks')

Paramètre	Obligatoire	Type	Description
<ticks>	Oui	entier	Valeur de propriété cyclique à convertir

Valeur retournée	Type	Description
<Nombre de jours>	nombre	Nombre de jours convertis à partir de la valeur de propriété cyclique

Exemple

Cet exemple convertit une valeur de propriété cyclique en un certain nombre de jours :

ticksToDays(2193385800000000)

Retourne le nombre 2538.64097222.

ticksToHours

Convertit une valeur de propriété de cycles en nombre d’heures.

ticksToHours('ticks')

Paramètre	Obligatoire	Type	Description
<ticks>	Oui	Integer	Valeur de propriété cyclique à convertir

Valeur retournée	Type	Description
<number-of-hours>	nombre	Nombre d’heures converties à partir de la valeur de propriété cyclique

Exemple

Cet exemple convertit une valeur de propriété cyclique en un certain nombre d’heures :

ticksToHours(2193385800000000)

Retourne le nombre 60927.383333333331.

ticksToMinutes

Convertit une valeur de propriété de cycles en nombre de minutes.

ticksToMinutes('ticks')

Paramètre	Obligatoire	Type	Description
<ticks>	Oui	entier	Valeur de propriété cyclique à convertir

Valeur retournée	Type	Description
<number-of-minutes>	nombre	Nombre de minutes converties à partir de la valeur de propriété cyclique

Exemple

Cet exemple convertit une valeur de propriété cyclique en un certain nombre de minutes :

ticksToMinutes(2193385800000000)

Retourne le nombre 3655643.0185.

titleCase

Mettre en majuscule la première lettre de chaque mot dans une chaîne dans une mise en forme locale facultative.

titleCase('<text>', '<locale>'?)

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne originale
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
Chaîne de résultat	string	Résultat de l’action 1re lettre des mots en majuscule

Exemple 1 :

Dans ces exemples, la première lettre de chaque mot d’une chaîne de caractères est mise en majuscule :

titleCase('a')
titleCase('abc def')
titleCase('aBC dEF')

Les résultats retournés sont respectivement :

• A
• Abc Def
• Abc Def

Exemple 2

Dans ces exemples, la première lettre d’une chaîne de caractères est mise en majuscule au format en-US :

titleCase('a', 'en-US')
titleCase('aBC dEF', 'en-US')

Les résultats retournés sont respectivement :

• A
• Abc Def

toLower

Retourne une chaîne en minuscules dans une mise en forme locale facultative. Si un caractère de la chaîne n’a pas de version en minuscules, ce caractère reste tel quel dans la chaîne retournée.

toLower('<text>', '<locale>'?)

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne à retourner en minuscules
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<lowercase-text>	string	Chaîne d’origine en minuscules

Exemple 1 :

Dans cet exemple, une chaîne est convertie en minuscules :

toLower('Hello World')

Le résultat retourné est hello world.

Exemple 2

Dans cet exemple, une chaîne de caractères est convertie en minuscules au format fr-FR :

toUpper('Hello World', 'fr-FR')

Le résultat retourné est hello world.

toUpper

Retourne une chaîne en capitales dans un format de paramètres régionaux facultatif. Si un caractère de la chaîne n’a pas de version en majuscules, ce caractère reste tel quel dans la chaîne retournée.

toUpper('<text>', '<locale>'?)

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne à retourner en majuscules
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<uppercase-text>	string	Chaîne d’origine en majuscules

Exemple 1 :

Dans cet exemple, une chaîne est convertie en majuscules :

toUpper('Hello World')

Le résultat retourné est HELLO WORLD.

Exemple 2

Cet exemple convertit une chaîne en capitales au format fr-FR :

toUpper('Hello World', 'fr-FR')

Le résultat retourné est HELLO WORLD.

trim

Supprime les espaces blancs de début et de fin d’une chaîne et retourne la chaîne mise à jour.

trim('<text>')

Paramètre	Obligatoire	Type	Description
<text>	Oui	string	Chaîne contenant les espaces blancs de début et de fin à supprimer

Valeur retournée	Type	Description
<updatedText>	string	Version mise à jour de la chaîne d’origine sans espace blanc de début ou de fin

Exemple

Dans cet exemple, les espaces blancs de début et de fin sont supprimés de la chaîne " Hello World " :

trim(' Hello World  ')

Le résultat retourné est Hello World.

union

Retourne une collection qui contient tous les éléments des collections spécifiées. Pour qu’il apparaisse dans le résultat, un élément peut apparaître dans n’importe quelle collection transmise à cette fonction. Si un ou plusieurs éléments portent le même nom, le dernier élément de ce nom apparaît dans le résultat.

union('<collection1>', '<collection2>', ...)
union([<collection1>], [<collection2>], ...)

Paramètre	Obligatoire	Type	Description
<collection1>, <collection2>, ...	Oui	Tableau ou objet, mais pas les deux	Collections dont vous souhaitez tous les éléments

Valeur retournée	Type	Description
<updatedCollection>	Respectivement tableau ou objet	Collection contenant tous les éléments des collections spécifiées, sans ajout de doublons

Exemple

Dans cet exemple, tous les éléments des collections suivantes sont récupérés :

union(createArray(1, 2, 3), createArray(1, 2, 10, 101))

Le résultat retourné est [1, 2, 3, 10, 101].

unique

Supprime tous les doublons d’un tableau.

unique([<collection>])

Paramètre	Obligatoire	Type	Description
<collection>	Oui	tableau	Collection à modifier

Valeur retournée	Type	Description
<new-collection>	tableau	Nouvelle collection dont les éléments en double ont été supprimés

Exemple 1 :

Dans cet exemple, les éléments en double sont supprimés du tableau suivant :

unique(createArray(1, 2, 1))

Le résultat retourné est [1, 2].

uriComponent

Retourne la version binaire d’un composant d’URI (Uniform Resource Identifier).

uriComponent('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne à convertir au format encodé sous forme d’URI

Valeur retournée	Type	Description
<encoded-uri>	string	Chaîne encodée sous forme d’URI avec des caractères d’échappement

Exemple

Dans cet exemple, une version encodée sous forme d’URI d’une chaîne est créée :

uriComponent('https://contoso.com')

Le résultat retourné est http%3A%2F%2Fcontoso.com.

uriComponentToString

Retourne la version de type chaîne d’une chaîne encodée sous forme d’URI (Uniform Resource Identifier), en décodant la chaîne encodée sous forme d’URI.

uriComponentToString('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne encodée sous forme d’URI à décoder

Valeur retournée	Type	Description
<binary-for-encoded-uri>	string	Version décodée de la chaîne encodée sous forme d’URI

Exemple

Dans cet exemple, la version de type chaîne décodée d’une chaîne encodée sous forme d’URI est créée :

uriComponentToString('http%3A%2F%2Fcontoso.com')

Le résultat retourné est https://contoso.com.

uriHost

Retourne la valeur d’hôte d’un URI (Uniform Resource Identifier).

uriHost('<uri>')

Paramètre	Obligatoire	Type	Description
<uri>	Oui	string	URI dont la valeur d’hôte doit être récupérée

Valeur retournée	Type	Description
<host-value>	string	Valeur d’hôte de l’URI spécifié

Exemple

Dans cet exemple, la valeur d’hôte de l’URI suivant est recherchée :

uriHost('https://www.localhost.com:8080')

Le résultat retourné est www.localhost.com.

uriPath

Retourne la valeur de chemin d’un URI (Uniform Resource Identifier).

uriPath('<uri>')

Paramètre	Obligatoire	Type	Description
<uri>	Oui	string	URI dont la valeur de port doit être récupérée

Valeur retournée	Type	Description
<path-value>	string	Valeur de chemin de l’URI spécifié

Exemple

Dans cet exemple, la valeur de chemin de l’URI suivant est recherchée :

uriPath('http://www.contoso.com/catalog/shownew.htm?date=today')

Le résultat retourné est /catalog/shownew.htm.

uriPathAndQuery

Retourne les valeurs de chemin et de requête d’un URI (Uniform Resource Identifier).

uriPathAndQuery('<uri>')

Paramètre	Obligatoire	Type	Description
<uri>	Oui	string	URI dont la valeur de chemin et de requête doit être récupérée

Valeur retournée	Type	Description
<path-query-value>	string	Valeur de chemin et de requête de l’URI spécifié

Exemple

Dans cet exemple, la valeur de chemin et de requête de l’URI suivant est recherchée :

uriPathAndQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

Le résultat retourné est /catalog/shownew.htm?date=today.

uriPort

Retourne la valeur de port d’un URI (Uniform Resource Identifier).

uriPort('<uri>')

Paramètre	Obligatoire	Type	Description
<uri>	Oui	string	URI dont la valeur de port doit être récupérée

Valeur retournée	Type	Description
<port-value>	string	Valeur de port de l’URI spécifié

Exemple

Dans cet exemple, la valeur de port de l’URI suivant est recherchée :

uriPort('http://www.localhost:8080')

Le résultat retourné est 8080.

uriQuery

Retourne la valeur de requête d’un URI (Uniform Resource Identifier).

uriQuery('<uri>')

Paramètre	Obligatoire	Type	Description
<uri>	Oui	string	URI dont la valeur de schéma doit être récupérée

Valeur retournée	Type	Description
<query-value>	string	Valeur de requête de l’URI spécifié

Exemple

Dans cet exemple, la valeur de requête de l’URI suivant est recherchée :

uriQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

Le résultat retourné est ?date=today.

uriScheme

Retourne la valeur de schéma d’un URI (Uniform Resource Identifier).

uriScheme('<uri>')

Paramètre	Obligatoire	Type	Description
<uri>	Oui	string	URI dont la valeur de schéma doit être récupérée

Valeur retournée	Type	Description
<scheme-value>	string	Valeur de schéma de l’URI spécifié

Exemple

Dans cet exemple, la valeur de schéma de l’URI suivant est recherchée :

uriQuery('http://www.contoso.com/catalog/shownew.htm?date=today')

Le résultat retourné est http.

utcNow

Retourne l’horodateur actuel dans une mise en forme locale facultative sous forme de chaîne.

utcNow('<format>', '<locale>'?)

Si vous le souhaitez, vous pouvez spécifier un autre format avec le paramètre <format>.

Paramètre	Obligatoire	Type	Description
<format>	Non	string	Modèle de format personnalisé. Le timestamp est par défaut au format ISO UTC AAAA-MM-JJTHH:mm:ss.fffZ, qui est conforme à la norme ISO 8601.
<locale>	Non	string	Paramètres régionaux facultatifs des informations sur la culture

Valeur retournée	Type	Description
<current-timestamp>	string	Date et heure actuelles

Exemple 1 :

Supposons que la date soit le 15 avril 2018 à 13:00:00. Dans cet exemple, le timestamp est récupéré :

utcNow()

Le résultat retourné est 2018-04-15T13:00:00.000Z.

Exemple 2

Supposons que la date soit le 15 avril 2018 à 13:00:00. Dans cet exemple, le timestamp actuel est récupéré au format D facultatif :

utcNow('D')

Le résultat retourné est Sunday, April 15, 2018.

Exemple 3

Supposons que la date soit le 15 avril 2018 à 13:00:00. Dans cet exemple, l’horodateur actuel est récupéré au format de-DE :

utcNow('', 'de-DE')

Le résultat retourné est 15.04.18 13:00:00.

where

Filtre sur chaque élément et retourne la nouvelle collection d’éléments filtrés qui respectent une condition spécifiée.

where([<collection/instance>], <iteratorName>, <function>)

Paramètre	Obligatoire	Type	Description
<collection/instance>	Oui	tableau	Collection contenant les éléments
<iteratorName>	Oui	Nom de l’itérateur	Élément clé
<function>	Oui	expression	Fonction de condition utilisée pour filtrer les éléments

Valeur retournée	Type	Description
<new-collection/new-object>	Tableau/objet	Nouvelle collection dont chaque élément a été filtré avec la fonction

Exemple 1 :

Dans cet exemple, une nouvelle collection est générée :

where(createArray(0, 1, 2, 3), x, x > 1)

Le résultat retourné est [2, 3].

Exemple 2

Dans ces exemples, une nouvelle collection est générée :

where(json("{'name': 'jack', 'age': '15'}"), x, x.value == 'jack')
where(json("{'name': 'jack', 'age': '15'}"), x=> x.value == 'jack')

Le résultat retourné est [’name:jack’, ’age:15’]. La deuxième expression est une expression lambda, que certains trouvent plus lisible.

Xml

Retourne la version XML d’une chaîne contenant un objet JSON.

xml('<value>')

Paramètre	Obligatoire	Type	Description
<value>	Oui	string	Chaîne contenant l’objet JSON à convertir. L’objet JSON ne doit avoir qu’une seule propriété racine, qui ne peut pas être un tableau. Utilisez \ comme caractère d’échappement pour le guillemet double (").

Valeur retournée	Type	Description
<xml-version>	object	Élément XML encodé correspondant à la chaîne ou à l’objet JSON spécifié

Exemple 1 :

Dans cet exemple, la version XML d’une chaîne contenant un objet JSON est créée :

xml(json('{ \"name\": \"Sophia Owen\" }'))

Le résultat retourné est le XML :

<name>Sophia Owen</name>

Exemple 2

Prenons un objet JSON person :

{
  "person": {
    "name": "Sophia Owen",
    "city": "Seattle"
  }
}

Dans cet exemple, l’élément XML d’une chaîne contenant cet objet JSON est créé :

xml(json('{\"person\": {\"name\": \"Sophia Owen\", \"city\": \"Seattle\"}}'))

Le résultat retourné est le XML :

<person>
  <name>Sophia Owen</name>
  <city>Seattle</city>
<person

xPath

Vérifie si le code XML contient des valeurs ou des nœuds qui correspondent à une expression de langage XPath et retourne les valeurs ou les nœuds correspondants. Une expression XPath (appelée XPath) permet de parcourir une structure de document XML de façon à pouvoir sélectionner des nœuds ou des valeurs de calcul dans le contenu XML.

xPath('<xml>', '<xpath>')

Paramètre	Obligatoire	Type	Description
<xml>	Oui	n'importe laquelle	Chaîne XML pour rechercher des nœuds ou des valeurs qui correspondent à une valeur d’expression XPath
<xPath>	Oui	n'importe laquelle	Expression XPath utilisée pour rechercher des nœuds ou des valeurs XML correspondants

Valeur retournée	Type	Description
<xml-node>	XML	Nœud XML lorsqu’un seul nœud correspond à l’expression XPath spécifiée
<value>	tous	Valeur d’un nœud XML lorsqu’un seul nœud correspond à l’expression XPath spécifiée
<[<xml-node1>, <xml-node2>, ...] -or- [<valeur 1>, <valeur 2>, ...]>	tableau	Tableau contenant des nœuds ou valeurs XML qui correspondent à l’expression XPath spécifiée

Exemple 1 :

Cet exemple recherche les nœuds qui correspondent au nœud <name></name> dans les arguments spécifiés, et retourne un tableau contenant ces valeurs de nœud :

xPath(items, '/produce/item/name')

Parmi les arguments figure la chaîne items contenant ce code XML :

"<?xml version="1.0"?> <produce> <item> <name>Gala</name> <type>apple</type> <count>20</count> </item> <item> <name>Honeycrisp</name> <type>apple</type> <count>10</count> </item> </produce>"

Le tableau retourné comporte les nœuds qui correspondent à <name></name> :

[ <name>Gala</name>, <name>Honeycrisp</name> ]

Exemple 2

Dans cet exemple, qui s’appuie sur l’exemple 1, les nœuds qui correspondent au nœud <count></count> sont recherchés et ces valeurs de nœud sont ajoutées avec la fonction sum() :

xPath(xml(parameters('items')), 'sum(/produce/item/count)')

Le résultat retourné est 30.

year

Retourne l’année du timestamp spécifié.

year('<timestamp>')

Paramètre	Obligatoire	Type	Description
<timestamp>	Oui	string	Chaîne qui contient l’horodatage

Valeur retournée	Type	Description
<year>	entier	Année du timestamp spécifié

Exemple

Dans cet exemple, le timestamp de l’année est évalué :

year('2018-03-15T00:00:00.000Z')

Le résultat retourné est 2018.