Skip to main content

@wildix/wim-knowledge-base-client > DescribeDataSourceCommand

DescribeDataSourceCommand class​

Describe the data source by its ID. It will return additional information about the data source based on the parameters provided.

Signature:

export declare class DescribeDataSourceCommand extends DescribeDataSourceCommand_base

Extends: DescribeDataSourceCommand_base

Example​

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

import { KnowledgeBaseClient, DescribeDataSourceCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
// const { KnowledgeBaseClient, DescribeDataSourceCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
const client = new KnowledgeBaseClient(config);
const input = { // DescribeDataSourceInput
  companyId: "STRING_VALUE",
  dataSourceId: "STRING_VALUE", // required
  parameters: { // DescribeDataSourceParameters
    confluence: { // DescribeDataSourceConfluenceParameters
      spaces: { // DescribeDataSourceConfluenceSpacesParameters
        type: "global" || "collaboration" || "knowledge_base" || "personal" || "system" || "onboarding",
      },
      pages: { // DescribeDataSourceConfluencePagesParameters
        spaceId: "STRING_VALUE", // required
        parentId: "STRING_VALUE",
        enabled: [ // StringList
          "STRING_VALUE",
        ],
      },
    },
    gdrive: { // DescribeDataSourceGDriveParameters
      session: { // DescribeDataSourceGDriveSessionParameters
        userId: "STRING_VALUE", // required
      },
      folders: { // DescribeDataSourceGDriveFoldersParameters
        parentId: "STRING_VALUE", // required
        enabled: [
          "STRING_VALUE",
        ],
      },
    },
    proxy: "DOCUMENT_VALUE",
    files: "DOCUMENT_VALUE",
  },
};
const command = new DescribeDataSourceCommand(input);
const response = await client.send(command);
// { // DescribeDataSourceOutput
//   result: { // DescribeDataSourceResult
//     confluence: { // DescribeDataSourceConfluenceResult
//       spaces: [ // DescribeDataSourceConfluenceSpacesList
//         { // DescribeDataSourceConfluenceSpaceResult
//           id: "STRING_VALUE", // required
//           name: "STRING_VALUE", // required
//           key: "STRING_VALUE",
//           type: "global" || "collaboration" || "knowledge_base" || "personal" || "system" || "onboarding", // required
//         },
//       ],
//       pages: [ // DescribeDataSourceConfluencePagesList
//         { // DescribeDataSourceConfluencePageResult
//           id: "STRING_VALUE", // required
//           parentId: "STRING_VALUE", // required
//           title: "STRING_VALUE", // required
//           position: Number("int"),
//         },
//       ],
//     },
//     gdrive: { // DescribeDataSourceGDriveResult
//       sessionId: "STRING_VALUE",
//       folders: [ // DescribeDataSourceGDriveFoldersList
//         { // DescribeDataSourceGDriveFolderResult
//           id: "STRING_VALUE", // required
//           parentId: "STRING_VALUE", // required
//           name: "STRING_VALUE", // required
//         },
//       ],
//     },
//     proxy: "DOCUMENT_VALUE",
//     files: "DOCUMENT_VALUE",
//   },
// };