Subsections of operationTypes

Operation Type

This is a base object that contains all you can do about OperationType.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI to the API object.

applicableTo(applicableTo)

Allows the modification of the applicableTo

Parámetros

Nombre Tipo Opcional Descripción
applicableTo array

Retorna

Tip

Tipo: OperationType


create()

Create a new Rule

Retorna

Tip

Tipo: Promise


delete()

Deletes the selected RuleConfiguration

Retorna

Tip

Tipo: Promise


fromCatalog(fromCatalog)

Set the catalog

Parámetros

Nombre Tipo Opcional Descripción
fromCatalog string

Retorna

Tip

Tipo: OperationType


update()

Udpate a Rule

Retorna

Tip

Tipo: Promise


withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string

Retorna

Tip

Tipo: OperationType


withIdentifier(name)

Set the name for update attribute

Parámetros

Nombre Tipo Opcional Descripción
name string required field

Retorna

Tip

Tipo: OperationType


withModels(models)

Allows the modification of the allowed models

Parámetros

Nombre Tipo Opcional Descripción
models array

Retorna

Tip

Tipo: OperationType


withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string required field

Retorna

Tip

Tipo: OperationType


withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string required field

Retorna

Tip

Tipo: OperationType


withParameters(parameters)

Allows the modification of the parameters

Parámetros

Nombre Tipo Opcional Descripción
parameters array

Retorna

Tip

Tipo: OperationType


withProfiles(profiles)

Allows the modification of the profiles allowed

Parámetros

Nombre Tipo Opcional Descripción
profiles array

Retorna

Tip

Tipo: OperationType


withSteps(steps)

Allows the modification of the steps

Parámetros

Nombre Tipo Opcional Descripción
steps array

Retorna

Tip

Tipo: OperationType


withTitle(title)

Set the title attribute

Parámetros

Nombre Tipo Opcional Descripción
title string required field

Retorna

Tip

Tipo: OperationType


Operation Type Finder

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

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI Reference to the API object.

findByOrganizationAndName(organization, name)

Performs a get that returns operation type

Parámetros

Nombre Tipo Opcional Descripción
organization string organization
name string Rule Configuration name

Retorna

Tip

Tipo: Promise


Operation Types Catalog

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

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI Reference to the API object.

getOperationTypes()

Performs a get that returns operation types templates

Retorna

Tip

Tipo: Promise