Cumulocity Web SDK - v1021.62.8
    Preparing search index...

    Class UserInventoryRoleService

    This service allows for managing current user's inventory roles.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Unassign inventory role from current user

      Parameters

      • entityOrId: string | number | IIdentified

        Inventory Role id or Inventory Role object.

      Returns Promise<IResult<null>>

      Returns promise object that is resolved with the IResult.

      Example


      const inventoryRoleId: number = 1;

      (async () => {
      const {data, res} = await userInventoryRoleService.delete(inventoryRoleId);
      })();
    • Get a representation of a concrete current user's inventory role.

      Parameters

      • entityOrId: string | number | IUserInventoryRole

        inventory role id or inventory role object.

      Returns Promise<IResult<IUserInventoryRole>>

      Returns promise object that is resolved with the IUserInventoryRole wrapped by IResult.

      Example


      const inventoryRoleId: number = 1;

      (async () => {
      const {data, res} = await userInventoryRoleService.detail(inventoryRoleId);
      })();

      Required role: ROLE_TENANT_MANAGEMENT_READ

      User password is never returned in GET response. Authentication mechanism is provided by another interface.

    • Gets the list the inventory roles applied to a current user.

      Parameters

      • filter: object = {}

        Object containing filters for querying inventory roles.

      Returns Promise<IResultList<IUserInventoryRole>>

      Returns promise object that is resolved with the IUserInventoryRole wrapped by IResultList.

      Example


      const filter: object = {
      severity: Severity.MAJOR,
      pageSize: 100,
      withTotalPages: true
      };

      (async () => {
      const {data, res, paging} = await userInventoryRoleService.list(filter);
      })();