Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserInventoryRoleService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • Parameters

    Returns Object

    Returns promise object that is resolved with the details of newly assigned inventory role.

    Example

    
     const inventoryRoleObject: IUserInventoryRole = {
       ...
     };
    
       (async () => {
         const {data, res} = await userInventoryRoleService.create(inventoryRoleObject);
      })();
    

delete

  • delete(entityOrId: string | number | IIdentified): Object
  • Parameters

    Returns Object

    Returns promise object that is resolved with the IResult.

    Example

    
       const inventoryRoleId: number = 1;
    
       (async () => {
         const {data, res} = await userInventoryRoleService.delete(inventoryRoleId);
      })();
    

detail

  • Parameters

    Returns Object

    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.

list

  • list(filter?: object): Object
  • Parameters

    • Default value filter: object = {}

    Returns Object

    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);
      })();
    

update

  • Parameters

    Returns Object

Generated using TypeDoc