Skip to main content

@wildix/wim-cache-client > GetEntitiesByIdsCommand

GetEntitiesByIdsCommand class​

Allows to retrieve entities by id, use only in backend integrations

Signature:

export declare class GetEntitiesByIdsCommand extends GetEntitiesByIdsCommand_base

Extends: GetEntitiesByIdsCommand_base

Example​

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

import { WimCacheClient, GetEntitiesByIdsCommand } from "@wildix/wim-cache-client"; // ES Modules import
// const { WimCacheClient, GetEntitiesByIdsCommand } = require("@wildix/wim-cache-client"); // CommonJS import
const client = new WimCacheClient(config);
const input = { // GetEntitiesByIdsInput
  organizationId: "STRING_VALUE",
  entityIds: [ // EntityIds // required
    "STRING_VALUE",
  ],
};
const command = new GetEntitiesByIdsCommand(input);
const response = await client.send(command);
// { // GetEntitiesByIdsOutput
//   items: [ // EntityList
//     { // Entity
//       integrationId: "STRING_VALUE", // required
//       entityType: "STRING_VALUE", // required
//       data: { // EntityData
//         Id: "STRING_VALUE",
//         Name: "STRING_VALUE",
//         FirstName: "STRING_VALUE",
//         LastName: "STRING_VALUE",
//         Phone: "STRING_VALUE",
//         Email: "STRING_VALUE",
//         OwnerId: "STRING_VALUE",
//         MobilePhone: "STRING_VALUE",
//         AccountId: "STRING_VALUE",
//         Company: "STRING_VALUE",
//         IsConverted: true || false,
//         LastModifiedDate: "STRING_VALUE",
//         CompanyName: "STRING_VALUE",
//         IsActive: true || false,
//         TimeZoneSidKey: "STRING_VALUE",
//         Extension: "STRING_VALUE",
//         attributes: { // SalesforceAttrubuteField
//           url: "STRING_VALUE",
//           type: "STRING_VALUE",
//         },
//         CallPhone: "STRING_VALUE",
//         Archived: true || false,
//         Domain: "STRING_VALUE",
//         UpdatedAt: "STRING_VALUE",
//         Avatar: "STRING_VALUE",
//         CustomData: { // GeneralDataMap
//           "<keys>": "STRING_VALUE",
//         },
//       },
//       integrationOrder: Number("int"),
//     },
//   ],
// };