Subsections of connectorsFunctions
catalog
Subsections of catalog
Connector Functions
This is a base object that contains everything you can do with a connector function catalog entry.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | |
| identifier | String |
❌ | |
| connectorFunction | Object |
❌ |
addNorthCriteria(northCriteria)
Add northCriteria to parameter northCriterias. Each element is defined by path and value
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| northCriteria | Object |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
addSouthCriteria(southCriteria)
Add southCriteria to parameter southCriterias. Each string can represent an URI, topic, OID…
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| southCriteria | String |
❌ |
Retorna
Tip
Tipo: ``
create()
Create a new connector function catalog
Retorna
Tip
Tipo: Promise
withCloneable(cloneable)
Indicates whether or not the Connector Function is cloneable.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| cloneable | Boolean |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withDescription(description)
Description of the connector function. This field is optional.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| description | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withIdentifier(identifier)
Set the identifier
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withJavascript(javascript)
Connector function javascript code
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| javascript | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withName(name)
Descriptive and unique name
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withNorthCriterias(northCriterias)
Connector Function selection criteria for operation requests. This field is mandatory if Connector Function type is REQUEST. ⮕ [ each element is defined by path and value ]
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| northCriterias | Array |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withOperationalStatus(operationalStatus)
Connector Function status Allowed: DISABLED┃PRODUCTION┃TEST
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| operationalStatus | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withOperationName(operationName)
Used to filter connector functions by operation name. If Connector Function type is REQUEST, this field is mandatory and defined name must be an operation name available for specified Api Key. If the type is COLLECTION or RESPONSE, this field must be null.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| operationName | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withPayloadType(payloadType)
Enum of allowed types for connector function's payload data. Request Connector Functions only accept JSON. Allowed: TEXT┃JSON┃BINARY
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| payloadType | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withSouthCriterias(southCriterias)
Connector Function selection criteria for operation responses and data collection. This field is mandatory if Connector Function type is COLLECTION or RESPONSE. ⮕ [ each string can represent an URI, topic, OID… ]. Each string can represent an URI, topic, OID…
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| southCriterias | Array |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
withType(type)
Type of connector function, this is mandatory. Keep in mind that you will be not allowed to modify it. Allowed: COLLECTION┃REQUEST┃RESPONSE
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| type | String |
❌ |
Retorna
Tip
Tipo: ConnectorFunctionsCatalog
Connector Functions Catalog
This class allows you to make GET requests to the connector functions catalog resource in the OpenGate North API.
getConnectorFunctionsCatalog()
Get connector functions catalog
Retorna
Tip
Tipo: Promise
Connector Functions Catalog Finder
This class allows you to make GET requests to a connector functions catalog resource in the OpenGate North API.
findByConnectorFunctionsId(connectorFunctionId)
Reading a Connector Function from catalog
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| connectorFunctionId | String |
❌ |
Retorna
Tip
Tipo: Promise
configuration
Subsections of configuration
Connector Functions
This is a base object that contains everything you can do with ConnectorFunctions.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
create()
Create a new Connector Function
Retorna
Tip
Tipo: Promise
delete()
Deletes the selected connector function
Retorna
Tip
Tipo: Promise
update()
Updates a connector function
Retorna
Tip
Tipo: Promise
withChannel(channel)
Set the channel attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| channel | string |
❌ | required field |
Retorna
Tip
Tipo: ConnectorFunctions
withDescription(description)
Set the description attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| description | string |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
withIdentifier(identifier)
Set the identifier attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | string |
❌ | required field |
Retorna
Tip
Tipo: ConnectorFunctions
withJavascript(javascript)
Set the javascript attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| javascript | string |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
withName(name)
Set the name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ | required field |
Retorna
Tip
Tipo: ConnectorFunctions
withNorthCriterias(criterias)
Set the north criterias attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| criterias | array |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
withOperationalStatus(operationalStatus)
Set the operational status attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| operationalStatus | boolean |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
withOperationName(operationName)
Set the operation name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| operationName | string |
❌ | required field |
Retorna
Tip
Tipo: ConnectorFunctions
withOrganization(organization)
Set the organization attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | required field |
Retorna
Tip
Tipo: ConnectorFunctions
withPayloadType(payloadType)
Set the payload type attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| payloadType | string |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
withSouthCriterias(criterias)
Set the south criterias attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| criterias | array |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
withType(type)
Set the type attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| type | string |
❌ |
Retorna
Tip
Tipo: ConnectorFunctions
Connector Functions Finder
This class allows you to make GET requests to the ConnectorFunctions resource in the OpenGate North API.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
findByOrganizationAndChannel(organization, channel)
Performs a get that returns connectors functions related
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
| channel | string |
❌ | channel. |
Retorna
Tip
Tipo: Promise
findByOrganizationAndChannelAndName(organization, channel, name)
Performs a get that returns connectors functions related
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
| channel | string |
❌ | channel. |
| name | string |
❌ | Connector function name |
Retorna
Tip
Tipo: Promise
Connector Functions Helper
This class allows you to make GET requests to the ConnectorFunctionsHelper resource in the OpenGate North API.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
getDocJavascriptFunctions()
Performs a get that returns documentation of javascript functions from rules service
Retorna
Tip
Tipo: Promise
getDocPrivateJavascriptFunctions()
Performs a get that returns documentation private of javascript functions from rules service
Retorna
Tip
Tipo: Promise