import OperationFinder from 'opengate-js/src/operations/OperationFinder.js'

public class | source

OperationFinder

GenericFinder → OperationFinder

This class allow make get request to operation resource into Opengate North API.

Constructor Summary

Public Constructor
public	constructor(ogapi: InternalOpenGateAPI) Constructor

Public Methods
public	findById(id: string): Promise Download a specific operation by its id.
public	findExecutionsById(id: string, size: number, start: number): Promise Download a specific executions of an operation by its id.
public	findPeriodicityById(id: string): Promise Download information of peridodicitiy of a specific operation by its id.
public	findPeriodicityByPeriodicityId(periodicityId: string): Promise Download information of periodicitiy by its id.

Constructor

Name	Type	Attribute	Description
ogapi	InternalOpenGateAPI		Reference to the API object.

Download a specific operation by its id. This execute a GET http method

Name	Type	Attribute	Description
id	string		Operation id.

  ogapi.newOperationFinder().findById('xxx-xx-xxx-xxx').then().catch();

Download a specific executions of an operation by its id. This execute a GET http method

Name	Type	Attribute	Description
id	string		Operation id.
size	number		Defined the number of elements on response
start	number	optional default: 0	Defined the offset on response

Download information of peridodicitiy of a specific operation by its id. This execute a GET http method

Name	Type	Attribute	Description
id	string		Operation id.

  ogapi.newOperationFinder().findPeriodicityById('xxx-xx-xxx-xxx').then().catch();

Download information of periodicitiy by its id. This execute a GET http method

Name	Type	Attribute	Description
periodicityId	string		Periodicity id.

  ogapi.newOperationFinder().findPeriodicityByPeriodicityId('xxx-xx-xxx-xxx').then().catch();