{"__v":0,"_id":"588f722cbcace50f0052ba2d","category":{"version":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","_id":"588f722bbcace50f0052b9e6","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T18:09:36.891Z","from_sync":false,"order":4,"slug":"dashboard-api","title":"Dashboard API"},"parentDoc":null,"project":"565f5fa26bafd40d0030a064","user":"565f3941ea46251700972783","version":{"__v":1,"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-21T18:59:54.396Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -b cookies.txt -c cookies.txt -H \"Accept: application/json\" -H \"Content-Type: application/json\" -X GET  https://api.nanoscale.io/apis/13/remote_endpoints/87"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"remote_endpoint\": {\n        \"api_id\": 13,\n        \"id\": 87,\n        \"name\": \"Geolocation\",\n        \"codename\": \"places\",\n        \"description\": \"\",\n        \"type\": \"http\",\n        \"status\": null,\n        \"status_message\": null,\n        \"data\": {\n            \"url\": \"https://maps.googleapis.com/maps/api/geocode/json\",\n            \"query\": {\n                \"key\": \"\\u003cENTER YOUR API KEY\\u003e\"\n            },\n            \"method\": \"GET\",\n            \"headers\": {}\n        },\n        \"environment_data\": null\n    }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56a12aaa44f3d80d00a2c2d3","ref":"","in":"path","required":true,"desc":"The remote endpoint's id","default":"","type":"string","name":"id"}],"url":"/remote_endpoints/:id"},"isReference":true,"order":17,"body":"Calling the `remote_endpoints/:id` endpoint will return the full `remote_endpoint` JSON object.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"api_id\",\n    \"1-0\": \"id\",\n    \"2-0\": \"name\",\n    \"3-0\": \"codename\",\n    \"4-0\": \"description\",\n    \"5-0\": \"type\",\n    \"6-0\": \"status\",\n    \"7-0\": \"status_message\",\n    \"8-0\": \"data\",\n    \"9-0\": \"environment_data\",\n    \"0-1\": \"`number`\",\n    \"1-1\": \"`number`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"8-1\": \"`object`\",\n    \"9-1\": \"`array`\",\n    \"0-2\": \"The API identifier\",\n    \"1-2\": \"The remote endpoint identifier\",\n    \"2-2\": \"The name of the remote endpoint\",\n    \"3-2\": \"The variable name that is used to refer to the remote endpoint from javascript.\",\n    \"4-2\": \"The description of the remote endpoint\",\n    \"5-2\": \"The type of remote endpoint. It can be one of the following types: `http`, `soap`, `sqlserver`, `postgres`, `mysql`, `mongodb`\",\n    \"6-2\": \"indicates whether the latest background processing operation was successful, failed, or is in process. It can be one of the following types: `\\\"Pending\\\"`, `\\\"Processing\\\"`, `\\\"Failed\\\"`, `\\\"Success\\\"`.\\n\\nStatus is used for asynchronous processing (currently only with SOAP remote endpoints) related to a remote endpoint.  when a SOAP endpoint is created, some background processing is done to ingest the WSDL and generate code using the Java JAX-WS framework.\",\n    \"7-2\": \"A human readable description of what went wrong, in the case that status indicates `error`.\",\n    \"8-2\": \"Configuration properties that pertain to the remote endpoint.\\n\\nExplained [below](http://google.com)\",\n    \"9-2\": \"Environment-specific overrides for the values in the data configuration object.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\nThe following data configuration properties pertain to their respective remote endpoint types.\n\n\n## HTTP\n\nData configuration objects for remote endpoints of type `http` use the following configuration properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"url\",\n    \"1-0\": \"query\",\n    \"2-0\": \"method\",\n    \"3-0\": \"headers\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`object`\",\n    \"0-2\": \"The url of the remote endpoint.\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The method of the remote endpoint call. It can be any of the following types: `GET`, `PUT`, `POST`, `DELETE`.\",\n    \"3-2\": \"The headers sent to the remote endpoint.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nHere is an example of a remote endpoint of type `http`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_id\\\": 13,\\n    \\\"id\\\": 83,\\n    \\\"name\\\": \\\"Event - POST\\\",\\n    \\\"codename\\\": \\\"createEvent\\\",\\n    \\\"description\\\": \\\"Create a new event.\\\",\\n    \\\"type\\\": \\\"http\\\",\\n    \\\"status\\\": null,\\n    \\\"status_message\\\": null,\\n    \\\"data\\\": {\\n        \\\"url\\\": \\\"https://mocks.nanoscaleapi.io/v1/events/create\\\",\\n        \\\"query\\\": {},\\n        \\\"method\\\": \\\"POST\\\",\\n        \\\"headers\\\": {\\n            \\\"Authorization\\\": \\\"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\\\"\\n        }\\n    },\\n    \\\"environment_data\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## SOAP\n\nData configuration objects for remote endpoints of type `soap` use the following configuration properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"url\",\n    \"1-0\": \"query\",\n    \"2-0\": \"headers\",\n    \"3-0\": \"serviceName\",\n    \"4-0\": \"wssePasswordCredentials\",\n    \"5-0\": \"wssePasswordCredentials/password\",\n    \"6-0\": \"wssePasswordCredentials/username\",\n    \"0-1\": \"`string`\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`object`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`object`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"0-2\": \"The url of the remote endpoint.\",\n    \"1-2\": \"The query parameters sent to the remote endpoint.\",\n    \"2-2\": \"The headers sent to the remote endpoint.\",\n    \"3-2\": \"The name of the SOAP service.\",\n    \"4-2\": \"The credentials for authenticating via WSSE against the SOAP endpoint.\",\n    \"5-2\": \"The password of the user for the SOAP service.\",\n    \"6-2\": \"The username of the user for the SOAP service.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\nHere is an example of a remote endpoint of type `soap`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_id\\\": 13,\\n    \\\"id\\\": 83,\\n    \\\"name\\\": \\\"Event - POST\\\",\\n    \\\"codename\\\": \\\"createEvent\\\",\\n    \\\"description\\\": \\\"Create a new event.\\\",\\n    \\\"type\\\": \\\"http\\\",\\n    \\\"status\\\": null,\\n    \\\"status_message\\\": null,\\n    \\\"data\\\": {\\n        \\\"url\\\": \\\"https://mocks.nanoscaleapi.io/v1/events/create\\\",\\n        \\\"query\\\": {},\\n        \\\"method\\\": \\\"POST\\\",\\n        \\\"headers\\\": {\\n            \\\"Authorization\\\": \\\"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\\\"\\n        }\\n    },\\n    \\\"environment_data\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## ## MongoDB\n\nData configuration objects for remote endpoints of type `mongodb` use the following configuration properties:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"limit\",\n    \"1-0\": \"config\",\n    \"2-0\": \"config/hosts\",\n    \"3-0\": \"config/host/id\",\n    \"4-0\": \"config/host/host\",\n    \"5-0\": \"config/host/port\",\n    \"6-0\": \"config/database\",\n    \"7-0\": \"config/password\",\n    \"8-0\": \"config/username\",\n    \"0-1\": \"`number`\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`array`\",\n    \"3-1\": \"`number`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`number`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"8-1\": \"`string`\",\n    \"0-2\": \"The size of the database pool. This refers to the maximum number of simultaneous clients that can be supported.\",\n    \"1-2\": \"The configuration properties specific to the database.\",\n    \"2-2\": \"The array of servers running the mongoDB instance(s).\",\n    \"3-2\": \"The host identifier.\",\n    \"4-2\": \"The host name or ip address of the server running the mongoDB instance.\",\n    \"5-2\": \"The port on the server that the mongoDB instance is running on.\",\n    \"6-2\": \"The name of the database in the mongoDB instance.\",\n    \"7-2\": \"The password of the user for the database.\",\n    \"8-2\": \"The username of the user for the database.\",\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\nHere is an example of a remote endpoint of type `mongodb`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_id\\\": 13,\\n    \\\"id\\\": 90,\\n    \\\"name\\\": \\\"MongoLab\\\",\\n    \\\"codename\\\": \\\"mongo\\\",\\n    \\\"description\\\": \\\"MongoDB\\\",\\n    \\\"type\\\": \\\"mongodb\\\",\\n    \\\"status\\\": null,\\n    \\\"status_message\\\": null,\\n    \\\"data\\\": {\\n        \\\"limit\\\": 4096,\\n        \\\"config\\\": {\\n            \\\"hosts\\\": [\\n                {\\n                    \\\"id\\\": \\\"7\\\",\\n                    \\\"host\\\": \\\"CHANGE ME\\\",\\n                    \\\"port\\\": 33113\\n                }\\n            ],\\n            \\\"database\\\": \\\"CHANGE ME\\\",\\n            \\\"password\\\": \\\"CHANGE ME\\\",\\n            \\\"username\\\": \\\"CHANGE ME\\\"\\n        }\\n    },\\n    \\\"environment_data\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## SQL Server\n\nData configuration objects for remote endpoints of type `mssql` use the following configuration properties:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"config\",\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-1\": \"`object`\",\n    \"0-2\": \"The configuration properties specific to the database.\",\n    \"1-0\": \"config/port\",\n    \"2-0\": \"config/schema\",\n    \"3-0\": \"config/server\",\n    \"4-0\": \"config/user id\",\n    \"5-0\": \"config/database\",\n    \"6-0\": \"config/password\",\n    \"7-0\": \"config/connection timeout\",\n    \"8-0\": \"maxIdleConn\",\n    \"9-0\": \"maxOpenConn\",\n    \"10-0\": \"transactions\",\n    \"1-1\": \"`number`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`number`\",\n    \"8-1\": \"`number`\",\n    \"9-1\": \"`number`\",\n    \"10-1\": \"`boolean`\",\n    \"1-2\": \"The port on the server that the SQL Server instance is running on.\",\n    \"2-2\": \"The name of the schema within the database.\",\n    \"3-2\": \"The host name or ip address of the server running the SQL Server instance.\",\n    \"4-2\": \"The user id of the user for the database.\",\n    \"5-2\": \"The name of the database in the SQL Server instance.\",\n    \"6-2\": \"The password of the user for the database.\",\n    \"7-2\": \"The number of seconds before the connection to the database times out.\",\n    \"8-2\": \"The maximum number of simultaneous idle connections the database supports.\",\n    \"9-2\": \"The maximum number of simultaneous open connections the database supports.\",\n    \"10-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\nHere is an example of a remote endpoint of type `mssql`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_id\\\": 13,\\n    \\\"id\\\": 91,\\n    \\\"name\\\": \\\"MsSqlServer\\\",\\n    \\\"codename\\\": \\\"mssql\\\",\\n    \\\"description\\\": \\\"\\\",\\n    \\\"type\\\": \\\"sqlserver\\\",\\n    \\\"status\\\": null,\\n    \\\"status_message\\\": null,\\n    \\\"data\\\": {\\n        \\\"config\\\": {\\n            \\\"port\\\": 1433,\\n            \\\"schema\\\": \\\"\\\",\\n            \\\"server\\\": \\\"CHANGE ME\\\",\\n            \\\"user id\\\": \\\"CHANGE ME\\\",\\n            \\\"database\\\": \\\"hats\\\",\\n            \\\"password\\\": \\\"CHANGE ME\\\",\\n            \\\"connection timeout\\\": 30\\n        },\\n        \\\"maxIdleConn\\\": 30,\\n        \\\"maxOpenConn\\\": 30,\\n        \\\"transactions\\\": true\\n    },\\n    \\\"environment_data\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## PostgreSQL\n\nData configuration objects for remote endpoints of type `postgres` use the following configuration properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"config\",\n    \"1-0\": \"config/host\",\n    \"2-0\": \"config/port\",\n    \"3-0\": \"config/user\",\n    \"4-0\": \"config/dbname\",\n    \"5-0\": \"config/sslmode\",\n    \"6-0\": \"config/password\",\n    \"7-0\": \"maxIdleConn\",\n    \"8-0\": \"maxOpenConn\",\n    \"9-0\": \"transactions\",\n    \"0-1\": \"`object`\",\n    \"1-1\": \"`string`\",\n    \"2-1\": \"`number`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`number`\",\n    \"8-1\": \"`number`\",\n    \"9-1\": \"`boolean`\",\n    \"0-2\": \"The configuration properties specific to the database.\",\n    \"1-2\": \"The host name or ip address of the server running the PostgreSQL instance.\",\n    \"2-2\": \"The port on the server that the PostgreSQL instance is running on.\",\n    \"3-2\": \"The name of the user for the database.\",\n    \"4-2\": \"The name of the database in the PostgreSQL instance.\",\n    \"5-2\": \"Indicates to the PostgreSQL instance how to establish SSL connectivity. It can be one of the following types: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`.\\n\\nMore information can be found [here](http://www.postgresql.org/docs/9.1/static/libpq-ssl.html).\",\n    \"6-2\": \"The password of the user for the database.\",\n    \"7-2\": \"The maximum number of simultaneous idle connections the database supports.\",\n    \"8-2\": \"The maximum number of simultaneous open connections the database supports.\",\n    \"9-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\nHere is an example of a remote endpoint of type `postgres`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_id\\\": 13,\\n    \\\"id\\\": 92,\\n    \\\"name\\\": \\\"Pg\\\",\\n    \\\"codename\\\": \\\"Pg\\\",\\n    \\\"description\\\": \\\"Postgres database\\\",\\n    \\\"type\\\": \\\"postgres\\\",\\n    \\\"status\\\": null,\\n    \\\"status_message\\\": null,\\n    \\\"data\\\": {\\n        \\\"config\\\": {\\n            \\\"host\\\": \\\"CHANGE ME\\\",\\n            \\\"port\\\": 5432,\\n            \\\"user\\\": \\\"CHANGE ME\\\",\\n            \\\"dbname\\\": \\\"CHANGE ME\\\",\\n            \\\"sslmode\\\": \\\"disable\\\",\\n            \\\"password\\\": \\\"CHANGE ME\\\"\\n        },\\n        \\\"maxIdleConn\\\": 30,\\n        \\\"maxOpenConn\\\": 30,\\n        \\\"transactions\\\": false\\n    },\\n    \\\"environment_data\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## MySQL\n\nData configuration objects for remote endpoints of type `mysql` use the following configuration properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"query\",\n    \"1-0\": \"config\",\n    \"2-0\": \"config/port\",\n    \"3-0\": \"config/dbname\",\n    \"4-0\": \"config/server\",\n    \"5-0\": \"config/timeout\",\n    \"6-0\": \"config/password\",\n    \"7-0\": \"config/username\",\n    \"8-0\": \"headers\",\n    \"9-0\": \"maxIdleConn\",\n    \"10-0\": \"maxOpenConn\",\n    \"11-0\": \"transactions\",\n    \"0-1\": \"`object`\",\n    \"1-1\": \"`object`\",\n    \"2-1\": \"`number`\",\n    \"3-1\": \"`string`\",\n    \"4-1\": \"`string`\",\n    \"5-1\": \"`string`\",\n    \"6-1\": \"`string`\",\n    \"7-1\": \"`string`\",\n    \"8-1\": \"`object`\",\n    \"11-1\": \"`boolean`\",\n    \"9-1\": \"`number`\",\n    \"10-1\": \"`number`\",\n    \"0-2\": \"The query parameters sent to the remote endpoint.\",\n    \"1-2\": \"The configuration properties specific to the database.\",\n    \"2-2\": \"The port on the server that the MySQL instance is running on.\",\n    \"3-2\": \"The name of the database in the MySQL instance.\",\n    \"4-2\": \"The host name or ip address of the server running the MySQL instance.\",\n    \"5-2\": \"The number of seconds before the connection to the database times out.\",\n    \"6-2\": \"The password of the user for the database.\",\n    \"7-2\": \"The username of the user for the database.\",\n    \"8-2\": \"The headers sent to the remote endpoint.\",\n    \"9-2\": \"The maximum number of simultaneous idle connections the database supports.\",\n    \"10-2\": \"The maximum number of simultaneous open connections the database supports.\",\n    \"11-2\": \"Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]\nHere is an example of a remote endpoint of type `mysql`:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"api_id\\\": 13,\\n    \\\"id\\\": 364,\\n    \\\"name\\\": \\\"testMySQL\\\",\\n    \\\"codename\\\": \\\"testMySQL\\\",\\n    \\\"description\\\": \\\"testMySQL\\\",\\n    \\\"type\\\": \\\"mysql\\\",\\n    \\\"status\\\": null,\\n    \\\"status_message\\\": null,\\n    \\\"data\\\": {\\n        \\\"query\\\": {},\\n        \\\"config\\\": {\\n            \\\"port\\\": 5000,\\n            \\\"dbname\\\": \\\"testMySQL\\\",\\n            \\\"server\\\": \\\"testMySQL\\\",\\n            \\\"timeout\\\": \\\"40s\\\",\\n            \\\"password\\\": \\\"testMySQL\\\",\\n            \\\"username\\\": \\\"testMySQL\\\"\\n        },\\n        \\\"headers\\\": {},\\n        \\\"maxIdleConn\\\": 40,\\n        \\\"maxOpenConn\\\": 40,\\n        \\\"transactions\\\": true\\n    },\\n    \\\"environment_data\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"remote_endpointsid","type":"endpoint","title":"/remote_endpoints/:id"}

get/remote_endpoints/:id


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The remote endpoint's id

Examples


Result Format


Documentation

Calling the `remote_endpoints/:id` endpoint will return the full `remote_endpoint` JSON object. [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "api_id", "1-0": "id", "2-0": "name", "3-0": "codename", "4-0": "description", "5-0": "type", "6-0": "status", "7-0": "status_message", "8-0": "data", "9-0": "environment_data", "0-1": "`number`", "1-1": "`number`", "2-1": "`string`", "3-1": "`string`", "4-1": "`string`", "5-1": "`string`", "6-1": "`string`", "7-1": "`string`", "8-1": "`object`", "9-1": "`array`", "0-2": "The API identifier", "1-2": "The remote endpoint identifier", "2-2": "The name of the remote endpoint", "3-2": "The variable name that is used to refer to the remote endpoint from javascript.", "4-2": "The description of the remote endpoint", "5-2": "The type of remote endpoint. It can be one of the following types: `http`, `soap`, `sqlserver`, `postgres`, `mysql`, `mongodb`", "6-2": "indicates whether the latest background processing operation was successful, failed, or is in process. It can be one of the following types: `\"Pending\"`, `\"Processing\"`, `\"Failed\"`, `\"Success\"`.\n\nStatus is used for asynchronous processing (currently only with SOAP remote endpoints) related to a remote endpoint. when a SOAP endpoint is created, some background processing is done to ingest the WSDL and generate code using the Java JAX-WS framework.", "7-2": "A human readable description of what went wrong, in the case that status indicates `error`.", "8-2": "Configuration properties that pertain to the remote endpoint.\n\nExplained [below](http://google.com)", "9-2": "Environment-specific overrides for the values in the data configuration object." }, "cols": 3, "rows": 10 } [/block] The following data configuration properties pertain to their respective remote endpoint types. ## HTTP Data configuration objects for remote endpoints of type `http` use the following configuration properties: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "url", "1-0": "query", "2-0": "method", "3-0": "headers", "0-1": "`string`", "1-1": "`object`", "2-1": "`string`", "3-1": "`object`", "0-2": "The url of the remote endpoint.", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The method of the remote endpoint call. It can be any of the following types: `GET`, `PUT`, `POST`, `DELETE`.", "3-2": "The headers sent to the remote endpoint." }, "cols": 3, "rows": 4 } [/block] Here is an example of a remote endpoint of type `http`: [block:code] { "codes": [ { "code": "{\n \"api_id\": 13,\n \"id\": 83,\n \"name\": \"Event - POST\",\n \"codename\": \"createEvent\",\n \"description\": \"Create a new event.\",\n \"type\": \"http\",\n \"status\": null,\n \"status_message\": null,\n \"data\": {\n \"url\": \"https://mocks.nanoscaleapi.io/v1/events/create\",\n \"query\": {},\n \"method\": \"POST\",\n \"headers\": {\n \"Authorization\": \"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\"\n }\n },\n \"environment_data\": null\n}", "language": "json" } ] } [/block] ## SOAP Data configuration objects for remote endpoints of type `soap` use the following configuration properties: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "url", "1-0": "query", "2-0": "headers", "3-0": "serviceName", "4-0": "wssePasswordCredentials", "5-0": "wssePasswordCredentials/password", "6-0": "wssePasswordCredentials/username", "0-1": "`string`", "1-1": "`object`", "2-1": "`object`", "3-1": "`string`", "4-1": "`object`", "5-1": "`string`", "6-1": "`string`", "0-2": "The url of the remote endpoint.", "1-2": "The query parameters sent to the remote endpoint.", "2-2": "The headers sent to the remote endpoint.", "3-2": "The name of the SOAP service.", "4-2": "The credentials for authenticating via WSSE against the SOAP endpoint.", "5-2": "The password of the user for the SOAP service.", "6-2": "The username of the user for the SOAP service." }, "cols": 3, "rows": 7 } [/block] Here is an example of a remote endpoint of type `soap`: [block:code] { "codes": [ { "code": "{\n \"api_id\": 13,\n \"id\": 83,\n \"name\": \"Event - POST\",\n \"codename\": \"createEvent\",\n \"description\": \"Create a new event.\",\n \"type\": \"http\",\n \"status\": null,\n \"status_message\": null,\n \"data\": {\n \"url\": \"https://mocks.nanoscaleapi.io/v1/events/create\",\n \"query\": {},\n \"method\": \"POST\",\n \"headers\": {\n \"Authorization\": \"Basic YW55cHJlc2VuY2U6cGFzc3dvcmQ=\"\n }\n },\n \"environment_data\": null\n}", "language": "json" } ] } [/block] ## ## MongoDB Data configuration objects for remote endpoints of type `mongodb` use the following configuration properties: [block:parameters] { "data": { "0-0": "limit", "1-0": "config", "2-0": "config/hosts", "3-0": "config/host/id", "4-0": "config/host/host", "5-0": "config/host/port", "6-0": "config/database", "7-0": "config/password", "8-0": "config/username", "0-1": "`number`", "1-1": "`object`", "2-1": "`array`", "3-1": "`number`", "4-1": "`string`", "5-1": "`number`", "6-1": "`string`", "7-1": "`string`", "8-1": "`string`", "0-2": "The size of the database pool. This refers to the maximum number of simultaneous clients that can be supported.", "1-2": "The configuration properties specific to the database.", "2-2": "The array of servers running the mongoDB instance(s).", "3-2": "The host identifier.", "4-2": "The host name or ip address of the server running the mongoDB instance.", "5-2": "The port on the server that the mongoDB instance is running on.", "6-2": "The name of the database in the mongoDB instance.", "7-2": "The password of the user for the database.", "8-2": "The username of the user for the database.", "h-0": "key", "h-1": "type", "h-2": "description" }, "cols": 3, "rows": 9 } [/block] Here is an example of a remote endpoint of type `mongodb`: [block:code] { "codes": [ { "code": "{\n \"api_id\": 13,\n \"id\": 90,\n \"name\": \"MongoLab\",\n \"codename\": \"mongo\",\n \"description\": \"MongoDB\",\n \"type\": \"mongodb\",\n \"status\": null,\n \"status_message\": null,\n \"data\": {\n \"limit\": 4096,\n \"config\": {\n \"hosts\": [\n {\n \"id\": \"7\",\n \"host\": \"CHANGE ME\",\n \"port\": 33113\n }\n ],\n \"database\": \"CHANGE ME\",\n \"password\": \"CHANGE ME\",\n \"username\": \"CHANGE ME\"\n }\n },\n \"environment_data\": null\n}", "language": "json" } ] } [/block] ## SQL Server Data configuration objects for remote endpoints of type `mssql` use the following configuration properties: [block:parameters] { "data": { "0-0": "config", "h-0": "key", "h-1": "type", "h-2": "description", "0-1": "`object`", "0-2": "The configuration properties specific to the database.", "1-0": "config/port", "2-0": "config/schema", "3-0": "config/server", "4-0": "config/user id", "5-0": "config/database", "6-0": "config/password", "7-0": "config/connection timeout", "8-0": "maxIdleConn", "9-0": "maxOpenConn", "10-0": "transactions", "1-1": "`number`", "2-1": "`string`", "3-1": "`string`", "4-1": "`string`", "5-1": "`string`", "6-1": "`string`", "7-1": "`number`", "8-1": "`number`", "9-1": "`number`", "10-1": "`boolean`", "1-2": "The port on the server that the SQL Server instance is running on.", "2-2": "The name of the schema within the database.", "3-2": "The host name or ip address of the server running the SQL Server instance.", "4-2": "The user id of the user for the database.", "5-2": "The name of the database in the SQL Server instance.", "6-2": "The password of the user for the database.", "7-2": "The number of seconds before the connection to the database times out.", "8-2": "The maximum number of simultaneous idle connections the database supports.", "9-2": "The maximum number of simultaneous open connections the database supports.", "10-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction." }, "cols": 3, "rows": 11 } [/block] Here is an example of a remote endpoint of type `mssql`: [block:code] { "codes": [ { "code": "{\n \"api_id\": 13,\n \"id\": 91,\n \"name\": \"MsSqlServer\",\n \"codename\": \"mssql\",\n \"description\": \"\",\n \"type\": \"sqlserver\",\n \"status\": null,\n \"status_message\": null,\n \"data\": {\n \"config\": {\n \"port\": 1433,\n \"schema\": \"\",\n \"server\": \"CHANGE ME\",\n \"user id\": \"CHANGE ME\",\n \"database\": \"hats\",\n \"password\": \"CHANGE ME\",\n \"connection timeout\": 30\n },\n \"maxIdleConn\": 30,\n \"maxOpenConn\": 30,\n \"transactions\": true\n },\n \"environment_data\": null\n}", "language": "json" } ] } [/block] ## PostgreSQL Data configuration objects for remote endpoints of type `postgres` use the following configuration properties: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "config", "1-0": "config/host", "2-0": "config/port", "3-0": "config/user", "4-0": "config/dbname", "5-0": "config/sslmode", "6-0": "config/password", "7-0": "maxIdleConn", "8-0": "maxOpenConn", "9-0": "transactions", "0-1": "`object`", "1-1": "`string`", "2-1": "`number`", "3-1": "`string`", "4-1": "`string`", "5-1": "`string`", "6-1": "`string`", "7-1": "`number`", "8-1": "`number`", "9-1": "`boolean`", "0-2": "The configuration properties specific to the database.", "1-2": "The host name or ip address of the server running the PostgreSQL instance.", "2-2": "The port on the server that the PostgreSQL instance is running on.", "3-2": "The name of the user for the database.", "4-2": "The name of the database in the PostgreSQL instance.", "5-2": "Indicates to the PostgreSQL instance how to establish SSL connectivity. It can be one of the following types: `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`.\n\nMore information can be found [here](http://www.postgresql.org/docs/9.1/static/libpq-ssl.html).", "6-2": "The password of the user for the database.", "7-2": "The maximum number of simultaneous idle connections the database supports.", "8-2": "The maximum number of simultaneous open connections the database supports.", "9-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction." }, "cols": 3, "rows": 10 } [/block] Here is an example of a remote endpoint of type `postgres`: [block:code] { "codes": [ { "code": "{\n \"api_id\": 13,\n \"id\": 92,\n \"name\": \"Pg\",\n \"codename\": \"Pg\",\n \"description\": \"Postgres database\",\n \"type\": \"postgres\",\n \"status\": null,\n \"status_message\": null,\n \"data\": {\n \"config\": {\n \"host\": \"CHANGE ME\",\n \"port\": 5432,\n \"user\": \"CHANGE ME\",\n \"dbname\": \"CHANGE ME\",\n \"sslmode\": \"disable\",\n \"password\": \"CHANGE ME\"\n },\n \"maxIdleConn\": 30,\n \"maxOpenConn\": 30,\n \"transactions\": false\n },\n \"environment_data\": null\n}", "language": "json" } ] } [/block] ## MySQL Data configuration objects for remote endpoints of type `mysql` use the following configuration properties: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "query", "1-0": "config", "2-0": "config/port", "3-0": "config/dbname", "4-0": "config/server", "5-0": "config/timeout", "6-0": "config/password", "7-0": "config/username", "8-0": "headers", "9-0": "maxIdleConn", "10-0": "maxOpenConn", "11-0": "transactions", "0-1": "`object`", "1-1": "`object`", "2-1": "`number`", "3-1": "`string`", "4-1": "`string`", "5-1": "`string`", "6-1": "`string`", "7-1": "`string`", "8-1": "`object`", "11-1": "`boolean`", "9-1": "`number`", "10-1": "`number`", "0-2": "The query parameters sent to the remote endpoint.", "1-2": "The configuration properties specific to the database.", "2-2": "The port on the server that the MySQL instance is running on.", "3-2": "The name of the database in the MySQL instance.", "4-2": "The host name or ip address of the server running the MySQL instance.", "5-2": "The number of seconds before the connection to the database times out.", "6-2": "The password of the user for the database.", "7-2": "The username of the user for the database.", "8-2": "The headers sent to the remote endpoint.", "9-2": "The maximum number of simultaneous idle connections the database supports.", "10-2": "The maximum number of simultaneous open connections the database supports.", "11-2": "Indicates wether the database supports transactions. If set to `true` then db queries are done in a transaction." }, "cols": 3, "rows": 12 } [/block] Here is an example of a remote endpoint of type `mysql`: [block:code] { "codes": [ { "code": "{\n \"api_id\": 13,\n \"id\": 364,\n \"name\": \"testMySQL\",\n \"codename\": \"testMySQL\",\n \"description\": \"testMySQL\",\n \"type\": \"mysql\",\n \"status\": null,\n \"status_message\": null,\n \"data\": {\n \"query\": {},\n \"config\": {\n \"port\": 5000,\n \"dbname\": \"testMySQL\",\n \"server\": \"testMySQL\",\n \"timeout\": \"40s\",\n \"password\": \"testMySQL\",\n \"username\": \"testMySQL\"\n },\n \"headers\": {},\n \"maxIdleConn\": 40,\n \"maxOpenConn\": 40,\n \"transactions\": true\n },\n \"environment_data\": null\n}", "language": "json" } ] } [/block]