{"type":"doc","content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"5f6ab1ae-b8b1-461b-b95c-70bce87528a1"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"INFO","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Add the following command after the username and password to receive more meaningful HTTP errors:","type":"text"}]},{"type":"codeBlock","content":[{"text":"-w\"\\n%{http_code}\\n\"","type":"text"}]},{"type":"paragraph","content":[{"text":"This command can be added to each call.","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"88edf616-9c0e-4e89-859b-3cd19454d9c9"},"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Create a Connection","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Request Method ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"POST","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Adds a connection in Datameer.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"URI Syntax","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"curl -u ':' -X POST -d @.json 'http://:/rest/connections'","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"{\n\"configuration-id\": 8,\n\"status\": \"success\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Additional Notes","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":".json","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The payload is a JSON representation of all information entered during the creation process using the web interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An easy method of creating a payload is to use REST to read an import job, data link, or workbook and change the JSON that is returned.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Encryption","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When creating a connection and the password or SSH key is in plain text within the JSON file, the sensitive data will not be secure while passing from the local host over the network until encrypted by Datameer.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Datameer X provides the tool ","type":"text"},{"text":"encrypt.sh","type":"text","marks":[{"type":"code"}]},{"text":" that can encrypt sensitive information before it is sent via REST to Datameer.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The tool is called ","type":"text"},{"text":"encrypt.sh","type":"text","marks":[{"type":"code"}]},{"text":" and is located in the bin folder within Datameer.","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Syntax:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"encrypt.sh -v ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Example Response:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"SECURE:0:hnDNk3ZOWZn9bwDiGp7MNuvyEZPHIinQ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This encrypted password or SSH key can then be added to the JSON file used in creating a connection to securely transfer the information.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Knowledge Base Article:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"How to create a connection via REST API calls","type":"text","marks":[{"type":"link","attrs":{"href":"https://datameer.zendesk.com/hc/en-us/articles/204492354-How-to-create-a-connection-via-REST-API-calls"}}]}]},{"type":"paragraph","content":[{"text":"Creating a missing folder","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"A new folder is created when all connection capabilities and permissions are sufficient.","type":"text"}]}]}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"d8c5cc1f-1727-42db-9272-4d611f759653"},"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Read a Connection","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Request Method ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns information on a specified connector within Datameer X including version number, class name, file information (uuid, path, description, name), typeID, and properties information.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"URI Syntax","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"curl -u ':' -X GET 'http://:/rest/connections/'","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"{\n \"version\": \"2.1\",\n \"className\": \"datameer.dap.common.entity.DataBaseConnection\",\n \"file\": {\n \"uuid\": \"23905938-5bd0-42da-afff-f39bd4b11ac0\",\n \"path\": \"/Data/Connections/MYSQL_QA1.dst\",\n \"description\": \"MySQL Connection\",\n \"name\": \"MYSQL_QA1\"\n },\n \"typeId\": \"das.JdbcDataStoreType\",\n \"properties\": {\n \"user_name\": [\n \"extuser\"\n ],\n \"password\": [\n \"L5lhAwwiuHjl/h08r0pVAg==\\r\\n\"\n ],\n \"key.connectionUrl\": [\n \"jdbc:mysql://ec2-23-22-91-33.compute-1.amazonaws.com:3306/world\"\n ],\n \"dataStoreTemplate\": [\n \"false\"\n ],\n \"dataStoreUsage\": [\n \"IMPORT_EXPORT\"\n ]\n },\n \"dbType\": {\n \"name\": \"MySQL\"\n }\n}","type":"text"}]}]}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"bf9bc20a-5a31-4a54-80f3-20ac29c035d5"},"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"List All Connections","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Request Method ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns a list of all the connections in Datameer. This list displays the description, id number, name, path, and uuid of the connector. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"URI Syntax","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"curl -u ':' -X GET 'http://::' -X PUT -d @.json 'http://:/rest/connections/'","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"{\"status\": \"success\"}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Additional Notes","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":".json","type":"text","marks":[{"type":"code"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The payload is a JSON representation of all information entered during the creation process using the web interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An easy method of creating a payload is to use REST to read an import job, data link, or workbook and change the JSON that is returned.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Creating a missing folder","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"A new folder is created when all connection capabilities and permissions are sufficient.","type":"text"}]}]}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"20e366e4-6b39-4292-8b57-cc707b3e5b6c"},"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Delete a Connection","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Request Method ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"DELETE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Removes a connection from Datameer.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"URI Syntax","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"curl -u ':' -X DELETE 'http://:/rest/connections/'","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"{\"status\": \"success\"}","type":"text"}]}]}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"6e1b6b00-6046-4e75-afdf-6a9d2fceec96"},"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Connection Dependencies","type":"text"}]},{"type":"table","content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Request Method ","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"GET","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns the hierarchy of up- and downstream dependencies for a given connection.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Prerequisites","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"INFO","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"This API requires enabling ","type":"text"},{"text":"Datameer's Advanced Governance plug-in","type":"text","marks":[{"type":"link","attrs":{"href":"https://datameer.atlassian.net/wiki/spaces/DASSB100/pages/32569527063/Advanced+Governance#AdvancedGovernance-dependencies"}}]},{"text":".","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"URI Syntax","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"curl -u ':' -X GET 'http://:/api/connections//dependencies[?direction=][&level=]'","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Example Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"{\n \"dependencies\": [\n {\n \"id\": 13,\n \"file\": {\n \"path\": \"/Data/ImportJobs/TechCrunch_continental_USA\",\n \"name\": \"TechCrunch_continental_USA\",\n \"type\": \"imp\",\n \"description\": \"A listing of company funding records reported by TechCrunch.\",\n \"uuid\": \"47c25d9a-6a71-4778-8f88-c42217b39a08\"\n }\n },\n {\n \"id\": 10,\n \"file\": {\n \"path\": \"/Data/ImportJobs/Sales_Jan_2009\",\n \"name\": \"Sales_Jan_2009\",\n \"type\": \"imp\",\n \"description\": \"Sales transactions during the month of January 2009.\",\n \"uuid\": \"158dc464-db46-4da8-af51-cf8be06cadc4\"\n }\n }","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"background":"#f0f0f0","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Additional Notes","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Path parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"configurationId:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Data type must be a ","type":"text"},{"text":"number","type":"text","marks":[{"type":"link","attrs":{"href":"https://datameer.atlassian.net/wiki/spaces/DAS70/pages/31973462012/Data+Field+Types+in+Datameer#DataFieldTypesinDatameer-number"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the configuration ID","type":"text"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Query parameters:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Direction:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Data type must be a ","type":"text"},{"text":"string","type":"text","marks":[{"type":"link","attrs":{"href":"https://datameer.atlassian.net/wiki/spaces/DAS70/pages/31973462012/Data+Field+Types+in+Datameer#DataFieldTypesinDatameer-string"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Shows either upstream or downstream","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If left blank, shows both","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Level:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Data type must be a ","type":"text"},{"text":"number","type":"text","marks":[{"type":"link","attrs":{"href":"https://datameer.atlassian.net/wiki/spaces/DAS70/pages/31973462012/Data+Field+Types+in+Datameer#DataFieldTypesinDatameer-number"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optional","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If left blank, shows all levels","type":"text"}]}]}]}]}]}]}]}]}]}],"version":1}

REST API Connections