{ "openapi": "3.0.0", "info": { "version": "v2", "title": "Cenit IO - API", "termsOfService": "https://cenit.io/terms", "contact": { "email": "support@cenit.io", "url": "https://cenitio.slack.com/messages/support" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "description": "# Introduction\n\nCenitIO is an opensource integration platform (iPaaS) for data and business integrations. It is designe to solve\nunique integrations needs, with a robust engine that is able to receive, transform and deliver data in multiple\nformats and protocols. Ready to use in our cloud or on-premises\n\nThe CenitIO APIv2 is a simple connector API for doing business and data integrations.\n\nThis API is for individual retailers, SaaS services, or any business that needs to handle multiple integrations.\n\n* It is built over REST services on HTTPS.\n\n* It has predictable resource URLs.\n\n* It returns HTTP response codes to indicate errors.\n\n* It accepts and returns JSON in the HTTP body.\n\n* You can use your favorite HTTP/REST library for your programming language to use CenitIO APIv2.\n" }, "tags": [ { "name": "Document Types", "description": "Document types are the objects that are manipulated in JSON format. Each\nmethod is shown below. See also [Document Types](https://docs.cenit.io/docs/data/document_types) in Cenit IO Docs.\n" }, { "name": "File Types", "description": "File types are information that can not be represented in JSON format,\nsuch as images, PDF files and so on. Similar than document types, you can\ncreate, update, delete and list file types. Each method is shown below. \nYou can see more details about [File Types](https://docs.cenit.io/docs/data/file_types) in Cenit IO Docs.\n" }, { "name": "Collections", "description": "A collection is a way to organize a group of elements of an integration\nthat you want to save in your tenant, and later, export, import or share\nto another tenant. You can manage collections by means of the methods\ndescribed below. \nYou can see more details about [Collections](https://docs.cenit.io/docs/integrations/collections) in Cenit IO Docs.\n" }, { "name": "Shared Collections", "description": "Sharing collections is a way to publish that collection to all tenants.\nYou can manage shared collections by means of the methods described below. \nYou can see more details about [Shared Collections](https://docs.cenit.io/docs/integrations/shared_collections) in Cenit IO Docs.\n" }, { "name": "Algorithms", "description": "Algorithms are pieces of code in Ruby language which can be used for\ngeneral purposes, such as translators, actions to do after callbacks, and\nso on. Algorithms are defined with a name, a description, some optional\nparameters and the code itself. They returns a value, store records of\ndata in Cenit or sends data to an API. Algorithms are executed by means of\ntasks or application actions which can in turn invoke other algorithms.\nThe most commonly tasks are flows to import and export data. \nYou will learn more about [Algorithms](https://docs.cenit.io/docs/compute/algorithms) in Cenit IO Docs.\n" }, { "name": "Applications", "description": "An application provides a way for accessing Cenit IO from outside by\ndefining a set of actions. Each action in the application associates an\nURL, usually like https://server.cenit.io/app/{app_path}/{action_path}, to\na Cenit algorithm which will be executed when a petition to that URL is done. \nYou will learn more about [Applications](https://docs.cenit.io/docs/compute/applications) in Cenit IO Docs.\n" }, { "name": "Snippets", "description": "Cenit uses the \"Snippet\" concept to refer pieces of code of algorithms,\ntranslators and data types definition. When you create a data type or any\nkind of algorithm, Cenit let you know a snippet will be implicitly created\nto store the data type schema or the algorithm code. \nYou will learn more about [Snippets](https://docs.cenit.io/docs/compute/snippets) in Cenit IO Docs.\n" }, { "name": "Templates", "description": "A Template is an algorithm translator that formats data type records\nstored in Cenit to data which be sent outside Cenit. It deals with only\none data type, the type of the data to be formatted and sent, which is\nreferred in the template as source data type. \nYou will learn more about [Templates](https://docs.cenit.io/docs/transformations/templates) in Cenit IO Docs.\n" }, { "name": "Parsers", "description": "Parsers are translators that create data type records in Cenit from\noutside data. It deals with only one data type, the type of the data to be\ncreated, which is referred in the parser as target data type. \nSee details about [Parsers](https://docs.cenit.io/docs/transformations/parsers) in Cenit IO Docs.\n" }, { "name": "Converters", "description": "Converters are algorithms that map records of a data type A stored in\nCenit to data of a data type B, to be stored in Cenit as well. So, this\ntype of algorithm deals with two data types, the type A, which is referred\nin the converter as source data type, and the data type B, also known as\ntarget data type. \nSee details about [Converters](https://docs.cenit.io/docs/transformations/converters) in Cenit IO Docs.\n" }, { "name": "Updaters", "description": "Updaters are algorithms that update records stored in Cenit according to\nthe needs of flows. This type of algorithm deals with only one data type,\nthe type of the data to be updated, which is referred in the updater as target data type. \nSee details about [Updaters](https://docs.cenit.io/docs/transformations/updaters) in Cenit IO Docs.\n" }, { "name": "System Notifications", "description": "System notifications provide information about the execution of flows,\ntasks or algorithms. They don't only notify whether the execution was\nsuccessful or not, but also contain detailed information of HTTP requests and responses. \nYou will learn more about [System Notifications](https://docs.cenit.io/docs/monitors/system_notifications) in Cenit IO Docs.\n" }, { "name": "Tasks", "description": "Cenit uses the \"Task\" concept to refer particular processes which take\nplace inside a tenant, for example the execution of an algorithm or a\nflow, the deletion of one or more records, the transformation of data, etc. \nYou will learn more about [Tasks](https://docs.cenit.io/docs/monitors/tasks) in Cenit IO Docs.\n" }, { "name": "Flows", "description": "Flows define how data is routed between endpoints in order to automate\nyour operations. An Import Flow gets data from an API A and stores it in\nCenit in a proper data type for this object in A, by using a parser\ntranslator. A Converter Flow converts the data stored in Cenit from A, to\na proper data type for an API B, storing the new data also in Cenit by\nusing a converter translator. Export Flows send data stored in Cenit to an\nexternal API, by using a template translator. \nTo know how [Flows](https://docs.cenit.io/docs/workflows/flows) work go to Cenit IO Docs.\n" }, { "name": "Observers", "description": "Observers are conditions to be monitored, related to changes that may occur in the records\nof a dataset of a certain type of document. These changes are called data events. \nData events can be managed around the attributes of the data type. For example, an action \ncan be triggered when new records were added or when the value of certain attribute of a record\nchanges. Data events are associated with flows in order to make sense. \nYou will learn more about [Data Events](https://docs.cenit.io/docs/workflows/data_events) in Cenit IO Docs.\n" }, { "name": "Schedulers", "description": "Scheduler is the type of event related to date and time to be triggered in\norder to execute a flow. A Scheduler handles time intervals which can be\nuseful if we want to repeat it periodically. \nYou will learn more about [Schedulers](https://docs.cenit.io/docs/workflows/schedulers) in Cenit IO Docs.\n" }, { "name": "Connections", "description": "A connection in Cenit is the base URL of an API. You should define\nresource paths for every method used; but a connection serves to all\nmethods. In that way we separate in Cenit the base URL and the methods. \nYou will learn more about [Connections](https://docs.cenit.io/docs/gateway/connection) in Cenit IO Docs.\n" }, { "name": "Connection Roles", "description": "It is used to relate the connection with the webhook (resource/operation) in order to make up the whole URL. \nIn Cenit you can use more than one connection in the same namespace or even use a connection from another namespace. \nThose cases force you to use a connection role, that allows to associate a connection with the resources/operation to \ncombine them for obtaining the URL. This field is optional, but you should consider using it as a way to clarify \nwhat connection and webhook are used to make up the URL. \nConnection roles are used in flows in these ways:\n * When no connection role is set and the Namespace contains only one Connection, that connection is used.\n * When no connection role is set and the Namespace contains more than one Connection, the first connection defined in the namespace is used.\n * When the connection role is set, the connection and webhook defined in the connection role are used.\n" }, { "name": "Resources", "description": "...\n" }, { "name": "Webhooks", "description": "The base URL of an API should be defined as a Connection, only once, and you should define a Resource Path for every method used; that way we\nseparate in Cenit the base URL and the methods. Both, a Connection and a Resource Path, make up the endpoint, the whole URL where the request is\nsent. They allow to define an HTTP Method and its parameters.\nYou will learn more about webhooks in section [Resource Paths](https://docs.cenit.io/docs/gateway/resource_paths) of Cenit IO Docs.\n" }, { "name": "Authorizations Clients", "description": "By defining an authorization client you can set the values of Client ID and Secret ID provided from the API \nwith which you are going to connect to.\nYou will learn more about [Authorization Clients](https://docs.cenit.io/docs/security/authorization_clients) in Cenit IO Docs.\n" }, { "name": "Authorizations Providers", "description": "By defining an authorization provider you can set the response type which is code, the authorization endpoint, the token endpoint, \nmethod the token is sent, the scope separator which is usually a comma (,) and the refresh token strategy. \nYou will learn more about [Authorization Providers](https://docs.cenit.io/docs/security/authorization_providers) in Cenit IO Docs.\n" }, { "name": "Authorizations Basic", "description": "You can manage basic authorizations by means of the methods below.\n" } ], "servers": [ { "url": "https://cenit.io/api/v2" }, { "url": "https://server.cenit.io/api/v2" } ], "security": [ { "X-Tenant-Access-Key": [], "X-Tenant-Access-Token": [] } ], "x-tagGroups": [ { "name": "Data", "tags": [ "Document Types", "File Types" ] }, { "name": "Integrations", "tags": [ "Collections", "Shared Collections" ] }, { "name": "Compute", "tags": [ "Algorithms", "Applications", "Snippets" ] }, { "name": "Transformations", "tags": [ "Templates", "Parsers", "Converters", "Updaters" ] }, { "name": "Workflows", "tags": [ "Flows", "Observers", "Schedulers" ] }, { "name": "Monitors", "tags": [ "Tasks", "System Notifications" ] }, { "name": "Gateways", "tags": [ "Connections", "Connection Roles", "Resources", "Webhooks" ] }, { "name": "Security", "tags": [ "Authorizations Clients", "Authorizations Providers", "Authorizations Basic" ] } ], "externalDocs": { "description": "CenitIO-Documentation", "url": "https://cenit-io.github.io/docs" }, "paths": { "/setup/algorithm": { "get": { "tags": [ "Algorithms" ], "operationId": "get_algorithms", "summary": "List all algorithms", "description": "Returns the list of your algorithms.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/algorithm_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/algorithm\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=snippet" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/algorithm',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: '-namespace,name', embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Algorithms" ], "operationId": "create_algorithm", "summary": "Create a algorithm", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/algorithm_data" }, "responses": { "200": { "$ref": "#/components/responses/algorithm_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/algorithm\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"alg_test_01\",\n \"type\": \"ruby\",\n \"code\": \"return 1 + 1\"\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/algorithm',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"alg_test_01\",\n type: \"ruby\",\n code: \"return 1 + 1\",\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/algorithm/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Algorithms" ], "operationId": "get_algorithm", "summary": "Retrieve an algorithm", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/algorithm_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/algorithm\"\nitem_id=\"59d7dc1c25d985137f00843f\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\\\n -d embedding=snippet" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61eeeea05a5a2353a401b2c6'\n\nconst request = axios({\n method: 'GET',\n url: `setup/algorithm/${item_id}`,\n httpsAgent: agent,\n params: { embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Algorithms" ], "operationId": "update_algorithm", "summary": "Update a algorithm", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/algorithm_data" }, "responses": { "200": { "$ref": "#/components/responses/algorithm_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/algorithm\"\nitem_id=\"61eeeea05a5a2353a401b2c6\"\n\nread -r -d '' data <<- EOM\n {\n \"code\": \"return 1 + $(($(date +%s%N)/1000000))\"\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61eeeea05a5a2353a401b2c6'\n\nlet request = axios({\n method: 'POST',\n url: `setup/algorithm/${item_id}`,\n httpsAgent: agent,\n data: {\n code: `return 1 + ${Date.now()}`,\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Algorithms" ], "operationId": "delete_algorithm", "summary": "Delete a algorithm", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/algorithm\"\nitem_id=\"61eeeea05a5a2353a401b2c6\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61eeeea05a5a2353a401b2c6'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/algorithm/${item_id}`,\n httpsAgent: agent,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/basic_authorization": { "get": { "tags": [ "Authorizations Basic" ], "operationId": "get_basic_authorizations", "summary": "List all basic-authorizations", "description": "Returns the list of your basic-authorizations.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" } ], "responses": { "200": { "$ref": "#/components/responses/basic_authorization_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/basic_authorization\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d ignore=password" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/basic_authorization',\n params: { limit: 5, page: 1, order: '-namespace,name', ignore: 'password'}\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Authorizations Basic" ], "operationId": "create_basic_authorization", "summary": "Create a basic-authorization", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/basic_authorization_data" }, "responses": { "200": { "$ref": "#/components/responses/basic_authorization_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/basic_authorization\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test2\",\n \"name\": \"auth_basic\",\n \"username\": \"test2_auth_basic\",\n \"password\": \"test2_auth_basic\"\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/basic_authorization',\n data: {\n namespace: \"Test2\",\n name: \"auth_basic\",\n username: \"test2_auth_basic\",\n password: \"test2_auth_basic\"\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/basic_authorization/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Authorizations Basic" ], "operationId": "get_basic_authorization", "summary": "Retrieve a basic-authorization", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" } ], "responses": { "200": { "$ref": "#/components/responses/basic_authorization_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/basic_authorization\"\nitem_id=\"62069b095a5a2330d0038cdc\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\\\n -d ignore=password\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '62069b095a5a2330d0038cdc'\n\nconst request = axios({\n method: 'GET',\n url: `setup/basic_authorization/${item_id}`,\n params: { ignore: 'password'}\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Authorizations Basic" ], "operationId": "update_basic_authorization", "summary": "Update a basic-authorization", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/basic_authorization_data" }, "responses": { "200": { "$ref": "#/components/responses/basic_authorization_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/basic_authorization\"\nitem_id=\"62069b095a5a2330d0038cdc\"\n\nread -r -d '' data <<- EOM\n {\n \"username\": \"test_auth_basic@api_v2\"\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '62069b095a5a2330d0038cdc'\n\nlet request = axios({\n method: 'POST',\n url: `setup/basic_authorization/${item_id}`,\n data: {\n username: \"test_auth_basic@api_v2\"\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Authorizations Basic" ], "operationId": "delete_basic_authorization", "summary": "Delete a basic-authorization", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/basic_authorization\"\nitem_id=\"62069b095a5a2330d0038cdc\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '62069b095a5a2330d0038cdc'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/basic_authorization/${item_id}`,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/connection_role": { "get": { "tags": [ "Connection Roles" ], "operationId": "get_connection_roles", "summary": "List all connection-roles", "description": "Returns the list of your connection-roles.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/connection_role_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection_role\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=webhooks,connections\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/connection_role',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: '-namespace,name', embedding: 'webhooks,connections' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Connection Roles" ], "operationId": "create_connection_role", "summary": "Create a connection-role", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/connection_role_data" }, "responses": { "200": { "$ref": "#/components/responses/connection_role_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection_role\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"connection_role_test_01\",\n \"webhooks\": [\n {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"webhook_test_01\"\n }\n ],\n \"connections\": [\n {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"connection_test_01\"\n }\n ]\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/connection_role',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"connection_role_test_01\",\n webhooks: [\n {\n _reference: true,\n namespace: \"Test\",\n name: \"webhook_test_01\"\n }\n ],\n connections: [\n {\n _reference: true,\n namespace: \"Test\",\n name: \"connection_test_01\"\n }\n ],\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/connection_role/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Connection Roles" ], "operationId": "get_connection_role", "summary": "Retrieve a connection-role", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/connection_role_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection_role\"\nitem_id=\"620951d95a5a233eb9043557\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=webhooks,connections\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '620951d95a5a233eb9043557'\n\nconst request = axios({\n method: 'GET',\n url: `setup/connection_role/${item_id}`,\n params: { embedding: 'webhooks,connections' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Connection Roles" ], "operationId": "update_connection_role", "summary": "Update a connection-role", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/connection_role_data" }, "responses": { "200": { "$ref": "#/components/responses/connection_role_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection_role\"\nitem_id=\"620951d95a5a233eb9043557\"\n\nread -r -d '' data <<- EOM\n {\n \"webhooks\": [\n {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"webhook_test_02\"\n }\n ],\n \"connections\": [\n {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"connection_test_02\"\n }\n ]\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-Parser-Options: {'primary_fields':['namespace','name'],'reset':['webhooks'],'add_only':true}\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '620951d95a5a233eb9043557'\n\nlet request = axios({\n method: 'POST',\n url: `setup/connection_role/${item_id}`,\n headers: {\n 'X-Parser-Options': JSON.stringify({\n primary_fields: ['namespace','name'],\n reset: ['webhooks'],\n add_only: true\n })\n },\n data: {\n webhooks: [\n {\n _reference: true,\n namespace: \"Test\",\n name: \"webhook_test_02\"\n }\n ],\n connections: [\n {\n _reference: true,\n namespace: \"Test\",\n name: \"connection_test_02\"\n }\n ],\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Connection Roles" ], "operationId": "delete_connection_role", "summary": "Delete a connection-role", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection_role\"\nitem_id=\"620951d95a5a233eb9043557\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '620951d95a5a233eb9043557'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/connection_role/${item_id}`,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/connection": { "get": { "tags": [ "Connections" ], "operationId": "get_connections", "summary": "List all connections", "description": "Returns the list of your connections.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/connection_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=authorization \\\n -d ignore=password" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/connection',\n params: { limit: 5, page: 1, order: '-namespace,name', embedding: 'authorization', ignore: 'password'}\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Connections" ], "operationId": "create_connection", "summary": "Create a connection", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/connection_data" }, "responses": { "200": { "$ref": "#/components/responses/connection_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"connection_test_01\",\n \"url\": \"http://localhost/api/v2/connection_test\",\n \"authorization\": {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"auth_basic\"\n },\n \"headers\":[\n {\n \"key\": \"Content-Type\",\n \"value\": \"text/xml\"\n }\n ]\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/connection',\n data: {\n namespace: \"Test\",\n name: \"connection_test_01\",\n url: \"http://localhost/api/v2/connection_test\",\n authorization: {\n _reference: true,\n namespace: \"Test\",\n name: \"auth_basic\"\n },\n headers:[\n {\n key: \"Content-Type\",\n value: \"text/xml\"\n }\n ]\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/connection/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Connections" ], "operationId": "get_connection", "summary": "Retrieve a connection", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/connection_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection\"\nitem_id=\"62070ef05a5a23307d038a63\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\\\n -d embedding=authorization \\\n -d ignore=password\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '62070ef05a5a23307d038a63'\n\nconst request = axios({\n method: 'GET',\n url: `setup/connection/${item_id}`,\n params: { embedding: 'authorization', ignore: 'password'}\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Connections" ], "operationId": "update_connection", "summary": "Update a connection", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/connection_data" }, "responses": { "200": { "$ref": "#/components/responses/connection_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection\"\nitem_id=\"62070ef05a5a23307d038a63\"\n\nread -r -d '' data <<- EOM\n {\n \"url\": \"{{domain}}/api/v2/connection_test\",\n \"template_parameters\":[\n {\n \"key\": \"domain\"\n }\n ]\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '62070ef05a5a23307d038a63'\n\nlet request = axios({\n method: 'POST',\n url: `setup/connection/${item_id}`,\n data: {\n url: \"{{domain}}/api/v2/connection_test\",\n template_parameters:[\n {\n key: \"domain\"\n }\n ]\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Connections" ], "operationId": "delete_connection", "summary": "Delete a connection", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/connection\"\nitem_id=\"62070ef05a5a23307d038a63\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '62070ef05a5a23307d038a63'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/connection/${item_id}`,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/flow": { "get": { "tags": [ "Flows" ], "operationId": "get_flows", "summary": "List all flows", "description": "Returns the list of your flows.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/flow_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/flow\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/flow',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: '-namespace,name', embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Flows" ], "operationId": "create_flow", "summary": "Create a flows.", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/flow_data" }, "responses": { "200": { "$ref": "#/components/responses/flow_item_create" } }, "x-code-samples": [ { "lang": "Convert", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/flow',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"flow_convert_test_01\",\n notify_request: true,\n notify_response: true,\n translator: {\n _reference: true,\n namespace: 'Test',\n name: 'converter_test_01',\n },\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" }, { "lang": "Export", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/flow',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"flow_export_test_01\",\n notify_request: true,\n notify_response: true,\n translator: {\n _reference: true,\n namespace: 'Test',\n name: 'template_test_01',\n },\n webhook: {\n _reference: true,\n namespace: 'Test',\n name: 'webhook_test_01',\n },\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" }, { "lang": "Import", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/flow',\n httpsAgent: agent,\n headers: {\n 'X-Parser-Options': JSON.stringify({\n primary_fields: ['namespace','name'],\n // reset: [],\n ignore: ['translator','webhook'],\n add_only: false\n })\n },\n data: {\n namespace: \"Test\",\n name: \"flow_import_test_01\",\n active: false,\n // notify_response: true,\n // translator: {\n // _reference: true,\n // namespace: 'Test',\n // name: 'parser_test_01',\n // },\n // webhook: {\n // _reference: true,\n // namespace: 'Test',\n // name: 'webhook_test_01',\n // },\n after_process_callbacks: [\n { _reference: true, namespace: 'Test', name: 'alg_test_01' },\n ],\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/flow/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Flows" ], "operationId": "get_flow", "summary": "Retrieve a flow.", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/flow_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/flow\"\nitem_id=\"61e083815a5a2353c40082f3\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61e083815a5a2353c40082f3'\n\nconst request = axios({\n method: 'GET',\n url: `setup/flow/${item_id}`,\n httpsAgent: agent,\n params: { embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Flows" ], "operationId": "update_flow", "summary": "Update a flow.", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/flow_data" }, "responses": { "200": { "$ref": "#/components/responses/flow_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/flow\"\nitem_id=\"620364d55a5a236eda02cfb0\"\n\nread -r -d '' data <<- EOM\n {\n \"active\": true\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '620364d55a5a236eda02cfb0'\n\nlet request = axios({\n method: 'POST',\n url: `setup/flow/${item_id}`,\n httpsAgent: agent,\n data: {\n active: true,\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Flows" ], "operationId": "delete_flow", "summary": "Delete a flow.", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/flow\"\nitem_id=\"61e083815a5a2353c40082f3\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61e083815a5a2353c40082f3'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/flow/${item_id}`,\n httpsAgent: agent,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/json_data_type": { "get": { "tags": [ "Document Types" ], "operationId": "get_json_data_types", "summary": "List all json-data-types", "description": "Returns the list of your json-data-types.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/json_data_type_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/json_data_type\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=snippet" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/json_data_type',\n params: { limit: 5, page: 1, order: '-namespace,name', embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Document Types" ], "operationId": "create_json_data_type", "summary": "Create a json-data-type", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/json_data_type_data" }, "responses": { "200": { "$ref": "#/components/responses/json_data_type_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/json_data_type\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"Person45\",\n \"code\": \"{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"dni\\\":{\\\"type\\\":\\\"string\\\"},\\\"name\\\":{\\\"type\\\":\\\"string\\\"}}}\"\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/json_data_type',\n data: {\n namespace: \"Test\",\n name: \"Person4\",\n code: JSON.stringify(\n {\n type: \"object\",\n properties: {\n dni: {\n type: \"string\"\n },\n name: {\n type: \"string\"\n }\n }\n }\n )\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/json_data_type/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Document Types" ], "operationId": "get_json_data_type", "summary": "Retrieve a json-data-type", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/json_data_type_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/json_data_type\"\nitem_id=\"61e0312b5a5a2353ad004469\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61e0312b5a5a2353ad004469'\n\nconst request = axios({\n method: 'GET',\n url: `setup/json_data_type/${item_id}`,\n params: { embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Document Types" ], "operationId": "update_json_data_type", "summary": "Update a json-data-type", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/json_data_type_data" }, "responses": { "200": { "$ref": "#/components/responses/json_data_type_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/json_data_type\"\nitem_id=\"61e0312b5a5a2353ad004469\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"Person3\"\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61e0312b5a5a2353ad004469'\n\nlet request = axios({\n method: 'POST',\n url: `setup/json_data_type/${item_id}`,\n data: {\n namespace: \"Test\",\n name: \"Person3\",\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Document Types" ], "operationId": "delete_json_data_type", "summary": "Delete a json-data-type", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/json_data_type\"\nitem_id=\"61e0312b5a5a2353ad004469\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61e0312b5a5a2353ad004469'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/json_data_type/${item_id}`,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/plain_webhook": { "get": { "tags": [ "Webhooks" ], "operationId": "get_plain_webhooks", "summary": "List all plain-webhooks", "description": "Returns the list of your plain-webhooks.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/plain_webhook_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/plain_webhook\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=authorization\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/plain_webhook',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: '-namespace,name', embedding: 'authorization' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Webhooks" ], "operationId": "create_plain_webhook", "summary": "Create a plain-webhook", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/plain_webhook_data" }, "responses": { "200": { "$ref": "#/components/responses/plain_webhook_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/plain_webhook\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"webhook_test_01\",\n \"method\": \"get\",\n \"path\": \"api/v2/test_01\",\n \"parameters\": [\n {\n \"key\": \"limit\",\n \"value\": \"50\"\n }\n ]\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/plain_webhook',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"webhook_test_01\",\n method: \"get\",\n path: \"api/v2/test_01\",\n parameters: [\n {\n key: \"limit\",\n value: \"50\",\n }\n ],\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/plain_webhook/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Webhooks" ], "operationId": "get_plain_webhook", "summary": "Retrieve a plain-webhook", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/plain_webhook_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/plain_webhook\"\nitem_id=\"6205b5995a5a233dd9039b8a\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=authorization\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '6205b5995a5a233dd9039b8a'\n\nconst request = axios({\n method: 'GET',\n url: `setup/plain_webhook/${item_id}`,\n params: { embedding: 'authorization' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Webhooks" ], "operationId": "update_plain_webhook", "summary": "Update a plain-webhook", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/plain_webhook_data" }, "responses": { "200": { "$ref": "#/components/responses/plain_webhook_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/plain_webhook\"\nitem_id=\"6205b5995a5a233dd9039b8a\"\nparam_id=\"6205b5995a5a233dd9039b8b\"\n\nread -r -d '' data <<- EOM\n {\n \"parameters\": [\n {\n \"id\": \"${param_id}\",\n \"key\": \"limit\",\n \"value\": \"100\"\n }\n ]\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '6205b5995a5a233dd9039b8a'\nconst param_id = '6205b5995a5a233dd9039b8b'\n\nlet request = axios({\n method: 'POST',\n url: `setup/plain_webhook/${item_id}`,\n data: {\n parameters: [\n {\n id: `${param_id}`,\n key: \"limit\",\n value: \"100\",\n }\n ],\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Webhooks" ], "operationId": "delete_plain_webhook", "summary": "Delete a plain-webhook", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/plain_webhook\"\nitem_id=\"6205b5995a5a233dd9039b8a\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '6205b5995a5a233dd9039b8a'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/plain_webhook/${item_id}`,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/ruby_converter": { "get": { "tags": [ "Converters" ], "operationId": "get_ruby_converters", "summary": "List all ruby converter transformations", "description": "Returns the list of your ruby converter transformations.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/ruby_converter_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_converter\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=snippet" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/ruby_converter',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: 'namespace,name', embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Converters" ], "operationId": "create_ruby_converter", "summary": "Create a ruby converter transformations.", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/ruby_converter_data" }, "responses": { "200": { "$ref": "#/components/responses/ruby_converter_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_converter\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"converter_test_01\",\n \"source_handler\": false,\n \"source_data_type\": {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"Person\"\n },\n \"target_data_type\": {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"Person2\"\n },\n \"code\": \"target.name = source.name.downcase\"\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/ruby_converter',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"converter_test_01\",\n source_handler: false,\n source_data_type: {\n _reference: true,\n namespace: \"Test\",\n name: \"Person\"\n },\n target_data_type: {\n _reference: true,\n namespace: \"Test\",\n name: \"Person2\"\n },\n code: 'target.name = source.name.downcase',\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/ruby_converter/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Converters" ], "operationId": "get_ruby_converter", "summary": "Retrieve a ruby converter transformation.", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/ruby_converter_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_converter\"\nitem_id=\"6203c5dd5a5a233de3027b96\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '6203c5dd5a5a233de3027b96'\n\nconst request = axios({\n method: 'GET',\n url: `setup/ruby_converter/${item_id}`,\n httpsAgent: agent,\n params: { embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Converters" ], "operationId": "update_ruby_converter", "summary": "Update a ruby converter transformation.", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/ruby_converter_data" }, "responses": { "200": { "$ref": "#/components/responses/ruby_converter_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_converter\"\nitem_id=\"6203c5dd5a5a233de3027b96\"\n\nread -r -d '' data <<- EOM\n {\n \"source_handler\": true,\n \"code\": \"sources.each {|s| target_data_type.create_from_json!(name: s.name.downcase, primary_field: %i[name]) }\"\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '6203c5dd5a5a233de3027b96'\n\nlet request = axios({\n method: 'POST',\n url: `setup/ruby_converter/${item_id}`,\n httpsAgent: agent,\n data: {\n source_handler: true,\n code: 'sources.each {|s| target_data_type.create_from_json!(name: s.name.downcase, primary_field: %i[name]) }',\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Converters" ], "operationId": "delete_ruby_converter", "summary": "Delete a ruby converter transformation.", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_converter\"\nitem_id=\"6203c5dd5a5a233de3027b96\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '6203c5dd5a5a233de3027b96'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/ruby_converter/${item_id}`,\n httpsAgent: agent,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/ruby_parser": { "get": { "tags": [ "Parsers" ], "operationId": "get_ruby_parsers", "summary": "List all ruby parser transformations", "description": "Returns the list of your ruby parser transformations.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/ruby_parser_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_parser\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/ruby_parser',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: 'namespace,name', embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Parsers" ], "operationId": "create_ruby_parser", "summary": "Create a ruby parser transformations.", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/ruby_parser_data" }, "responses": { "200": { "$ref": "#/components/responses/ruby_parser_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_parser\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"parser_test_01\",\n \"target_data_type\": {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"Person\"\n },\n \"code\": \"{ name: data[:name].downcase }\"\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/ruby_parser',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"parser_test_01\",\n target_data_type: {\n _reference: true,\n namespace: \"Test\",\n name: \"Person\"\n },\n code: '{ name: data[:name].downcase }',\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/ruby_parser/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Parsers" ], "operationId": "get_ruby_parser", "summary": "Retrieve a ruby parser transformation.", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/ruby_parser_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_parser\"\nitem_id=\"61eeeb7f5a5a234adc00ab2b\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61eeeb7f5a5a234adc00ab2b'\n\nconst request = axios({\n method: 'GET',\n url: `setup/ruby_parser/${item_id}`,\n httpsAgent: agent,\n params: { embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Parsers" ], "operationId": "update_ruby_parser", "summary": "Update a ruby parser transformation.", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/ruby_parser_data" }, "responses": { "200": { "$ref": "#/components/responses/ruby_parser_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_parser\"\nitem_id=\"61eeeb7f5a5a234adc00ab2b\"\n\nread -r -d '' data <<- EOM\n {\n \"code\": \"{ name: data[:name].upcase }\"\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61eeeb7f5a5a234adc00ab2b'\n\nlet request = axios({\n method: 'POST',\n url: `setup/ruby_parser/${item_id}`,\n httpsAgent: agent,\n data: {\n code: '{ name: data[:name].upcase }',\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Parsers" ], "operationId": "delete_ruby_parser", "summary": "Delete a ruby parser transformation.", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_parser\"\nitem_id=\"61eeeb7f5a5a234adc00ab2b\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61eeeb7f5a5a234adc00ab2b'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/ruby_parser/${item_id}`,\n httpsAgent: agent,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } }, "/setup/ruby_template": { "get": { "tags": [ "Templates" ], "operationId": "get_ruby_templates", "summary": "List all ruby template transformations", "description": "Returns the list of your ruby template transformations.\n", "parameters": [ { "$ref": "#/components/parameters/header_query_selector" }, { "$ref": "#/components/parameters/query_offset" }, { "$ref": "#/components/parameters/query_limit" }, { "$ref": "#/components/parameters/query_sort" }, { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/ruby_template_items" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_template\"\n\ncurl -G \"${base_url}/${path}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d limit=5 \\\n -d page=1 \\\n -d order=-namespace,name \\\n -d embedding=snippet" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'GET',\n url: 'setup/ruby_template',\n httpsAgent: agent,\n params: { limit: 5, page: 1, order: 'namespace,name', embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Templates" ], "operationId": "create_ruby_template", "summary": "Create a ruby template transformations.", "description": "Add a new item.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/ruby_template_data" }, "responses": { "200": { "$ref": "#/components/responses/ruby_template_item_create" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_template\"\n\nread -r -d '' data <<- EOM\n {\n \"namespace\": \"Test\",\n \"name\": \"template_test_01\",\n \"mime_type\": \"application/json\",\n \"file_extension\": \"json\",\n \"bulk_source\": false,\n \"source_data_type\": {\n \"_reference\": true,\n \"namespace\": \"Test\",\n \"name\": \"Person\"\n },\n \"code\": \"source.to_json\"\n }\nEOM\n\ncurl \"${base_url}/${path}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst request = axios({\n method: 'POST',\n url: 'setup/ruby_template',\n httpsAgent: agent,\n data: {\n namespace: \"Test\",\n name: \"template_test_01\",\n mime_type: 'application/json',\n file_extension: 'json',\n bulk_source: false,\n source_data_type: {\n _reference: true,\n namespace: \"Test\",\n name: \"Person\"\n },\n code: 'source.to_json',\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});\n\n" } ] } }, "/setup/ruby_template/{id}": { "parameters": [ { "$ref": "#/components/parameters/path_item_id" } ], "get": { "tags": [ "Templates" ], "operationId": "get_ruby_template", "summary": "Retrieve a ruby template transformation.", "description": "Find and return the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/query_only" }, { "$ref": "#/components/parameters/query_ignore" }, { "$ref": "#/components/parameters/query_embedding" } ], "responses": { "200": { "$ref": "#/components/responses/ruby_template_item" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_template\"\nitem_id=\"61f1597a5a5a2353be026f14\"\n\ncurl -G \"${base_url}/${path}/${item_id}\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -d embedding=snippet\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61f1597a5a5a2353be026f14'\n\nconst request = axios({\n method: 'GET',\n url: `setup/ruby_template/${item_id}`,\n httpsAgent: agent,\n params: { embedding: 'snippet' }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "post": { "tags": [ "Templates" ], "operationId": "update_ruby_template", "summary": "Update a ruby template transformation.", "description": "Find and update the item with the given id.\n", "parameters": [ { "$ref": "#/components/parameters/header_parser_options" } ], "requestBody": { "$ref": "#/components/requestBodies/ruby_template_data" }, "responses": { "200": { "$ref": "#/components/responses/ruby_template_item_create" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_template\"\nitem_id=\"61f1597a5a5a2353be026f14\"\n\nread -r -d '' data <<- EOM\n {\n \"mime_type\": \"application/json\",\n \"file_extension\": \"json\",\n \"bulk_source\": true,\n \"code\": \"sources.to_json\"\n }\nEOM\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"POST\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\" \\\n -H \"Content-Type: application/json\" \\\n -d \"${data}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['Content-Type'] = 'application/json'\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61f1597a5a5a2353be026f14'\n\nlet request = axios({\n method: 'POST',\n url: `setup/ruby_template/${item_id}`,\n httpsAgent: agent,\n data: {\n mime_type: 'application/json',\n file_extension: 'json',\n bulk_source: true,\n code: 'sources.to_json',\n }\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] }, "delete": { "tags": [ "Templates" ], "operationId": "delete_ruby_template", "summary": "Delete a ruby template transformation.", "description": "Find and destroy the item with the given id.\n", "responses": { "200": { "$ref": "#/components/responses/item_removed_successfully" }, "404": { "$ref": "#/components/responses/item_not_found" } }, "x-code-samples": [ { "lang": "cURL", "source": "#!/bin/bash\n\nbase_url=${BASE_URL:=\"https://cenit.io/api/v2\"}\npath=\"setup/ruby_template\"\nitem_id=\"61f1597a5a5a2353be026f14\"\n\ncurl \"${base_url}/${path}/${item_id}\" \\\n -X \"DELETE\" \\\n -H \"X-Tenant-Access-Key: ${X_TENANT_ACCESS_KEY}\" \\\n -H \"X-Tenant-Access-Token: ${X_TENANT_ACCESS_TOKEN}\"\n" }, { "lang": "NodeJS", "source": "const dotenv = require('dotenv')\nconst axios = require('axios');\nconst https = require('https');\n\nconst agent = new https.Agent({\n rejectUnauthorized: false\n});\n\ndotenv.config();\n\naxios.defaults.baseURL = process.env['BASE_URL'] || 'https://cenit.io/api/v2/';\naxios.defaults.headers.common['X-Tenant-Access-Key'] = process.env['X_TENANT_ACCESS_KEY']\naxios.defaults.headers.common['X-Tenant-Access-Token'] = process.env['X_TENANT_ACCESS_TOKEN']\n\nconst item_id = '61f1597a5a5a2353be026f14'\n\nconst request = axios({\n method: 'DELETE',\n url: `setup/ruby_template/${item_id}`,\n httpsAgent: agent,\n});\n\nrequest.then((response) => {\n // Do something with the response\n console.log(JSON.stringify(response.data, null, 2));\n}).catch((error) => {\n // Do something with the error\n console.error(JSON.stringify(error.response.data, null, 2));\n});" } ] } } }, "components": { "schemas": { "algorithm_parameter": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "name": { "type": "string" }, "many": { "type": "boolean", "default": false }, "required": { "type": "boolean", "default": false }, "default": { "type": "string" } } }, "algorithm_response_get": { "type": "object", "title": "algorithm", "allOf": [ { "$ref": "#/components/schemas/algorithm" }, { "$ref": "#/components/schemas/snippet_response" }, { "type": "object", "properties": { "output_datatype": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/json_data_type_response_get" } ] } } } ] }, "algorithm_response_post": { "type": "object", "title": "algorithm", "allOf": [ { "$ref": "#/components/schemas/algorithm" }, { "type": "object", "properties": { "snippet": { "$ref": "#/components/schemas/reference_to_response" }, "output_datatype": { "$ref": "#/components/schemas/reference_to_response" } } } ] }, "algorithm": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "description": { "type": "string" }, "language": { "type": "string", "enum": [ "ruby", "javascript" ] }, "store_output": { "type": "boolean", "default": false }, "validate_output": { "type": "boolean", "default": false }, "parameters_size": { "type": "integer" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/algorithm_parameter" } }, "code": { "type": "string", "description": "Code snippet in the previously selected language", "writeOnly": true } } }, "authorization_basic": { "type": "object", "title": "basic_authorization", "allOf": [ { "$ref": "#/components/schemas/authorization_common" }, { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } } } ] }, "authorization_common": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" } } }, "authorization_response": { "type": "object", "title": "authorization", "oneOf": [ { "$ref": "#/components/schemas/authorization_basic" } ] }, "connection_request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/connection" }, { "type": "object", "properties": { "parameters": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/parameter" } ], "required": [ "key" ] } }, "headers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/parameter" } ], "required": [ "key" ] } }, "template_parameters": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/parameter" } ], "required": [ "key" ] } }, "authorization": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } } ] }, "connection_response_get": { "type": "object", "title": "connection", "allOf": [ { "$ref": "#/components/schemas/connection" }, { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "template_parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "authorization": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/authorization_response" } ] } } } ] }, "connection_response_post": { "type": "object", "title": "connection", "allOf": [ { "$ref": "#/components/schemas/connection" }, { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "template_parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "authorization": { "title": "authorization reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } } } ] }, "connection_role_request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/connection_role" }, { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } }, "connections": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } } } ] }, "connection_role_response_get": { "type": "object", "title": "connection-role", "allOf": [ { "$ref": "#/components/schemas/connection_role" }, { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "title": "plain_webhook reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/plain_webhook_response_get" } ] } }, "connections": { "type": "array", "items": { "title": "connection reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/connection_response_get" } ] } } } } ] }, "connection_role_response_post": { "type": "object", "title": "connection-role", "allOf": [ { "$ref": "#/components/schemas/connection_role" }, { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "title": "plain_webhook reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } }, "connections": { "type": "array", "items": { "title": "connection reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } } } } ] }, "connection_role": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" } } }, "connection": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "url": { "type": "string", "description": "The connection url" }, "authorization_handler": { "type": "boolean", "default": false }, "number": { "type": "string" }, "token": { "type": "string" } } }, "flow_convert_request": { "type": "object", "title": "flow-convert", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_data_type_scope" }, { "$ref": "#/components/schemas/flow_field_translator_request" }, { "$ref": "#/components/schemas/flow_field_event_request" }, { "$ref": "#/components/schemas/flow_field_after_process_callbacks_request" } ] }, "flow_convert_response_get": { "type": "object", "title": "flow-convert", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_data_type_scope" }, { "type": "object", "properties": { "translator": { "title": "translator reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/ruby_converter_response_get" } ] }, "event": { "title": "event reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "after_process_callbacks": { "title": "algorithms reference", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/algorithm_response_get" } ] } } } } ] }, "flow_convert_response_post": { "type": "object", "title": "flow-convert", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_data_type_scope" }, { "type": "object", "properties": { "translator": { "title": "translator reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "event": { "title": "event reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "after_process_callbacks": { "title": "algorithms reference", "type": "array", "items": { "$ref": "#/components/schemas/reference_to_response" } } } } ] }, "flow_export_request": { "type": "object", "title": "flow-export", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_data_type_scope" }, { "$ref": "#/components/schemas/flow_field_translator_request" }, { "$ref": "#/components/schemas/flow_field_event_request" }, { "$ref": "#/components/schemas/flow_field_webhook_request" }, { "$ref": "#/components/schemas/flow_field_authorization_request" }, { "$ref": "#/components/schemas/flow_field_connection_role_request" }, { "$ref": "#/components/schemas/flow_field_before_submit_request" }, { "$ref": "#/components/schemas/flow_field_after_process_callbacks_request" }, { "$ref": "#/components/schemas/flow_field_response_translator_request" } ] }, "flow_export_response_get": { "type": "object", "title": "flow-export", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_data_type_scope" }, { "type": "object", "properties": { "translator": { "title": "translator reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/ruby_template_response_get" } ] }, "event": { "title": "event reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "webhook": { "title": "webhook reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/plain_webhook_response_get" } ] }, "authorization": { "title": "authorization reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/authorization_response" } ] }, "connection_role": { "title": "connection-role reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/connection_role_response_get" } ] }, "before_submit": { "title": "algorithm reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/algorithm_response_get" } ] }, "after_process_callbacks": { "title": "algorithms reference", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/algorithm_response_get" } ] } }, "response_translator": { "title": "response-translator reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/ruby_parser_response_get" } ] } } } ] }, "flow_export_response_post": { "type": "object", "title": "flow-export", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_data_type_scope" }, { "type": "object", "properties": { "translator": { "title": "translator reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "event": { "title": "event reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "webhook": { "title": "webhook reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "authorization": { "title": "authorization reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "connection_role": { "title": "connection-role reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "before_submit": { "title": "algorithm reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "after_process_callbacks": { "title": "algorithms reference", "type": "array", "items": { "$ref": "#/components/schemas/reference_to_response" } }, "response_translator": { "title": "response-translator reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } } } ] }, "flow_field_after_process_callbacks_request": { "type": "object", "properties": { "after_process_callbacks": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } } }, "flow_field_authorization_request": { "type": "object", "properties": { "authorization": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_field_before_submit_request": { "type": "object", "properties": { "before_submit": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_field_connection_role_request": { "type": "object", "properties": { "connection_role": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_field_data_type_scope": { "type": "object", "properties": { "data_type_scope": { "type": "string", "enum": [ "Event source", "Filter", "Evaluator", "All" ] } } }, "flow_field_event_request": { "type": "object", "properties": { "event": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_field_response_translator_request": { "type": "object", "properties": { "response_translator": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_field_translator_request": { "type": "object", "properties": { "translator": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_field_webhook_request": { "type": "object", "properties": { "webhook": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "flow_import_request": { "type": "object", "title": "flow-import", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "$ref": "#/components/schemas/flow_field_translator_request" }, { "$ref": "#/components/schemas/flow_field_event_request" }, { "$ref": "#/components/schemas/flow_field_webhook_request" }, { "$ref": "#/components/schemas/flow_field_authorization_request" }, { "$ref": "#/components/schemas/flow_field_connection_role_request" }, { "$ref": "#/components/schemas/flow_field_before_submit_request" }, { "$ref": "#/components/schemas/flow_field_after_process_callbacks_request" } ] }, "flow_import_response_get": { "type": "object", "title": "flow-import", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "type": "object", "properties": { "translator": { "title": "translator reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/ruby_parser_response_get" } ] }, "event": { "title": "event reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "webhook": { "title": "webhook reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/plain_webhook_response_get" } ] }, "authorization": { "title": "authorization reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/authorization_response" } ] }, "connection_role": { "title": "connection-role reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/connection_role_response_get" } ] }, "before_submit": { "title": "algorithm reference", "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/algorithm_response_get" } ] }, "after_process_callbacks": { "title": "algorithms reference", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/algorithm_response_get" } ] } } } } ] }, "flow_import_response_post": { "type": "object", "title": "flow-import", "allOf": [ { "$ref": "#/components/schemas/flow" }, { "type": "object", "properties": { "translator": { "title": "translator reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "event": { "title": "event reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "webhook": { "title": "webhook reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "authorization": { "title": "authorization reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "connection_role": { "title": "connection-role reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "before_submit": { "title": "algorithm reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "after_process_callbacks": { "title": "algorithms reference", "type": "array", "items": { "$ref": "#/components/schemas/reference_to_response" } } } } ] }, "flow": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "description": { "type": "string", "description": "The flow description" }, "active": { "type": "boolean", "description": "The flow status", "default": false }, "notify_request": { "type": "boolean", "default": false }, "notify_response": { "type": "boolean", "default": false }, "discard_events": { "type": "boolean", "default": false }, "auto_retry": { "type": "string", "enum": [ "manually", "automatic" ] } } }, "json_data_type_request": { "type": "object", "properties": { "json_data_type": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "json_data_type_response_get": { "type": "object", "title": "json_data_type", "allOf": [ { "$ref": "#/components/schemas/json_data_type" }, { "type": "object", "properties": { "snippet": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/snippet" } ] } } } ] }, "json_data_type_response_post": { "type": "object", "title": "json_data_type", "allOf": [ { "$ref": "#/components/schemas/json_data_type" }, { "type": "object", "properties": { "snippet": { "$ref": "#/components/schemas/reference_to_response" } } } ] }, "json_data_type": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Name without spaces or special characters" }, "title": { "type": "string" }, "slug": { "type": "string" }, "code": { "type": "string", "description": "JSON-Schema", "writeOnly": true }, "discard_additional_properties": { "type": "boolean", "default": true, "description": "True forces the discard of all those properties that were not declared in the schema, when a record import occurs" }, "navigation_link": { "type": "boolean", "default": false } } }, "pagination": { "type": "object", "properties": { "total_pages": { "description": "Total number of pages", "type": "integer" }, "current_page": { "description": "Number of the page obtained", "type": "integer" }, "count": { "description": "Total number of items", "type": "integer" } } }, "parameter": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "key": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "metadata": { "type": "string" } } }, "plain_webhook_request": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/plain_webhook" }, { "type": "object", "properties": { "parameters": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/parameter" } ], "required": [ "key" ] } }, "headers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/parameter" } ], "required": [ "key" ] } }, "template_parameters": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/parameter" } ], "required": [ "key" ] } }, "authorization": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } } ] }, "plain_webhook_response_get": { "type": "object", "title": "plain-webhook", "allOf": [ { "$ref": "#/components/schemas/plain_webhook" }, { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "template_parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "authorization": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/authorization_response" } ] } } } ] }, "plain_webhook_response_post": { "type": "object", "title": "plain-webhook", "allOf": [ { "$ref": "#/components/schemas/plain_webhook" }, { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "template_parameters": { "type": "array", "items": { "$ref": "#/components/schemas/parameter" } }, "authorization": { "title": "authorization reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } } } ] }, "plain_webhook": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "description": { "type": "string", "description": "The plain-webhook description" }, "path": { "type": "string", "description": "The plain-webhook path" }, "method": { "type": "string", "description": "The http method", "enum": [ "get", "post", "put", "delete" ] }, "metadata": { "type": "string" }, "authorization_handler": { "type": "boolean", "default": false } } }, "reference_by_identify": { "type": "object", "title": "reference by id", "properties": { "_reference": { "type": "boolean", "default": true }, "id": { "type": "string", "description": "Item identifier" } }, "required": [ "_reference", "id" ] }, "reference_by_names": { "type": "object", "title": "reference by names", "properties": { "_reference": { "type": "boolean", "default": true }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Name without spaces or special characters" } }, "required": [ "_reference", "namespace", "name" ] }, "reference_to_response": { "type": "object", "title": "reference", "properties": { "_reference": { "type": "boolean", "default": true }, "id": { "type": "string", "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Name without spaces or special characters" } } }, "ruby_converter_response_get": { "type": "object", "title": "ruby_converter", "allOf": [ { "$ref": "#/components/schemas/ruby_template" }, { "$ref": "#/components/schemas/source_data_type_response" }, { "$ref": "#/components/schemas/target_data_type_response" }, { "$ref": "#/components/schemas/snippet_response" } ] }, "ruby_converter": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "type": { "type": "string", "default": "Conversion", "readOnly": true }, "source_handler": { "type": "boolean", "default": false, "description": "When the value is false:\n * The target_data_type is required.\n * A **target** parameter is received with a new record of the target_data_type.\n * A single record is received in the **source** parameter to be process.\n * At the end of the process this record will be persisted automatically.\n\nWhen the value is true:\n * The **sources** parameter is received with multiple records to be process.\n * It is the developer's responsibility to create and persist the target record.\n" }, "code": { "type": "string", "description": "Code snippet in the previously selected language", "writeOnly": true } } }, "ruby_parser_response_get": { "type": "object", "title": "ruby_parser", "allOf": [ { "$ref": "#/components/schemas/ruby_parser" }, { "$ref": "#/components/schemas/target_data_type_response" }, { "$ref": "#/components/schemas/snippet_response" } ] }, "ruby_parser": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "type": { "type": "string", "default": "Import", "readOnly": true }, "code": { "type": "string", "description": "Code snippet in the previously selected language", "writeOnly": true } } }, "ruby_template_response_get": { "type": "object", "title": "ruby_template", "allOf": [ { "$ref": "#/components/schemas/ruby_template" }, { "$ref": "#/components/schemas/source_data_type_response" }, { "$ref": "#/components/schemas/snippet_response" } ] }, "ruby_template": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Lowercase name without spaces or special characters" }, "type": { "type": "string", "default": "Export", "readOnly": true }, "mime_type": { "type": "string", "description": "The output mime-type" }, "file_extension": { "type": "string", "description": "The extension of the output file" }, "bulk_source": { "type": "boolean", "description": "When the value is true, the **sources** parameter is received with multiple records, otherwise a single record is received in the **source** parameter.", "default": false }, "code": { "type": "string", "description": "Code snippet in the previously selected language", "writeOnly": true } } }, "snippet_response": { "type": "object", "properties": { "snippet": { "readOnly": true, "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/snippet" } ] } } }, "snippet": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "description": "Item identifier" }, "namespace": { "type": "string" }, "name": { "type": "string", "description": "Name without spaces or special characters" }, "type": { "type": "string" }, "code": { "type": "string", "description": "Code snippet" }, "slug": { "type": "string" }, "navigation_link": { "type": "boolean", "default": false } } }, "sort_query_parameter": { "description": "Sort criterial", "type": "string", "enum": [ "ASC", "DESC" ] }, "source_data_type_request": { "type": "object", "properties": { "source_data_type": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "source_data_type_response": { "type": "object", "properties": { "source_data_type": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/json_data_type_response_get" } ] } } }, "target_data_type_request": { "type": "object", "properties": { "target_data_type": { "oneOf": [ { "$ref": "#/components/schemas/reference_by_names" }, { "$ref": "#/components/schemas/reference_by_identify" } ] } } }, "target_data_type_response": { "type": "object", "properties": { "target_data_type": { "oneOf": [ { "$ref": "#/components/schemas/reference_to_response" }, { "$ref": "#/components/schemas/json_data_type_response_get" } ] } } } }, "responses": { "algorithm_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "algorithm": { "allOf": [ { "$ref": "#/components/schemas/algorithm_response_post" } ] } } } } } } } }, "algorithm_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/algorithm_response_get" } } } }, "algorithm_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "algorithms": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/algorithm_response_get" } ] } } } } ] } } } }, "basic_authorization_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "basic_authorization": { "allOf": [ { "$ref": "#/components/schemas/authorization_basic" } ] } } } } } } } }, "basic_authorization_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/authorization_basic" } } } }, "basic_authorization_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "basic_authorizations": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/authorization_basic" } ] } } } } ] } } } }, "connection_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "connection": { "allOf": [ { "$ref": "#/components/schemas/connection_response_post" } ] } } } } } } } }, "connection_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_response_get" } } } }, "connection_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "connections": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/connection_response_get" } ] } } } } ] } } } }, "connection_role_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "connection_role": { "allOf": [ { "$ref": "#/components/schemas/connection_role_response_post" } ] } } } } } } } }, "connection_role_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_role_response_get" } } } }, "connection_role_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "connection_roles": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/connection_role_response_get" } ] } } } } ] } } } }, "flow_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "flow": { "oneOf": [ { "$ref": "#/components/schemas/flow_import_response_post" }, { "$ref": "#/components/schemas/flow_export_response_post" }, { "$ref": "#/components/schemas/flow_convert_response_post" } ] } } } } } } } }, "flow_item": { "description": "Success", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/flow_import_response_get" }, { "$ref": "#/components/schemas/flow_export_response_get" }, { "$ref": "#/components/schemas/flow_convert_response_get" } ] } } } }, "flow_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "flows": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/flow_import_response_get" }, { "$ref": "#/components/schemas/flow_export_response_get" }, { "$ref": "#/components/schemas/flow_convert_response_get" } ] } } } } ] } } } }, "item_not_found": { "description": "Not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "default": "item not found" } } } } } }, "item_removed_successfully": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "default": "ok" } } } } } }, "json_data_type_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "json_data_type": { "allOf": [ { "$ref": "#/components/schemas/json_data_type_response_post" } ] } } } } } } } }, "json_data_type_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/json_data_type_response_get" } } } }, "json_data_type_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "json_data_types": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/json_data_type_response_get" } ] } } } } ] } } } }, "plain_webhook_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "plain_webhook": { "allOf": [ { "$ref": "#/components/schemas/plain_webhook_response_post" } ] } } } } } } } }, "plain_webhook_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/plain_webhook_response_get" } } } }, "plain_webhook_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "plain_webhooks": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/plain_webhook_response_get" } ] } } } } ] } } } }, "ruby_converter_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "ruby_converter": { "allOf": [ { "$ref": "#/components/schemas/ruby_converter" }, { "type": "object", "properties": { "source_data_type": { "title": "data_type reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "target_data_type": { "title": "data_type reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "snippet": { "title": "snippet reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } } } ] } } } } } } } }, "ruby_converter_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruby_converter_response_get" } } } }, "ruby_converter_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "ruby_converters": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ruby_converter_response_get" } ] } } } } ] } } } }, "ruby_parser_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "ruby_parser": { "allOf": [ { "$ref": "#/components/schemas/ruby_parser" }, { "type": "object", "properties": { "target_data_type": { "$ref": "#/components/schemas/reference_to_response" }, "snippet": { "$ref": "#/components/schemas/reference_to_response" } } } ] } } } } } } } }, "ruby_parser_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruby_parser_response_get" } } } }, "ruby_parser_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "ruby_parsers": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ruby_parser_response_get" } ] } } } } ] } } } }, "ruby_template_item_create": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "object", "properties": { "ruby_template": { "allOf": [ { "$ref": "#/components/schemas/ruby_template" }, { "type": "object", "properties": { "source_data_type": { "title": "data_type reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] }, "snippet": { "title": "snippet reference", "allOf": [ { "$ref": "#/components/schemas/reference_to_response" } ] } } } ] } } } } } } } }, "ruby_template_item": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruby_template_response_get" } } } }, "ruby_template_items": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/pagination" }, { "type": "object", "properties": { "ruby_templates": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/ruby_template_response_get" } ] } } } } ] } } } } }, "parameters": { "header_parser_options": { "name": "X-Parser-Options", "in": "header", "schema": { "type": "string", "description": "JSON stringify with parser options. The available parser options are:\n- ***primary_fields***: | array of attribute names that will be parsed to identify the register to operate.\n > If exist a matching record it is updated, otherwise a new record is created.\n- ***reset***: | array of attribute names that will be reset before to operate.\n > This option is only parsed when trying to update a record.\n- ***ignore***: | array of attribute names that will be ignored to operate.\n > The id attribute never will be ignored.\n- ***add_only***: | boolean value that establishes how to operate on all attributes of type array but not defined in parser option reset. When the value is true the append action is set; otherwise the overwrite action is set.\n > If operation is create a new record the default value is true, otherwise de default value is false.\n", "example": "{\"primary_fields\": [\"namespace\", \"name\"],\"add_only\": true}" } }, "header_query_selector": { "name": "X-Query-Selector", "in": "header", "schema": { "type": "string", "description": "JSON stringify with the query criteria.\n", "example": "{\"$or\":[{\"namespace\":\"Test\"},{\"namespace\":\"Test_02\"}]}" } }, "path_item_id": { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "description": "Item identifier", "example": "5d04051125d9852c71016793" } }, "query_embedding": { "name": "embedding", "in": "query", "schema": { "type": "string", "description": "Comma separated set of attributes, which refer to another entities and will be included in its entirety in the response.\n\n> By default in these attributes only a reference to the foreign items is returned.\n" } }, "query_ignore": { "name": "ignore", "in": "query", "schema": { "type": "string", "description": "Comma separated set of attributes that are excluded from the response.\n\n> The id attribute always will be included.\n", "example": "namespace,name" } }, "query_limit": { "name": "limit", "in": "query", "schema": { "type": "integer", "description": "The maximum number of items that can be returned. The supported values ​​are between 1 and 25.\n", "example": 10 } }, "query_offset": { "name": "page", "in": "query", "schema": { "type": "integer", "description": "Number of the page to skip at the beginning of the list.\n", "example": 1 } }, "query_only": { "name": "only", "in": "query", "schema": { "type": "string", "description": "Comma separated set of attributes that are included in the response.\n\n> The id attribute always will be included.\n", "example": "namespace,name" } }, "query_sort": { "name": "order", "in": "query", "schema": { "type": "string", "description": "Comma separated set of attributes to sort items list.\n\n> To sort descendingly, the prefix sign (-) must be added.\n", "example": "-namespace,name" } } }, "requestBodies": { "algorithm_data": { "description": "The algorithm that will be created or updated", "required": true, "content": { "application/json": { "schema": { "required": [ "namespace", "name", "language", "code" ], "allOf": [ { "$ref": "#/components/schemas/algorithm" }, { "properties": { "parameters": { "type": "array", "items": { "required": [ "name" ] } } } } ] } } } }, "basic_authorization_data": { "description": "The basic-authorization that will be created or updated", "required": true, "content": { "application/json": { "schema": { "required": [ "namespace", "name" ], "allOf": [ { "$ref": "#/components/schemas/authorization_basic" } ] } } } }, "connection_data": { "description": "The connection that will be created or updated", "required": true, "content": { "application/json": { "schema": { "required": [ "namespace", "name", "url" ], "allOf": [ { "$ref": "#/components/schemas/connection_request" } ] } } } }, "connection_role_data": { "description": "The connection-role that will be created or updated", "required": true, "content": { "application/json": { "schema": { "required": [ "namespace", "name" ], "allOf": [ { "$ref": "#/components/schemas/connection_role_request" } ] } } } }, "flow_data": { "description": "The flow that will be created or updated", "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/flow_import_request" }, { "$ref": "#/components/schemas/flow_export_request" }, { "$ref": "#/components/schemas/flow_convert_request" } ], "required": [ "namespace", "name", "translator", "webhook" ] } } } }, "json_data_type_data": { "description": "The json-data-type that will be created or updated", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/json_data_type" } ], "required": [ "namespace", "name", "code" ] } } } }, "plain_webhook_data": { "description": "The plain-webhook that will be created or updated", "required": true, "content": { "application/json": { "schema": { "required": [ "namespace", "name", "path" ], "allOf": [ { "$ref": "#/components/schemas/plain_webhook_request" } ] } } } }, "ruby_converter_data": { "description": "The translator that will be created or updated", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ruby_converter" }, { "$ref": "#/components/schemas/source_data_type_request" }, { "$ref": "#/components/schemas/target_data_type_request" } ], "required": [ "namespace", "name", "code", "source_data_type", "target_data_type" ] } } } }, "ruby_parser_data": { "description": "The translator that will be created or updated", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ruby_parser" }, { "$ref": "#/components/schemas/target_data_type_request" } ], "required": [ "namespace", "name", "code", "target_data_type" ] } } } }, "ruby_template_data": { "description": "The translator that will be created or updated", "required": true, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ruby_template" }, { "$ref": "#/components/schemas/source_data_type_request" } ], "required": [ "namespace", "name", "code", "source_data_type" ] } } } } }, "securitySchemes": { "X-Tenant-Access-Key": { "type": "apiKey", "name": "X-Tenant-Access-Key", "in": "header", "description": "Tenant authentication key.\n\n> Each service request must include an **X-Tenant-Access-Key** header or parameter.\n" }, "X-Tenant-Access-Token": { "type": "apiKey", "name": "X-Tenant-Access-Token", "in": "header", "description": "Tenant authentication Token.\n\n> Each service request must include an **X-Tenant-Access-Token** header or parameter.\n" } } } }