Nous recommandons fortement qu'avant de commencer à utiliser l'API Cato, vous revoyiez la Politique de Support pour l'API Cato.

Vue d'ensemble de entityLookup

La requête entityLookup 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 le nom d'une 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 revendeurs, vous pouvez créer des clés API distinctes à l'intérieur de chaque compte client auquel vous vous connectez via l'API Cato. Pour plus d'informations sur la limitation de taux et la requête de l'API entityLookup, voir Comprendre la Limitation de Taux de l'API Cato.

Détails des Champs de entityLookup

Voici les détails que les champs auditFeed peuvent montrer pour la requête :

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

Articles entityLookup

Les champs EntityInfo affichent les données pour chaque entité, y compris :

• entity - affiche l'ID, le Nom de l'Application de gestion Cato, et le Type d'entité généralement site ou utilisateurVPN
• description - description de l'entité de l'Application de gestion Cato
• helperFields - informations et données supplémentaires pertinentes sur l'entité

Total de 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 à la comparer facilement au nombre total de dossiers récupérés.

Arguments pour entityLookup

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

• accountIDs - IDs de compte, pour plusieurs comptes, entrez les IDs en tant que tableau (argument obligatoire)
• type - retourner les entités qui correspondent au type, par exemple le site ou utilisateurVPN (argument obligatoire)
• limit - nombre maximum d'entités retournées pour cette requête (la valeur par défaut est 50)
• from - selon l'index des entrées, démarrez la requête à partir de cette entité spécifique
• search - filtrer le retour selon cette valeur
• entityIDs - IDs d'entité, pour plusieurs entités, entrez les IDs en tant que tableau
• sort - définit comment les entités que la requête retourne sont triées

Argument accountIDs de 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 > Informations générales.

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

Argument type de entityLookup

L'argument 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. Consultez le schéma pour les éléments enum pour chaque valeur.

Argument limit de entityLookup

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

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

Argument from de entityLookup

L'argument from définit à partir de quelle entité la requête commence. Par exemple, si un compte a 100 utilisateurs VPN, réglez-le à 60 pour n'afficher que les 40 derniers entités utilisateur VPN.

Le premier élément de la requête est 0. Ainsi, si vous souhaitez n'afficher qu'à partir de l'élément 20, réglez-le à 19.

Argument search de entityLookup

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

Argument entityIDs de entityLookup

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

Argument sort de entityLookup

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

• field - utilisez nom ou ID comme valeur de champ
• order - triez les résultats dans l'ordre croissant (asc) ou décroissant (dsc)

Par exemple, pour trier les résultats par ordre croissant (a-z) selon le nom, utilisez cet argument : sort:{field"nom", 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": "interfaceRéseau",
    "parent": {
        "id": 52180,
        "type": "site"
    }
}