Lister les scénarios avec l'API Make

Liste les scénarios d'une équipe ou de toute une organisation : envoyez teamId ou organizationId, jamais les deux. Chaque élément contient l'id et le name du scénario.

Identifiant
make_list_scenarios

L'appel

POST https://connect.reportei.com/api/tools/make_list_scenarios/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "teamId": 1
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
teamIdintegerNonId of the team, from List teams. Do not send it together with organizationId.
organizationIdintegerNonId of the organization, from List organizations, to list the scenarios of all its teams. Do not send it together with teamId.
searchstringNonCase-insensitive text matched against the scenario names. A number also matches the scenario with that id.
isActivebooleanNonSet to true to return only active scenarios.
isinvalidbooleanNonSet to true to return only scenarios whose blueprint failed validation, or false for the valid ones.

Connexions possibles

Votre client connecte son compte Make une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

À la connexion, votre client indique aussi {zone} : l'adresse de son compte sur l'API de l'app.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/make_list_scenarios. Il devient la définition de tool de votre agent sans conversion.

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.