Nous vous recommandons vivement de consulter la Politique de Support pour l'API Cato avant de commencer à utiliser l'API Cato.

Vue d'ensemble de RechercheEntité

La requête RechercheEntité fonctionne avec les entités de l'Application de Gestion Cato telles que les sites et les utilisateurs VPN. La requête peut vous aider à rechercher un nom d'entité pour retourner l'ID spécifique et extraire automatiquement une liste d'entités dans le compte. Chaque entité est retournée avec des informations supplémentaires pertinentes, telles que la date de création et la description.

Pour les comptes de revendeurs, vous pouvez créer des clés API séparées dans chaque compte client que vous connectez à l'API Cato. Pour plus d'informations sur la limitation de débit et la requête API RechercheEntité, voir Comprendre la Limitation de Débit de l'API Cato.

Détails des Champs de RechercheEntité

Voici les détails que les champs auditifs peuvent afficher pour la requête :

• éléments - le champ éléments contient les données pour chaque entité
• total - nombre total d'entités retournées pour cette requête

Éléments entityLookup

Les champs d'InfoEntité montrent les données pour chaque entité, y compris :

• entité - montre l'id, le nom de l'Application de Gestion Cato et le type d'entité, habituellement site ou utilisateurVPN
• description - description de l'entité de l'Application de Gestion Cato
• champsAides - informations supplémentaires pertinentes et données concernant l'entité

Total entityLookup

Le champ Total montre le nombre total d'entités pour votre compte dans l'Application de Gestion Cato. La valeur de ce champ ne change pas pendant la pagination du retour de l'API et peut vous aider à le comparer facilement au nombre total d'enregistrements récupérés.

Arguments pour RechercheEntité

Voici les arguments que vous pouvez passer et définir les entités qui sont retournées par la requête :

• IDs de compte - IDs de compte, pour plusieurs comptes, entrez les IDs comme un tableau (argument obligatoire)
• type - retourner les entités qui correspondent au type, par exemple le site ou utilisateurVPN (argument obligatoire)
• limite - nombre maximal d'entités retournées pour cette requête (valeur par défaut est 50)
• de - selon l'index des entrées, commencez la requête à partir de cette entité spécifique
• recherche - filtrez le retour selon cette valeur
• IDs d'entité - IDs d'entité, pour plusieurs entités, entrez les IDs comme un tableau
• tri - définit comment les entités que la requête retourne sont triées

Argument accountIDs entityLookup

Entrez un ou plusieurs IDs de compte pour les données que la requête retourne.

Cet ID de compte est affiché dans la page Administration > Infos Générales.

L'argument accountIDs est obligatoire pour la requête.

Argument type entityLookup

L'argument de type définit les données de l'entité que la requête retourne. Voici les valeurs prises en charge pour l'argument type : site, utilisateurVPN, et admins.

L'argument type est obligatoire pour la requête. Référez-vous au schéma pour les éléments enum pour chaque valeur.

Argument limite entityLookup

L'argument limite définit le nombre maximum d'entités que la requête retourne. Si vous ne spécifiez pas l'argument limite, alors la requête est limitée à 50 entités.

Chaque requête peut retourner un maximum de 1000 entités.

Argument from entityLookup

L'argument dès définit depuis quelle entité commencer la requête. Par exemple, si un compte a 100 utilisateurs VPN, définissez-le à 60 pour montrer uniquement les 40 dernières entités utilisateur VPN.

Le premier élément dans la requête est 0. Donc, si vous voulez seulement montrer à partir de l'élément 20, alors définissez-le à 19.

Argument recherche entityLookup

L'argument recherche filtre la requête pour ne retourner que les noms d'entités correspondants. L'argument recherche est une valeur de type chaîne.

Argument entityIDs entityLookup

L'argument IDsEntités ne retourne que les entités qui correspondent aux IDs.

Argument tri entityLookup

L'argument tri vous permet de trier les données selon l'id ou le nom des entités, dans l'ordre croissant ou décroissant.

• champ - utilisez nom ou id comme valeur du champ
• ordre - triez les résultats en ordre croissant (asc) ou décroissant (dsc)

Par exemple, pour trier les résultats en ordre croissant (a-z) selon le nom, utilisez cet argument : sort:{field"name", order:asc}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        items {
            entity {
                id
                name
            }
        }
    }
}

{
    "accountID": "26",
    "type": "site"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $search: String) {
    entityLookup (accountID: $accountID, type: $type, search: $search) {
        items {
            entity {
                id
                name
            }
        }
    }
}

{
    "accountID": "26",
    "type": "site",
    "search": "MySite"
}

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        items {
            entity {
                id
                name
                type
            }
            description
            helperFields
            }
        }
    }
}

{
    "accountID": "26",
    "type": "networkInterface",
    "parent": {
        "id": 52180,
        "type": "site"
    }
}