@daptin/daptin-client

<!DOCTYPE HTML><html><head><title>Daptin server API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.0.0"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.3.0/highlight.min.js"></script><script type="text/javascript"> $(document).ready(function() { $('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) { hljs.highlightBlock(block); }); $('[data-toggle]').click(function() { var selector = $(this).data('target') + ' pre code'; $(selector).each(function(i, block) { hljs.highlightBlock(block); }); }); // open modal on hashes like #_action_get $(window).bind('hashchange', function(e) { var anchor_id = document.location.hash.substr(1); //strip # var element = $('#' + anchor_id); // do we have such element + is it a modal? --> show it if (element.length && element.hasClass('modal')) { element.modal('show'); } }); // execute hashchange on first page load $(window).trigger('hashchange'); // remove url fragment on modal hide $('.modal').on('hidden.bs.modal', function() { try { if (history && history.replaceState) { history.replaceState({}, '', '#'); } } catch(e) {} }); }); </script><style> .hljs { background: transparent; } .parent { color: #999; } .list-group-item > .badge { float: none; margin-right: 6px; } .panel-title > .methods { float: right; } .badge { border-radius: 0; text-transform: uppercase; width: 70px; font-weight: normal; color: #f3f3f6; line-height: normal; } .badge_get { background-color: #63a8e2; } .badge_post { background-color: #6cbd7d; } .badge_put { background-color: #22bac4; } .badge_delete { background-color: #d26460; } .badge_patch { background-color: #ccc444; } .list-group, .panel-group { margin-bottom: 0; } .panel-group .panel+.panel-white { margin-top: 0; } .panel-group .panel-white { border-bottom: 1px solid #F5F5F5; border-radius: 0; } .panel-white:last-child { border-bottom-color: white; -webkit-box-shadow: none; box-shadow: none; } .panel-white .panel-heading { background: white; } .tab-pane ul { padding-left: 2em; } .tab-pane h1 { font-size: 1.3em; } .tab-pane h2 { font-size: 1.2em; padding-bottom: 4px; border-bottom: 1px solid #ddd; } .tab-pane h3 { font-size: 1.1em; } .tab-content { border-left: 1px solid #ddd; border-right: 1px solid #ddd; border-bottom: 1px solid #ddd; padding: 10px; } #sidebar { margin-top: 30px; padding-right: 5px; overflow: auto; height: 90%; } .top-resource-description { border-bottom: 1px solid #ddd; background: #fcfcfc; padding: 15px 15px 0 15px; margin: -15px -15px 10px -15px; } .resource-description { border-bottom: 1px solid #fcfcfc; background: #fcfcfc; padding: 15px 15px 0 15px; margin: -15px -15px 10px -15px; } .resource-description p:last-child { margin: 0; } .list-group .badge { float: left; } .method_description { margin-left: 85px; } .method_description p:last-child { margin: 0; } .list-group-item { cursor: pointer; } .list-group-item:hover { background-color: #f5f5f5; } pre code { overflow: auto; word-wrap: normal; white-space: pre; } .items { background: #f5f5f5; color: #333; border: 1px solid #ccc; border-radius: 4px; padding: 9.5px; margin: 0 0 10px; font-size: 13px; line-height: 1.42857143; } .examples { margin-left: 0.5em; } .resource-modal li > ul { margin-bottom: 1em; } </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Daptin server API documentation <small>version v1</small></h1><p>http://</p></div><div class="panel panel-default"><div class="panel-heading"><h3 id="action_cloud_store" class="panel-title">Actions defined over Cloud store</h3></div><div class="panel-body"><div class="top-resource-description"><p>Actions defined over Cloud store</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_cloud_store_upload_file"><span class="parent">/action/cloud_store</span>/upload_file</a> <span class="methods"><a href="#action_cloud_store_upload_file_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_cloud_store_upload_file" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>upload_file</p></div><div class="list-group"><div onclick="window.location.href = '#action_cloud_store_upload_file_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>upload_file</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_cloud_store_upload_file_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/cloud_store</span>/upload_file</h4></div><div class="modal-body"><div class="alert alert-info"><p>upload_file</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_cloud_store_upload_file_post_request" data-toggle="tab">Request</a></li><li><a href="#action_cloud_store_upload_file_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_cloud_store_upload_file_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>file</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="action_cloud_store_upload_file_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>file</strong>: <em>required (string)</em></li><li><strong>oauth_token_id</strong>: <em>required (string)</em></li><li><strong>root_path</strong>: <em>required (string)</em></li><li><strong>store_provider</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="action_marketplace" class="panel-title">Actions defined over Marketplace</h3></div><div class="panel-body"><div class="top-resource-description"><p>Actions defined over Marketplace</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_marketplace_install_marketplace_package"><span class="parent">/action/marketplace</span>/install_marketplace_package</a> <span class="methods"><a href="#action_marketplace_install_marketplace_package_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_marketplace_install_marketplace_package" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>install_marketplace_package</p></div><div class="list-group"><div onclick="window.location.href = '#action_marketplace_install_marketplace_package_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>install_marketplace_package</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_marketplace_install_marketplace_package_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/marketplace</span>/install_marketplace_package</h4></div><div class="modal-body"><div class="alert alert-info"><p>install_marketplace_package</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_marketplace_install_marketplace_package_post_request" data-toggle="tab">Request</a></li><li><a href="#action_marketplace_install_marketplace_package_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_marketplace_install_marketplace_package_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>package_name</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="action_marketplace_install_marketplace_package_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>marketplace_id</strong>: <em>required (string)</em></li><li><strong>package_name</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_marketplace_publish_package_to_market"><span class="parent">/action/marketplace</span>/publish_package_to_market</a> <span class="methods"><a href="#action_marketplace_publish_package_to_market_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_marketplace_publish_package_to_market" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>publish_package_to_market</p></div><div class="list-group"><div onclick="window.location.href = '#action_marketplace_publish_package_to_market_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>publish_package_to_market</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_marketplace_publish_package_to_market_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/marketplace</span>/publish_package_to_market</h4></div><div class="modal-body"><div class="alert alert-info"><p>publish_package_to_market</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_marketplace_publish_package_to_market_post_request" data-toggle="tab">Request</a></li><li><a href="#action_marketplace_publish_package_to_market_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_marketplace_publish_package_to_market_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_marketplace_publish_package_to_market_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>marketplace_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_marketplace_refresh_marketplace_packages"><span class="parent">/action/marketplace</span>/refresh_marketplace_packages</a> <span class="methods"><a href="#action_marketplace_refresh_marketplace_packages_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_marketplace_refresh_marketplace_packages" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>refresh_marketplace_packages</p></div><div class="list-group"><div onclick="window.location.href = '#action_marketplace_refresh_marketplace_packages_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>refresh_marketplace_packages</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_marketplace_refresh_marketplace_packages_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/marketplace</span>/refresh_marketplace_packages</h4></div><div class="modal-body"><div class="alert alert-info"><p>refresh_marketplace_packages</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_marketplace_refresh_marketplace_packages_post_request" data-toggle="tab">Request</a></li><li><a href="#action_marketplace_refresh_marketplace_packages_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_marketplace_refresh_marketplace_packages_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_marketplace_refresh_marketplace_packages_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>marketplace_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_marketplace_visit_marketplace_github"><span class="parent">/action/marketplace</span>/visit_marketplace_github</a> <span class="methods"><a href="#action_marketplace_visit_marketplace_github_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_marketplace_visit_marketplace_github" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>visit_marketplace_github</p></div><div class="list-group"><div onclick="window.location.href = '#action_marketplace_visit_marketplace_github_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>visit_marketplace_github</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_marketplace_visit_marketplace_github_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/marketplace</span>/visit_marketplace_github</h4></div><div class="modal-body"><div class="alert alert-info"><p>visit_marketplace_github</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_marketplace_visit_marketplace_github_post_request" data-toggle="tab">Request</a></li><li><a href="#action_marketplace_visit_marketplace_github_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_marketplace_visit_marketplace_github_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_marketplace_visit_marketplace_github_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>location</strong>: <em>required (string)</em></li><li><strong>window</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="action_oauth_connect" class="panel-title">Actions defined over Oauth connect</h3></div><div class="panel-body"><div class="top-resource-description"><p>Actions defined over Oauth connect</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_oauth_connect_oauth_login_begin"><span class="parent">/action/oauth_connect</span>/oauth.login.begin</a> <span class="methods"><a href="#action_oauth_connect_oauth_login_begin_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_oauth_connect_oauth_login_begin" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>oauth.login.begin</p></div><div class="list-group"><div onclick="window.location.href = '#action_oauth_connect_oauth_login_begin_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>oauth.login.begin</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_oauth_connect_oauth_login_begin_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/oauth_connect</span>/oauth.login.begin</h4></div><div class="modal-body"><div class="alert alert-info"><p>oauth.login.begin</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_oauth_connect_oauth_login_begin_post_request" data-toggle="tab">Request</a></li><li><a href="#action_oauth_connect_oauth_login_begin_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_oauth_connect_oauth_login_begin_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_oauth_connect_oauth_login_begin_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>authenticator</strong>: <em>required (string)</em></li><li><strong>scope</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="action_package" class="panel-title">Actions defined over Package</h3></div><div class="panel-body"><div class="top-resource-description"><p>Actions defined over Package</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_package_buy_package"><span class="parent">/action/package</span>/buy_package</a> <span class="methods"><a href="#action_package_buy_package_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_package_buy_package" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>buy_package</p></div><div class="list-group"><div onclick="window.location.href = '#action_package_buy_package_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>buy_package</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_package_buy_package_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/package</span>/buy_package</h4></div><div class="modal-body"><div class="alert alert-info"><p>buy_package</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_package_buy_package_post_request" data-toggle="tab">Request</a></li><li><a href="#action_package_buy_package_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_package_buy_package_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_package_buy_package_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>shared_reference_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="action_user" class="panel-title">Actions defined over User</h3></div><div class="panel-body"><div class="top-resource-description"><p>Actions defined over User</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_user_signin"><span class="parent">/action/user</span>/signin</a> <span class="methods"><a href="#action_user_signin_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_user_signin" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>signin</p></div><div class="list-group"><div onclick="window.location.href = '#action_user_signin_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>signin</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_user_signin_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/user</span>/signin</h4></div><div class="modal-body"><div class="alert alert-info"><p>signin</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_user_signin_post_request" data-toggle="tab">Request</a></li><li><a href="#action_user_signin_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_user_signin_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>(string)</em></li><li><strong>password</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="action_user_signin_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>required (string)</em></li><li><strong>password</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_user_signup"><span class="parent">/action/user</span>/signup</a> <span class="methods"><a href="#action_user_signup_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_user_signup" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>signup</p></div><div class="list-group"><div onclick="window.location.href = '#action_user_signup_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>signup</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_user_signup_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/user</span>/signup</h4></div><div class="modal-body"><div class="alert alert-info"><p>signup</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_user_signup_post_request" data-toggle="tab">Request</a></li><li><a href="#action_user_signup_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_user_signup_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>email</strong>: <em>(string)</em></li><li><strong>name</strong>: <em>(string)</em></li><li><strong>password</strong>: <em>(string)</em></li><li><strong>passwordConfirm</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="action_user_signup_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>confirmed</strong>: <em>required (string)</em></li><li><strong>delay</strong>: <em>required (string)</em></li><li><strong>email</strong>: <em>required (string)</em></li><li><strong>location</strong>: <em>required (string)</em></li><li><strong>message</strong>: <em>required (string)</em></li><li><strong>name</strong>: <em>required (string)</em></li><li><strong>password</strong>: <em>required (string)</em></li><li><strong>title</strong>: <em>required (string)</em></li><li><strong>type</strong>: <em>required (string)</em></li><li><strong>user_id</strong>: <em>required (string)</em></li><li><strong>usergroup_id</strong>: <em>required (string)</em></li><li><strong>window</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="action_world" class="panel-title">Actions defined over World</h3></div><div class="panel-body"><div class="top-resource-description"><p>Actions defined over World</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_add_exchange"><span class="parent">/action/world</span>/add_exchange</a> <span class="methods"><a href="#action_world_add_exchange_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_add_exchange" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>add_exchange</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_add_exchange_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>add_exchange</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_add_exchange_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/add_exchange</h4></div><div class="modal-body"><div class="alert alert-info"><p>add_exchange</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_add_exchange_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_add_exchange_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_add_exchange_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>app_key</strong>: <em>(string)</em></li><li><strong>name</strong>: <em>(string)</em></li><li><strong>sheet_id</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="action_world_add_exchange_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>attributes</strong>: <em>required (string)</em></li><li><strong>name</strong>: <em>required (string)</em></li><li><strong>options</strong>: <em>required (string)</em></li><li><strong>source_attributes</strong>: <em>required (string)</em></li><li><strong>source_type</strong>: <em>required (string)</em></li><li><strong>target_attributes</strong>: <em>required (string)</em></li><li><strong>target_type</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_become_an_administrator"><span class="parent">/action/world</span>/become_an_administrator</a> <span class="methods"><a href="#action_world_become_an_administrator_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_become_an_administrator" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>become_an_administrator</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_become_an_administrator_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>become_an_administrator</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_become_an_administrator_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/become_an_administrator</h4></div><div class="modal-body"><div class="alert alert-info"><p>become_an_administrator</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_become_an_administrator_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_become_an_administrator_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_become_an_administrator_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_world_become_an_administrator_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>user</strong>: <em>required (string)</em></li><li><strong>user_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_download_system_schema"><span class="parent">/action/world</span>/download_system_schema</a> <span class="methods"><a href="#action_world_download_system_schema_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_download_system_schema" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>download_system_schema</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_download_system_schema_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>download_system_schema</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_download_system_schema_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/download_system_schema</h4></div><div class="modal-body"><div class="alert alert-info"><p>download_system_schema</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_download_system_schema_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_download_system_schema_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_download_system_schema_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_world_download_system_schema_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_export_data"><span class="parent">/action/world</span>/export_data</a> <span class="methods"><a href="#action_world_export_data_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_export_data" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>export_data</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_export_data_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>export_data</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_export_data_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/export_data</h4></div><div class="modal-body"><div class="alert alert-info"><p>export_data</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_export_data_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_export_data_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_export_data_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_world_export_data_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>table_name</strong>: <em>required (string)</em></li><li><strong>world_reference_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_generate_random_data"><span class="parent">/action/world</span>/generate_random_data</a> <span class="methods"><a href="#action_world_generate_random_data_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_generate_random_data" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>generate_random_data</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_generate_random_data_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>generate_random_data</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_generate_random_data_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/generate_random_data</h4></div><div class="modal-body"><div class="alert alert-info"><p>generate_random_data</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_generate_random_data_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_generate_random_data_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_generate_random_data_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em>(number)</em></li></ul></div><div class="tab-pane" id="action_world_generate_random_data_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>count</strong>: <em>required (string)</em></li><li><strong>table_name</strong>: <em>required (string)</em></li><li><strong>user_id</strong>: <em>required (string)</em></li><li><strong>user_reference_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_import_data"><span class="parent">/action/world</span>/import_data</a> <span class="methods"><a href="#action_world_import_data_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_import_data" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>import_data</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_import_data_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>import_data</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_import_data_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/import_data</h4></div><div class="modal-body"><div class="alert alert-info"><p>import_data</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_import_data_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_import_data_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_import_data_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>dump_file</strong>: <em>(string)</em></li><li><strong>truncate_before_insert</strong>: <em>(boolean)</em></li></ul></div><div class="tab-pane" id="action_world_import_data_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>dump_file</strong>: <em>required (string)</em></li><li><strong>execute_middleware_chain</strong>: <em>required (string)</em></li><li><strong>table_name</strong>: <em>required (string)</em></li><li><strong>truncate_before_insert</strong>: <em>required (string)</em></li><li><strong>user</strong>: <em>required (string)</em></li><li><strong>world_reference_id</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_restart_daptin"><span class="parent">/action/world</span>/restart_daptin</a> <span class="methods"><a href="#action_world_restart_daptin_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_restart_daptin" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>restart_daptin</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_restart_daptin_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>restart_daptin</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_restart_daptin_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/restart_daptin</h4></div><div class="modal-body"><div class="alert alert-info"><p>restart_daptin</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_restart_daptin_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_restart_daptin_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_restart_daptin_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p></div><div class="tab-pane" id="action_world_restart_daptin_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>json_schema</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_upload_csv_to_system_schema"><span class="parent">/action/world</span>/upload_csv_to_system_schema</a> <span class="methods"><a href="#action_world_upload_csv_to_system_schema_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_upload_csv_to_system_schema" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>upload_csv_to_system_schema</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_upload_csv_to_system_schema_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>upload_csv_to_system_schema</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_upload_csv_to_system_schema_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/upload_csv_to_system_schema</h4></div><div class="modal-body"><div class="alert alert-info"><p>upload_csv_to_system_schema</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_upload_csv_to_system_schema_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_upload_csv_to_system_schema_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_upload_csv_to_system_schema_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>add_missing_columns</strong>: <em>(boolean)</em></li><li><strong>create_if_not_exists</strong>: <em>(boolean)</em></li><li><strong>data_csv_file</strong>: <em>(string)</em></li><li><strong>entity_name</strong>: <em>(string)</em></li></ul></div><div class="tab-pane" id="action_world_upload_csv_to_system_schema_post_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/vnd.api+json</p><p><strong>Type</strong>: object</p><strong>Properties</strong><ul><li><strong>add_missing_columns</strong>: <em>required (string)</em></li><li><strong>create_if_not_exists</strong>: <em>required (string)</em></li><li><strong>data_csv_file</strong>: <em>required (string)</em></li><li><strong>entity_name</strong>: <em>required (string)</em></li></ul></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_action_world_upload_system_schema"><span class="parent">/action/world</span>/upload_system_schema</a> <span class="methods"><a href="#action_world_upload_system_schema_post"><span class="badge badge_post">post</span></a></span></h4></div><div id="panel_action_world_upload_system_schema" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>upload_system_schema</p></div><div class="list-group"><div onclick="window.location.href = '#action_world_upload_system_schema_post'" class="list-group-item"><span class="badge badge_post">post</span><div class="method_description"><p>upload_system_schema</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="action_world_upload_system_schema_post"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_post">post</span> <span class="parent">/action/world</span>/upload_system_schema</h4></div><div class="modal-body"><div class="alert alert-info"><p>upload_system_schema</p></div><ul class="nav nav-tabs"><li class="active"><a href="#action_world_upload_system_schema_post_request" data-toggle="tab">Request</a></li><li><a href="#action_world_upload_system_schema_post_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="action_world_upload_system_schema_post_request"><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: object</p><strong>Properties</st