Skip to main content

@wildix/wim-tools-client > DescribeToolsCommand

DescribeToolsCommand class​

Describe multiple tools by their IDs.

Signature:

export declare class DescribeToolsCommand extends DescribeToolsCommand_base

Extends: DescribeToolsCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { ToolsClient, DescribeToolsCommand } from "@wildix/wim-tools-client"; // ES Modules import
// const { ToolsClient, DescribeToolsCommand } = require("@wildix/wim-tools-client"); // CommonJS import
const client = new ToolsClient(config);
const input = { // DescribeToolsInput
  companyId: "STRING_VALUE",
  ids: [ // ToolIdList // required
    "STRING_VALUE",
  ],
};
const command = new DescribeToolsCommand(input);
const response = await client.send(command);
// { // DescribeToolsOutput
//   descriptions: [ // ToolDescriptionList // required
//     { // ToolDescription
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE", // required
//       variables: [ // ToolVariableList // required
//         { // ToolVariable
//           name: "STRING_VALUE", // required
//           type: "string" || "number" || "boolean" || "string_array" || "number_array" || "schema", // required
//           optional: true || false, // required
//           description: "STRING_VALUE",
//           schema: "DOCUMENT_VALUE",
//         },
//       ],
//     },
//   ],
// };