{ "uuid": "278b151a-405d-4996-9137-d83f2b60b2a3", "lastMigration": 29, "name": "Connectors API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "ea1a8a48-5f7a-4514-a358-ad97c74854c2", "documentation": "Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.", "method": "post", "endpoint": "v2/:connection:executeSqlQuery", "responses": [ { "uuid": "a609a3a9-7887-4358-a09a-1f19387ad355", "body": "{\n \"results\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "407cec55-83ea-4c2a-b246-883ae7f117fb", "documentation": "Deletes entities based on conditions specified in the request and not on entity id.", "method": "post", "endpoint": "v2/:entityType/entities:deleteEntitiesWithConditions", "responses": [ { "uuid": "b884a7e0-d744-4fb2-b9fa-e0de8fecdbfc", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5fa64758-6ab4-412c-acb4-f0b17498acc1", "documentation": "Updates entities based on conditions specified in the request and not on entity id.", "method": "post", "endpoint": "v2/:entityType/entities:updateEntitiesWithConditions", "responses": [ { "uuid": "90f48bd2-9bf9-4e33-b2ee-7d5a905e1ef4", "body": "{\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6032eeca-72e3-4638-990b-071dbaf7184b", "documentation": "Deletes an existing entity row matching the entity type and entity id specified in the request.", "method": "delete", "endpoint": "v2/:name", "responses": [ { "uuid": "6e556009-a87e-4a2a-8eb2-91f33305ea4d", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "00219d32-19a2-48ac-8687-0a0a76366748", "documentation": "Gets a single entity row matching the entity type and entity id specified in the request.", "method": "get", "endpoint": "v2/:name", "responses": [ { "uuid": "1a4e24a6-dc35-4e7c-bb9c-d83655865850", "body": "{\n \"fields\": {},\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0615014-272b-4a2f-8848-a04375c9e569", "documentation": "Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.", "method": "patch", "endpoint": "v2/:name", "responses": [ { "uuid": "7739f7c9-b7dd-44ca-a1eb-fc218c04a05c", "body": "{\n \"fields\": {},\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9bc26fcc-7b40-4f5f-af17-61389e1986e9", "documentation": "Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.", "method": "post", "endpoint": "v2/:name:execute", "responses": [ { "uuid": "24268deb-8913-4b1e-9c1e-1e848442a65c", "body": "{\n \"results\": [\n {}\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3804056c-4107-4c22-9134-3a7bac5e9e0e", "documentation": "Gets the schema of all the actions supported by the connector.", "method": "get", "endpoint": "v2/:parent/actions", "responses": [ { "uuid": "96f59c46-a989-41c8-a3ee-6299fe53ad4f", "body": "{\n \"actions\": [\n {\n \"inputParameters\": [\n {\n \"dataType\": \"{{oneOf (array 'DATA_TYPE_UNSPECIFIED' 'INT' 'SMALLINT' 'DOUBLE' 'DATE' 'DATETIME' 'TIME' 'STRING' 'LONG' 'BOOLEAN' 'DECIMAL' 'UUID' 'BLOB' 'BIT' 'TINYINT' 'INTEGER' 'BIGINT' 'FLOAT' 'REAL' 'NUMERIC' 'CHAR' 'VARCHAR' 'LONGVARCHAR' 'TIMESTAMP' 'NCHAR' 'NVARCHAR' 'LONGNVARCHAR' 'NULL' 'OTHER' 'JAVA_OBJECT' 'DISTINCT' 'STRUCT' 'ARRAY' 'CLOB' 'REF' 'DATALINK' 'ROWID' 'BINARY' 'VARBINARY' 'LONGVARBINARY' 'NCLOB' 'SQLXML' 'REF_CURSOR' 'TIME_WITH_TIMEZONE' 'TIMESTAMP_WITH_TIMEZONE')}}\",\n \"defaultValue\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"nullable\": {{faker 'datatype.boolean'}}\n }\n ],\n \"name\": \"\",\n \"resultMetadata\": [\n {\n \"dataType\": \"{{oneOf (array 'DATA_TYPE_UNSPECIFIED' 'INT' 'SMALLINT' 'DOUBLE' 'DATE' 'DATETIME' 'TIME' 'STRING' 'LONG' 'BOOLEAN' 'DECIMAL' 'UUID' 'BLOB' 'BIT' 'TINYINT' 'INTEGER' 'BIGINT' 'FLOAT' 'REAL' 'NUMERIC' 'CHAR' 'VARCHAR' 'LONGVARCHAR' 'TIMESTAMP' 'NCHAR' 'NVARCHAR' 'LONGNVARCHAR' 'NULL' 'OTHER' 'JAVA_OBJECT' 'DISTINCT' 'STRUCT' 'ARRAY' 'CLOB' 'REF' 'DATALINK' 'ROWID' 'BINARY' 'VARBINARY' 'LONGVARBINARY' 'NCLOB' 'SQLXML' 'REF_CURSOR' 'TIME_WITH_TIMEZONE' 'TIMESTAMP_WITH_TIMEZONE')}}\",\n \"description\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ],\n \"nextPageToken\": \"\",\n \"unsupportedActionNames\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "06c0d739-8298-433a-8978-dd68a7aa772a", "documentation": "Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.", "method": "get", "endpoint": "v2/:parent/entities", "responses": [ { "uuid": "14ea8473-645b-4ec0-871f-294705028b5c", "body": "{\n \"entities\": [\n {\n \"fields\": {},\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2fb0d3e9-af31-4cea-8c49-ea662d941125", "documentation": "Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system.", "method": "post", "endpoint": "v2/:parent/entities", "responses": [ { "uuid": "7c070735-60b5-4cc7-a859-f84c2763f0ce", "body": "{\n \"fields\": {},\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1435d62-7a7f-4a5a-935a-2a7ed6e44f31", "documentation": "Lists metadata related to all entity types present in the external system.", "method": "get", "endpoint": "v2/:parent/entityTypes", "responses": [ { "uuid": "24b44cff-d251-4ac1-818b-d2db8b4b826a", "body": "{\n \"nextPageToken\": \"\",\n \"types\": [\n {\n \"fields\": [\n {\n \"additionalDetails\": {},\n \"dataType\": \"{{oneOf (array 'DATA_TYPE_UNSPECIFIED' 'INT' 'SMALLINT' 'DOUBLE' 'DATE' 'DATETIME' 'TIME' 'STRING' 'LONG' 'BOOLEAN' 'DECIMAL' 'UUID' 'BLOB' 'BIT' 'TINYINT' 'INTEGER' 'BIGINT' 'FLOAT' 'REAL' 'NUMERIC' 'CHAR' 'VARCHAR' 'LONGVARCHAR' 'TIMESTAMP' 'NCHAR' 'NVARCHAR' 'LONGNVARCHAR' 'NULL' 'OTHER' 'JAVA_OBJECT' 'DISTINCT' 'STRUCT' 'ARRAY' 'CLOB' 'REF' 'DATALINK' 'ROWID' 'BINARY' 'VARBINARY' 'LONGVARBINARY' 'NCLOB' 'SQLXML' 'REF_CURSOR' 'TIME_WITH_TIMEZONE' 'TIMESTAMP_WITH_TIMEZONE')}}\",\n \"defaultValue\": \"\",\n \"description\": \"\",\n \"key\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"nullable\": {{faker 'datatype.boolean'}},\n \"reference\": {\n \"name\": \"\",\n \"type\": \"\"\n }\n }\n ],\n \"name\": \"\"\n }\n ],\n \"unsupportedTypeNames\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "ea1a8a48-5f7a-4514-a358-ad97c74854c2" }, { "type": "route", "uuid": "407cec55-83ea-4c2a-b246-883ae7f117fb" }, { "type": "route", "uuid": "5fa64758-6ab4-412c-acb4-f0b17498acc1" }, { "type": "route", "uuid": "6032eeca-72e3-4638-990b-071dbaf7184b" }, { "type": "route", "uuid": "00219d32-19a2-48ac-8687-0a0a76366748" }, { "type": "route", "uuid": "c0615014-272b-4a2f-8848-a04375c9e569" }, { "type": "route", "uuid": "9bc26fcc-7b40-4f5f-af17-61389e1986e9" }, { "type": "route", "uuid": "3804056c-4107-4c22-9134-3a7bac5e9e0e" }, { "type": "route", "uuid": "06c0d739-8298-433a-8978-dd68a7aa772a" }, { "type": "route", "uuid": "2fb0d3e9-af31-4cea-8c49-ea662d941125" }, { "type": "route", "uuid": "d1435d62-7a7f-4a5a-935a-2a7ed6e44f31" } ] }