json_PlanResponse.html 6.58 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api: PlanResponse</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api: PlanResponse</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
          <li class="dropdown"><a href="json_PlanResponse.html">PlanResponse</a></li>
        </ol>

      <h1 class="page-header">PlanResponse <small>Data Type</small></h1>

      <p></p>

      <dl class="dl-horizontal">
      </dl>

      <table class="table datatype-properties">
        <caption>Properties</caption>
        <thead>
        <tr>
          <th>name</th>
          <th>data type</th>
          <th>description</th>
        </tr>
        </thead>
        <tbody>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
83
          <td>  <span class="property-name">level</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
84
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
85
          <td>  <span class="datatype-reference">number
Spiros Koulouzis's avatar
Spiros Koulouzis committed
86 87 88 89 90 91
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
92
          <td>  <span class="property-name">name</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
93
</td>
94
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
95 96 97 98 99 100
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101
          <td>  <span class="property-name">toscaID</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
102 103 104 105 106 107 108 109
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
110
          <td>  <span class="property-name">loweLevelPlanIDs</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
111
</td>
112
          <td>  <span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        </tbody>
        <tr>
          <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_KeyValueHolder.html">KeyValueHolder</a></h5></td>
        </tr>
        <tbody>
        <tr>
          <td><span class="property-name">keyValue</span></td>
          <td><span class="datatype-reference">map of object
</span></td>
          <td><span class="property-description"></span></td>
        </tr>
        </tbody>
        <tr>
          <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
        </tr>
        <tbody>
        <tr>
135
          <td><span class="property-name">id</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
136 137 138 139 140
          <td><span class="datatype-reference">string
</span></td>
          <td><span class="property-description"></span></td>
        </tr>
        <tr>
141
          <td><span class="property-name">owner</span></td>
142
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143 144 145 146
</span></td>
          <td><span class="property-description"></span></td>
        </tr>
        <tr>
147 148
          <td><span class="property-name">timestamp</span></td>
          <td><span class="datatype-reference">number
Spiros Koulouzis's avatar
Spiros Koulouzis committed
149 150 151 152 153 154 155 156 157
</span></td>
          <td><span class="property-description"></span></td>
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
158
  &quot;level&quot; : 0,
159
  &quot;name&quot; : &quot;planner_output_all.yml&quot;,
160 161
  &quot;toscaID&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
  &quot;loweLevelPlanIDs&quot; : [ &quot;ew44Ae3946e0sdds4f562d84baA&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
162 163 164 165 166
  &quot;keyValue&quot; : {
    &quot;property1&quot; : { },
    &quot;property2&quot; : { }
  },
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
167
  &quot;owner&quot; : &quot;user1&quot;,
168
  &quot;timestamp&quot; : 12345
Spiros Koulouzis's avatar
Spiros Koulouzis committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
}</pre>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>