Operation Finder

OperationFinder

OperationFinder Objects

class OperationFinder()

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

constructor
function constructor()

Constructor

Arguments:

  • ogapi InternalOpenGateAPI - Reference to the API object.
findById
function findById(id: string) -> 'Promise'

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

Arguments:

  • id string - Operation id.

Returns:

  • Promise

Example:

  ogapi.newOperationFinder().findById('xxx-xx-xxx-xxx').then().catch();
findExecutionsById
function findExecutionsById(id: string,size: number,start: number) -> 'Promise'

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

Arguments:

  • id string - Operation id.
  • size number - Defined the number of elements on response
  • start number (optional) - Defined the offset on response

Returns:

  • Promise
findPeriodicityById
function findPeriodicityById(id: string) -> 'Promise'

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

Arguments:

  • id string - Operation id.

Returns:

  • Promise

Example:

  ogapi.newOperationFinder().findPeriodicityById('xxx-xx-xxx-xxx').then().catch();
findPeriodicityByPeriodicityId
function findPeriodicityByPeriodicityId(periodicityId: string) -> 'Promise'

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

Arguments:

  • periodicityId string - Periodicity id.

Returns:

  • Promise

Example:

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