Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OperationBulkService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • Parameters

    Returns Object

    Response wrapped in IResult

    Example

    
     const mandantoryObject: Partial<IOperationBulk> = {
       creationRamp: 15,
       groupId: '149044',
       operationPrototype: {
         c8y_Restart: {},
         description: 'Restart device',
         deviceId: device.id,
         status: 'PENDING'
       },
        startDate: '2018-02-15T16:01:00.000Z'
     };
    
     (async () => {
       const {data, res} = await operationBulkService.create(mandantoryObject);
     })();
    

delete

  • Parameters

    Returns Promise<IResult<null>>

    Response wrapped in IResult

detail

  • detail(operationOrId: string | number | IIdentified): Object
  • Parameters

    Returns Object

    Response wrapped in IResult

    Example

    
       const bulkOperationId: number = 1;
    
       (async () => {
         const {data, res} = await operationBulkService.detail(bulkOperationId);
      })();
    

list

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

    • Default value filter: object = {}

    Returns Object

    Response wrapped in IResultList

update

  • Parameters

    Returns Object

    Response wrapped in IResult

    Example

    
     const updateObject: Partial<IOperationBulk> = {
       creationRamp: 15,
       groupId: '149044',
       operationPrototype: {
         c8y_Restart: {},
         description: 'Restart device',
         deviceId: device.id,
         status: 'PENDING'
       },
        startDate: '2018-02-15T16:01:00.000Z'
     };
    
     (async () => {
       const {data, res} = await operationBulkService.update(updateObject);
     })();
    

Generated using TypeDoc