Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #38

Open
wants to merge 2 commits into
base: revitalize
Choose a base branch
from
Open

Update README.md #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85b8781
Update README.md
A3a3e1 Jan 23, 2024
1338bbd
Apply suggestions from code review
A3a3e1 Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 59 additions & 61 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Table of Contents

* [Description](#description)
* [Environment variables](#environment-variables)
* [Environment Variables](#environment-variables)
* [Credentials](#credentials)
* [Actions](#actions)
* [Make Raw Request](#make-raw-request)
Expand All @@ -18,196 +18,194 @@

## Description

[elastic.io](http://www.elastic.io) iPaaS component that connects to [ API]().
The component is an iPaaS component that connects to the API. This component has been tested on API v1.

The current release of the component tested on API `v1`.

## Environment variables
## Environment Variables
| Name | Mandatory | Description | Values |
|-----------------------|-----------|------------------------------------------------------------------------------|-----------------------|
| `API_RETRIES_COUNT` | false | Set how many time system try to make request to API on errors (3 by default) | any `integer` above 0 |
| `API_RETRY_DELAY` | false | Delay between retry attempts in milliseconds (10000 by default) | any `integer` above 0 |
| `API_REQUEST_TIMEOUT` | false | HTTP requests timeout in milliseconds (15000 by default) | any `integer` above 0 |
| `API_RETRIES_COUNT` | false | Sets how many times the system tries to make a request to the API on errors. The default value is 3. | any `integer` above 0 |
| `API_RETRY_DELAY` | false | The delay between retry attempts in milliseconds. The default value is 10000. | any `integer` above 0 |
| `API_REQUEST_TIMEOUT` | false | The timeout for HTTP requests in milliseconds. The default value is 15000. | any `integer` above 0 |

## Credentials

Component credentials configuration fields:
* **API Base URI** (string, required) - Indicates what URL base needs to be used.
The component requires the following credentials to be configured:
* **API Base URI** (string, required) - Indicates the URL base that needs to be used.
* **Username** (string, required)
* **Password** (string, required)

## Actions

### Make Raw Request

Executes custom requests utilizing plain REST API
This action allows you to execute custom requests using the plain REST API.

#### Configuration Fields

* **Don't throw error on 404 Response** - (optional, boolean): Treat 404 HTTP responses not as an error, defaults to `false`.
* **Don't throw error on 404 Response** - (optional, boolean): When enabled, treats 404 HTTP responses as non-errors. The default value is `false`.

#### Input Metadata

* **Url** - (string, required): Path of the resource relative to the base URL (here comes a part of the path that goes after `https://example.com/v1/`)
* **Method** - (string, required): HTTP verb to use in the request, one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
* **Request Body** - (object, optional): Body of the request to send.
* **Url** - (string, required): The path of the resource relative to the base URL (the part that comes after `https://example.com/v1/`).
* **Method** - (string, required): The HTTP verb to use in the request. Valid options are `GET`, `POST`, `PUT`, `PATCH`, `DELETE`.
* **Request Body** - (object, optional): The body of the request to send.

#### Output Metadata

* **Status Code** - (number, required): HTTP status code of the response.
* **HTTP headers** - (object, required): HTTP headers of the response.
* **Response Body** - (object, optional): HTTP response body.
* **Status Code** - (number, required): The HTTP status code of the response.
* **HTTP Headers** - (object, required): The HTTP headers of the response.
* **Response Body** - (object, optional): The body of the HTTP response.

### Upsert Object

Updates (if record found) or creates a new object.
This action updates an existing object if it is found, or creates a new object if it does not exist.

#### Configuration Fields

* **Object Type** - (dropdown, required): Object-type to upsert. Currently, supported types are:
* **Object Type** - (dropdown, required): The type of object to upsert. Currently, supported types include:
* Products
* Users

#### Input Metadata

* **ID** - (string, optional): ID of the object to upsert.
And dynamically generated fields according to the chosen `Object Type`.
* **ID** - (string, optional): The ID of the object to upsert.
and other dynamically-generated fields based on the chosen `Object Type`.

#### Output Metadata

Result object from an upsert.
The result object from the upsert action.

### Delete Object

Lookup a single object by a selected field that uniquely identifies it and delete it
This action looks up a single object using a selected field that uniquely identifies it, and then deletes it.

#### Configuration Fields

* **Object Type** - (string, required): Object-type to delete. Currently, supported types are:
* **Object Type** - (string, required): The type of object to delete. Currently, supported types include:
* Products
* Users
* **Lookup Criteria** - (dropdown, required): A list of object parameters that can uniquely identify the object in the database.

#### Input Metadata

* **Lookup Criteria Value** - (string, required): Value for unique search criteria in `Lookup Criteria` configuration field.
* **Lookup Criteria Value** - (string, required): The value for the unique search criteria specified in the `Lookup Criteria` configuration field.

#### Output Metadata

Object with the result of deletion as value.
An object with the result of the deletion.

### Lookup Objects (plural)

Lookup a set of objects by defined criteria.
This action looks up a set of objects based on defined criteria.

#### Configuration Fields

* **Object Type** - (dropdown, required): Object-type to lookup on. Currently, supported types are:
* **Object Type** - (dropdown, required): The type of object to lookup. Currently, supported types include:
* Products
* Users
* **Emit Behavior** - (dropdown, required): Defines the way resulting objects will be emitted, one of `Emit all`, `Emit page` or `Emit individually`.
* **Number of search terms** - (number, optional): Specify a number of search terms (positive integer number [1-99] or 0).
* **Emit Behavior** - (dropdown, required): Defines how the resulting objects will be emitted. Valid options include `Emit all`, `Emit page`, or `Emit individually`.
* **Number of search terms** - (number, optional): The number of search terms to specify. Valid values are positive integers between 1 and 99, or 0.

#### Input Metadata

Depending on the configuration field `Number of search terms`.
The input metadata depends on the value of the configuration field `Number of search terms`.
* If `Number of search terms` is empty or equals `0`, additional fields will not be generated.
* If `Number of search terms = 1`, one search term will be added to the metadata.
* If `Number of search terms > 1`, the number of search terms equals to `Number of search terms` and the number of criteria links equals to `Number of search terms - 1`
* If `Number of search terms > 1`, the number of search terms will equal `Number of search terms`, and the number of criteria links will equal `Number of search terms - 1`.

Each search term has 3 fields:
* **Field name** - Chosen object field name.
* **Condition** - Condition to apply on selected field
* **Field value** - Value for the selected field
* **Field Name** - The name of the object field to search on.
* **Condition** - The condition to apply to the selected field.
* **Field Value** - The value to use for the selected field.

links between conditions have one of the following values: `AND`, `OR` to combine several search terms
The links between conditions can have one of the following values: `AND`, `OR`, to combine several search terms.

#### Output Metadata

* For `Emit All` and `Emit Page` mode: An object, with key `results` that has an array as its value.
* For `Emit Individually` mode: Each object which fill the entire message.
* For `Emit All` and `Emit Page` modes: An object with a key `results` that contains an array of objects.
* For `Emit Individually` mode: Each object fills the entire message.

### Lookup Object (at most one)

Lookup a single object by a selected field that uniquely identifies it.
This action looks up a single object using a selected field that uniquely identifies it.

#### Configuration Fields

* **Object Type** - (dropdown, required): Object-type to upsert. Currently, supported types are:
* **Object Type** - (dropdown, required): The type of object to lookup. Currently, supported types include:
* Products
* Users
* **Lookup Criteria** - (dropdown, required): A unique field by which you want to lookup the object. Currently, supported types are:
* **Lookup Criteria** - (dropdown, required): A unique field by which you want to look up the object. Currently, supported types include:
* ID - for all object types
* Title - for `Products` only
* **Allow criteria to be omitted** - (boolean, optional): If selected, the field Lookup Criteria Value becomes optional.
* **Allow zero results** - (boolean, optional): When selected, if the object is not found - an empty object will be returned instead of throwing an error.
* **Allow criteria to be omitted** - (boolean, optional): When enabled, the field Lookup Criteria Value becomes optional.
* **Allow zero results** - (boolean, optional): When enabled, if the object is not found, an empty object will be returned instead of throwing an error.

#### Input Metadata

* **Lookup Criteria Value** - (string, required unless `Allow criteria to be omitted` is selected): Value for unique search criteria in `Lookup Criteria` configuration field.
* **Lookup Criteria Value** - (string, required unless `Allow criteria to be omitted` is enabled): The value for the unique search criteria specified in the `Lookup Criteria` configuration field.

#### Output Metadata

Result object depending on the object selected and the configuration setting `Allow Zero Result`.
The result object depends on the selected object and the configuration setting `Allow Zero Result`.

### Lookup Object By ID

Lookup a single object by its ID.
This action looks up a single object using its ID.

#### Configuration Fields

* **Object Type** - (string, required): Object-type to lookup on. Currently, supported types are:
* **Object Type** - (string, required): The type of object to lookup. Currently, supported types include:
* Products
* Users

#### Input Metadata

* **ID Value** - (string, required): Value for ID of the object to lookup.
* **ID Value** - (string, required): The value of the ID of the object to lookup.

#### Output Metadata

Object with the result of lookup as value.
An object with the result of the lookup.

### Delete Object By ID

Delete a single object by its ID.
This action deletes a single object using its ID.

#### Configuration Fields

* **Object Type** - (string, required): Object-type to lookup on. Currently, supported types are:
* **Object Type** - (string, required): The type of object to lookup. Currently, supported types include:
* Products
* Users

#### Input Metadata

* **ID Value** - (string, required): Value for ID of the object to delete.
* **ID Value** - (string, required): The value of the ID of the object to delete.

#### Output Metadata

Object with the result of delete.
An object with the result of the deletion.

## Triggers

### Get New and Updated Objects Polling

Retrieve all the updated or created objects within a given time range.
This trigger retrieves all the updated or created objects within a given time range.

#### Configuration Fields

* **Object Type** - (string, required): Object-type to lookup on. Currently, supported types are:
* **Object Type** - (string, required): The type of object to lookup. Currently, supported types include:
* Products
* Users
* **Start Time** - (string, optional): The timestamp to start polling from (inclusive) - using ISO 8601 Date time utc format - YYYY-MM-DDThh:mm:ssZ. The default value is the beginning of time (January 1, 1970 at 00:00).
* **End Time** - (string, optional): The timestamp to stop polling (exclusive) - using ISO 8601 Date time utc format - YYYY-MM-DDThh:mm:ssZ. The default value is flow execution time.
* **Timestamp field to poll on** - (string, optional): Can be either Last Modified or Created dates (updated or new objects, respectively). Defaults to Last Modified.
* **Start Time** - (string, optional): The timestamp to start polling from (inclusive), using the ISO 8601 Date time UTC format (YYYY-MM-DDThh:mm:ssZ). The default value is the beginning of time (January 1, 1970 at 00:00).
* **End Time** - (string, optional): The timestamp to stop polling (exclusive), using the ISO 8601 Date time UTC format (YYYY-MM-DDThh:mm:ssZ). The default value is the time of the flow execution.
* **Timestamp field to poll on** - (string, optional): Specifies whether to poll based on the Last Modified or Created dates (for updated or new objects, respectively). The default value is Last Modified.

#### Input Metadata

None.

#### Output Metadata
- For `Fetch page`: An object with key ***results*** that has an array as its value
- For `Emit Individually`: Each object fills the entire message
- For `Fetch page`: An object with a key ***results*** that contains an array of objects
- For `Emit Individually`: Each object fills the entire message

#### Limitations

Expand Down