DFAST API - Help

<!DOCTYPE html> <html> <head>  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-109268803-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-109268803-1'); </script> <title>DFAST API - Help</title> <meta name="viewport" content="width=device-width, initial-scale=1.0">  <link href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet"> <style> .mydd {margin-left:45px;margin-bottom: 10px} </style> <link rel="shortcut icon" href="/static/favicon.ico" type="image/x-icon"> <link rel="icon" href="/static/favicon.ico" type="image/x-icon"> <style type="text/css"> .container {width: 95%;} </style> <meta charset="UTF-8"> <meta http-equiv="x-ua-compatible" content="IE=edge"> </head> <body> <div class="swagger-section"> <nav class="navbar navbar-inverse navbar-static-top" role="navigation"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a style="margin-left: -20px; margin-top: -8px" class="navbar-brand" href="/"><img height="30px" src="/static/DFAST_inverse.png" class="" alt="dfast_logo"></a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false" id="analysis-dropdown">Analysis <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li><a href="/dfc/">Genome Annotation</a></li> <li class="divider"></li> <li><a href="/dfv/submit/">Genome Annotation for SARS-CoV-2</a></li> <li><a href="/dfv/vadr/">NCBI VADR (Beta, for viral sequences)</a></li> <li class="divider"></li> <li><a href="/dqc/submit/">Taxonomy/Completeness Check</a></li> </ul> </li> </ul> <ul class="nav navbar-nav navbar-right">  <li><a href="/dfc/distribution/">DFAST-core</a></li> <li><a href="/api/">API</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false" id="help-dropdown">Help <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li><a href="/about">About DFAST</a></li> <li><a href="/faq">FAQ</a></li> <li><a href="/help_annotation">Help - DFAST</a></li> <li><a href="/help_login">Help - Login and Data Submission</a></li> </ul> </li> <li><a href="/auth/">Sign in</a></li> </ul> </div> </div> </nav> <div class="container"> <p class="lead text-center">DFAST Web API</p> <ul class="nav nav-tabs"> <li role="presentation" class="active"><a>About</a></li> <li role="presentation"><a href="/api/tutorial/">Tutorial</a></li> <li role="presentation"><a href="/api/helper/">DFAST Helper</a></li> <li role="presentation"><a href="/api/apispec/#/DFAST">API spec</a></li> </ul>  <div> <h3>Job management through the Web API</h3><hr> <h4>About</h4> <p> The DFAST Web API allows command-based job management, including job submission, status check, data downloading, and job deletion. You can use the API with any command or program language that can send requests using GET/POST/DELETE methods. </p> <hr> </div> <div> <h4>Access token</h4> <p>Job submission via the Web API requires an access token. (Not required for data downloading)<br> <b>Please get an access token by e-mail request.  <span class="glyphicon glyphicon-envelope" aria-hidden="true"></span> dfast [at] nig.ac.jp</b></p> <p>Please include the following information in the e-mail.<br> <div style="margin-left: 45px"> <ul> <li>Number of genomes you want to annotate</li> <li>Average genome size of your genomes</li> <li>Your mail address</li> </ul> </div> </p> <hr> </div> <div> <h4>Available methods</h4> <div style="margin-left: 45px"> <dl> <dt>Submit a job</dt><dd class="mydd">https://dfast.ddbj.nig.ac.jp/api/job <span class="label label-success">POST</span></dd> <dt>Submit a job (by file uploading)</dt><dd class="mydd">https://dfast.ddbj.nig.ac.jp/api/job/upload <span class="label label-success">POST</span></dd> <dt>Check status</dt><dd class="mydd">https://dfast.ddbj.nig.ac.jp/api/job/<span class="text-danger">{job_id}</span> <span class="label label-primary">GET</span></dd> <dt>Delete a job</dt><dd class="mydd">https://dfast.ddbj.nig.ac.jp/api/job/<span class="text-danger">{job_id}</span> <span class="label label-danger">DELETE</span></dd> <dt>Download results</dt><dd class="mydd">https://dfast.ddbj.nig.ac.jp/api/job/<span class="text-danger">{job_id}</span>/<span class="text-success">{file_format}</span> <span class="label label-primary">GET</span></dd> </dl> </div> <div> <p> Please see <a href="/api/apispec/#/DFAST">API spec</a> for acceptable parameters and options, and also check <a href="/api/tutorial/">Tutorial</a> to see examples for the curl command and Python. </p> </div> <hr> </div> <div> <h4>DFAST Helper</h4> <p>We also provide a Python script that enables easy access to the Web API. You can submit multiple jobs at a time in a single operation with this script. <br>Go to <a href="/api/helper/">this page</a> to download and learn the usage.</p> <hr> </div>  </div> <script src="//cdnjs.cloudflare.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script> <script src="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.0.0/js/bootstrap.min.js"></script> </body> </html>

CINXE.COM

DFAST API - Help