Listar escenarios en Make, con una API

Lista los escenarios de un equipo o de una organización completa: envía teamId u organizationId, nunca ambos. Cada elemento trae el id y el name del escenario.

Identificador
make_list_scenarios

La llamada

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
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
teamIdintegerNoId of the team, from List teams. Do not send it together with organizationId.
organizationIdintegerNoId of the organization, from List organizations, to list the scenarios of all its teams. Do not send it together with teamId.
searchstringNoCase-insensitive text matched against the scenario names. A number also matches the scenario with that id.
isActivebooleanNoSet to true to return only active scenarios.
isinvalidbooleanNoSet to true to return only scenarios whose blueprint failed validation, or false for the valid ones.

Conexiones posibles

Tu cliente conecta su cuenta de Make una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

Al conectar, tu cliente también indica {zone}: la dirección de su cuenta en la API de la app.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/make_list_scenarios. Se convierte en la definición de tool de tu agente sin conversión.

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.