component.json

{
  "title": "REST API",
  "version": "1.2.20",
  "description": "A generic connector for accessing HTTP and REST APIs .",
  "buildType": "docker",
  "deprecated": true,
  "docsUrl": "https://github.com/elasticio/rest-api-component",
  "credentials": {
    "fields": {
      "auth": {
        "required": false,
        "viewClass": "HTTPAuthView"
      }
    },
    "oauth2" : {
      "client_id" : "{{clientId}}",
      "client_secret" : "{{clientSecret}}",
      "auth_uri" : "{{authUri}}",
      "token_uri" : "{{tokenUri}}"
    }
  },
  "triggers": {
    "httpRequestTrigger": {
      "main": "./lib/triggers/httpRequestTrigger.js",
      "title": "HTTP request",
      "help": {
        "description": "Will send a GET/POST/PUT/DELETE HTTP request and parse the response back to the flow",
        "link": "/components/rest-api/index.html#http-request"
      },
      "type": "polling",
      "metadata": {
        "out": {}
      },
      "fields": {
        "reader": {
          "label": "REST API",
          "required": true,
          "viewClass": "RESTAPIView"
        },
        "dontThrowErrorFlg": {
          "label": "Don`t throw Error on Failed Calls",
          "viewClass": "CheckBoxView"
        },
        "splitResult": {
          "label": "Split Result if it is an Array",
          "viewClass": "CheckBoxView",
          "note": "After making the request, and applying the above JSONata expression, if the result is an array and this box is checked, we will emit one message for each element of the array."
        },
        "enableRebound": {
          "label": "Retry on failure",
          "viewClass": "CheckBoxView"
        },
        "noStrictSSL": {
          "label": "Do not verify SSL certificate (unsafe)",
          "viewClass": "CheckBoxView"
        },
        "followRedirect": {
          "label": "Follow redirect mode",
          "viewClass": "SelectView",
          "model": {
            "followRedirects": "Follow redirects",
            "doNotFollowRedirects": "Do not follow redirects"
          },
          "prompt": "Follow redirects (default)"
        },
        "delay": {
          "label": "Delay",
          "viewClass": "TextFieldView",
          "note": "Delay calling the next request after the previous request. Time for the delay is calculated as `Delay`/ `Call Count` and shouldn't be more than 1140 seconds (19 minutes due to platform limitation). The `Call Count` value by default is 1. If you want to use another value, please set the `Call Count` field. "
        },
        "callCount": {
          "label": "Call Count",
          "viewClass": "TextFieldView",
          "note": "Value should be set only in pair with `Delay`, defaults to 1"
        },
        "requestTimeoutPeriod": {
          "label": "Request timeout",
          "viewClass": "TextFieldView",
          "note": "Timeout period in milliseconds while component waiting for server response, should be positive integer (1-1140000), defaults to 100000 (100 sec)"
        }
      }
    }
  },
  "actions": {
    "httpRequestAction": {
      "main": "./lib/actions/httpRequestAction.js",
      "title": "HTTP request",
      "help": {
        "description": "Will send a GET/POST/PUT/DELETE HTTP request and parse the response back to the flow",
        "link": "/components/rest-api/index.html#http-request-1"
      },
      "metadata": {
        "out": {}
      },
      "fields": {
        "reader": {
          "label": "REST API",
          "required": true,
          "viewClass": "RESTAPIView"
        },
        "dontThrowErrorFlg": {
          "label": "Don`t throw Error on Failed Calls",
          "viewClass": "CheckBoxView"
        },
        "splitResult": {
          "label": "Split Result if it is an Array",
          "viewClass": "CheckBoxView",
          "note": "After making the request, and applying the above JSONata expression, if the result is an array and this box is checked, we will emit one message for each element of the array."
        },
        "enableRebound": {
          "label": "Retry on failure",
          "viewClass": "CheckBoxView"
        },
        "noStrictSSL": {
          "label": "Do not verify SSL certificate (unsafe)",
          "viewClass": "CheckBoxView",
          "note": "Unsafe option! Check it if you want to disable SSL certificate verification on the server"
        },
        "followRedirect": {
          "label": "Follow redirect mode",
          "viewClass": "SelectView",
          "model": {
            "followRedirects": "Follow redirects",
            "doNotFollowRedirects": "Do not follow redirects"
          },
          "prompt": "Follow redirects (default)"
        },
        "delay": {
          "label": "Delay",
          "viewClass": "TextFieldView",
          "note": "Delay calling the next request after the previous request. Time for the delay is calculated as `Delay`/ `Call Count` and shouldn't be more than 1140 seconds (19 minutes due to platform limitation). The `Call Count` value by default is 1. If you want to use another value, please set the `Call Count` field. "
        },
        "callCount": {
          "label": "Call Count",
          "viewClass": "TextFieldView",
          "note": "Value should be set only in pair with `Delay`, defaults to 1"
        },
        "requestTimeoutPeriod": {
          "label": "Request timeout",
          "viewClass": "TextFieldView",
          "note": "Timeout period in milliseconds while component waiting for server response, should be positive integer (1-1140000), defaults to 100000 (100 sec)"
        }
      }
    }
  }
}