Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

Filtres dans un corps de demande API

  • Mis à jour le : 9/21/2020
    • Automation 360 v.x
    • Gestion
    • Espace de travail RPA
    • Docs API

Filtres dans un corps de demande API

Le filtrage donne accès à des requêtes conditionnelles de base et une commande de page pour le traitement des demandes API. Il existe trois composants de base liés au filtrage : paramètres de filtrage, tri et pagination.

Voici une représentation de la structure de filtrage JSON utilisée dans les Automation Anywhere API.
{
  "filter": {
    "operator": "NONE",
    "operands": [
      null
    ],
    "field": "string",
    "value": "string"
  },
  "sort": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "page": {
    "offset": 0,
    "length": 0
  }
}
La partie la plus basique de cet objet JSON est le tableau de filtre.

Présentation des filtres

Filtre de base
Les filtres peuvent être utilisés pour rechercher une condition unique ou ils peuvent être encapsulés dans les opérandes logiques ET et OU. Le filtrage peut être une simple évaluation conditionnelle d’un seul champ. L’opérateur, le champ et la valeur utilisés dans un filtre sont spécifiques à l’API dans laquelle ils sont utilisés.
Remarque : Les valeurs entre crochets < > incluent une liste de toutes les valeurs potentielles. Il ne doit y avoir qu’une seule valeur pour chaque paramètre.
Filtre à paramètre unique
{
  "filter": {
    "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
    "field": "string",
    "value": "string"
  }
}
Filtre à deux paramètres
{
  "filter": {
    "operator": "<and, or>",
    "operands": [
      {
        "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
        "field": "string",
        "value": "string"
      },
      {
        "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
        "field": "string",
        "value": "string"
      }
    ]
  }
}
Page
"page":{ 
    "offset":0,
    "length":0
}
Paramètres des règles de pagination
  • Décalage :

    Type : entier

    Valeur numérique indiquant le nombre de lignes d’un tableau que le filtre commence à examiner.

  • Longueur

    Type : entier

    Nombre de lignes listées dans une seule page de résultats.

Trier
 "sort": [
    {
      "field": "string",
      "direction": "<asc, desc>"
    }
  • Champ : Le champ par lequel vous voulez que les résultats soient filtrés. Il doit s’agir d’un champ filtrable pris en charge. Les champs filtrables varient en fonction de l’API.
  • Sens

    Taper : Énumération [ desc, asc ]

    • asc = croissant (du plus petit au plus grand, 0 à 9, A à Z)
    • desc = décroissant (du plus grand au plus petit, 9 à 0, Z à A)

Exemples de filtre d’API

Exemple de filtre de gestion des utilisateurs
Cet exemple de filtre est basé sur les champs et paramètres de l’API de gestion des utilisateurs. Ce filtre recherche le nom de connexion de l'utilisateur, le nom d’utilisateur et le nom réel de l’utilisateur, le prénom.
Exemple de filtre de gestion de référentiel
Cet exemple de filtre est basé sur les champs et paramètres de l’API de gestion du référentiel. Cet exemple de filtre recherche robot l’état et le nom.
exemple de filtre de résultats de liste de migration
Cet exemple de filtre est basé sur les champs et les paramètres de l’API de migration. Ce filtre recherche les migrations qui contiennent une chaîne spécifique dans le nom et qui ont été démarrées, updatedOn, entre deux dates.
Envoyer le commentaire