Update documentation

AVSystem · Mar 13, 2024 · 152b751 · 152b751
1 parent b527721
commit 152b751
Show file tree

Hide file tree

Showing 152 changed files with 431 additions and 563 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -1015,7 +1015,7 @@ <h5 class="topLinePageInfo__text">
 
     <li class="md-nav__item">
       <a href="/Coiote_IoT_DM/Configurations/" class="md-nav__link">
-        Configurations
+        FOTA Configurations
       </a>
     </li>
 
@@ -1039,7 +1039,7 @@ <h5 class="topLinePageInfo__text">
 
     <li class="md-nav__item">
       <a href="/Coiote_IoT_DM/Campaigns/" class="md-nav__link">
-        Campaigns
+        FOTA Campaigns
       </a>
     </li>
 

diff --git a/docs/API_documentation/Guides/Basic_onboarding/index.html b/docs/API_documentation/Guides/Basic_onboarding/index.html
@@ -1022,7 +1022,7 @@ <h5 class="topLinePageInfo__text">
 
     <li class="md-nav__item">
       <a href="../../../Coiote_IoT_DM/Configurations/" class="md-nav__link">
-        Configurations
+        FOTA Configurations
       </a>
     </li>
 
@@ -1046,7 +1046,7 @@ <h5 class="topLinePageInfo__text">
 
     <li class="md-nav__item">
       <a href="../../../Coiote_IoT_DM/Campaigns/" class="md-nav__link">
-        Campaigns
+        FOTA Campaigns
       </a>
     </li>
 
@@ -3738,9 +3738,7 @@ <h3 id="add-a-single-device">Add a single device<a class="headerlink" href="#add
 </tbody>
 </table>
 <p>The following is an example of the request:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">cURL</label><label for="__tabbed_1_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><label for="__tabbed_1_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X POST \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 -H &quot;Content-Type: application/json&quot; \
@@ -3749,7 +3747,7 @@ <h3 id="add-a-single-device">Add a single device<a class="headerlink" href="#add
 https://#HOSTNAME/api/coiotedm/v3/devices
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><label for="__tabbed_1_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 <span class="kn">from</span> <span class="nn">coiote.v3.model.devices</span> <span class="kn">import</span> <span class="n">ConnectorType</span><span class="p">,</span> <span class="n">Device</span><span class="p">,</span> <span class="n">HexStringPsk</span>
 
@@ -3776,22 +3774,19 @@ <h3 id="add-a-single-device">Add a single device<a class="headerlink" href="#add
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 <h3 id="add-multiple-devices-in-a-batch">Add multiple devices in a batch<a class="headerlink" href="#add-multiple-devices-in-a-batch" title="Permanent link">#</a></h3>
 <p>Send a <code>POST</code> request to the endpoint <code>/devices/batch</code> with an array of device objects in the request body. You can add up to 100 devices. 
 The following is an example of the request creating two devices:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">cURL</label><label for="__tabbed_2_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><label for="__tabbed_2_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X POST \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 -H &quot;Content-Type: application/json&quot; \
 -d &#39;[{&quot;connectorType&quot;: &quot;management&quot;,&quot;directGroups&quot;: [&quot;root.mt.exampleGroup&quot;],&quot;properties&quot;: {&quot;endpointName&quot;: &quot;exampleUniqueEndpointName1&quot;, &quot;exampleAdditionalProperty&quot;: &quot;exampleAdditionalValue&quot;},&quot;domain&quot;: &quot;/exampleDomain/&quot;,&quot;securityMode&quot;: &quot;psk&quot;,&quot;dtlsIdentity&quot;:&quot;exampleUniqueEndpointName1&quot;, &quot;dtlsPsk&quot;: {&quot;HexadecimalPsk&quot;: &quot;4444&quot;}},{&quot;connectorType&quot;: &quot;management&quot;,&quot;directGroups&quot;: [&quot;root.mt.exampleGroup&quot;],&quot;properties&quot;:{&quot;endpointName&quot;:&quot;exampleUniqueEndpointName2&quot;,&quot;exampleAdditionalProperty&quot;: &quot;exampleAdditionalValue&quot;},&quot;domain&quot;: &quot;/exampleDomain/&quot;, &quot;securityMode&quot;: &quot;psk&quot;,&quot;dtlsIdentity&quot;: &quot;exampleUniqueEndpointName2&quot;,&quot;dtlsPsk&quot;: {&quot;HexadecimalPsk&quot;: &quot;4444&quot;}}]&#39; \
 https://#HOSTNAME/api/coiotedm/v3/devices/batch
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><label for="__tabbed_2_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 <span class="kn">from</span> <span class="nn">coiote.v3.model.devices</span> <span class="kn">import</span> <span class="n">ConnectorType</span><span class="p">,</span> <span class="n">Device</span><span class="p">,</span> <span class="n">HexStringPsk</span>
 
@@ -3832,7 +3827,6 @@ <h3 id="add-multiple-devices-in-a-batch">Add multiple devices in a batch<a class
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 <h2 id="step-2-create-observations">Step 2: Create observations<a class="headerlink" href="#step-2-create-observations" title="Permanent link">#</a></h2>
 <p>To create observations for a device, send a <code>POST</code> request to the endpoint <code>/observations/device/{deviceId}/{path}</code>. Provide the ID of the device to which you want to add the observation and the path to the device resource you want to use. Use the Human readable path format (for example, “Device.0.Battery Level”). The path can point to Object, Object Instance, or Resource. </p>
@@ -3847,17 +3841,15 @@ <h2 id="step-2-create-observations">Step 2: Create observations<a class="headerl
 </div>
 <p>If you create ensureObservationTask, the system automatically checks if the observations are enabled on the device, during every provisioning session. </p>
 <p>The following is an example of the request, where you want to get a notification about the level of battery power every two minutes:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><div class="tabbed-labels"><label for="__tabbed_3_1">cURL</label><label for="__tabbed_3_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="3:2"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><label for="__tabbed_3_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X POST \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 -H &quot;Content-Type: application/json&quot; \
 -d &#39;{&quot;attributes&quot;: [{&quot;name&quot;: &quot;pmax&quot;,&quot;value&quot;: &quot;120&quot;}],&quot;createEnsureObserveIfNotExists&quot;: false}&#39; \
 https://#HOSTNAME/api/coiotedm/v3/observations/device/api-test-device/Device.0.Battery%20Level
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><label for="__tabbed_3_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 <span class="kn">from</span> <span class="nn">coiote.v3.model.observations</span> <span class="kn">import</span> <span class="n">ObservationAttribute</span><span class="p">,</span> <span class="n">SetObservationRequest</span>
 
@@ -3879,21 +3871,18 @@ <h2 id="step-2-create-observations">Step 2: Create observations<a class="headerl
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 <h2 id="step-3-get-data-about-devices">Step 3: Get data about devices<a class="headerlink" href="#step-3-get-data-about-devices" title="Permanent link">#</a></h2>
 <h3 id="retrieve-all-data-about-a-specific-device">Retrieve all data about a specific device<a class="headerlink" href="#retrieve-all-data-about-a-specific-device" title="Permanent link">#</a></h3>
 <p>Send a <code>GET</code> request to the endpoint <code>/devices/{id}</code> using the device ID as the path parameter. </p>
 <p>The following is an example of the request:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="4:2"><input checked="checked" id="__tabbed_4_1" name="__tabbed_4" type="radio" /><input id="__tabbed_4_2" name="__tabbed_4" type="radio" /><div class="tabbed-labels"><label for="__tabbed_4_1">cURL</label><label for="__tabbed_4_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="4:2"><input checked="checked" id="__tabbed_4_1" name="__tabbed_4" type="radio" /><label for="__tabbed_4_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X GET \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 https://#HOSTNAME/api/coiotedm/v3/devices/api-test-device
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_4_2" name="__tabbed_4" type="radio" /><label for="__tabbed_4_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 <span class="n">coiote_auth</span> <span class="o">=</span> <span class="s2">&quot;#TOKEN&quot;</span>
 <span class="n">client</span> <span class="o">=</span> <span class="n">Coiote</span><span class="p">(</span>
@@ -3906,7 +3895,6 @@ <h3 id="retrieve-all-data-about-a-specific-device">Retrieve all data about a spe
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 <h3 id="retrieve-specific-data-about-all-devices">Retrieve specific data about all devices<a class="headerlink" href="#retrieve-specific-data-about-all-devices" title="Permanent link">#</a></h3>
 <p>Send a <code>GET</code> request to the endpoint <code>/devices/find/details</code>. 
@@ -3918,16 +3906,14 @@ <h3 id="retrieve-specific-data-about-all-devices">Retrieve specific data about a
 <li><em>pageBookmark</em> -  if you leave this parameter empty, you will get the first page. To get the next page, use the bookmark value returned in the previous request.</li>
 </ul>
 <p>The following is an example of the request, where you want to get domains of devices that have enabled management and limit the result to 10:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="5:2"><input checked="checked" id="__tabbed_5_1" name="__tabbed_5" type="radio" /><input id="__tabbed_5_2" name="__tabbed_5" type="radio" /><div class="tabbed-labels"><label for="__tabbed_5_1">cURL</label><label for="__tabbed_5_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="5:2"><input checked="checked" id="__tabbed_5_1" name="__tabbed_5" type="radio" /><label for="__tabbed_5_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X GET \
 -H &quot;accept: application/json&quot; \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 &quot;https://#HOSTNAME/api/coiotedm/v3/devices/find/details?searchCriteria=managementEnabled%20eq%20true&amp;fieldSelection=domain&amp;limit=10&quot; 
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_5_2" name="__tabbed_5" type="radio" /><label for="__tabbed_5_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 
 <span class="n">coiote_auth</span> <span class="o">=</span> <span class="s2">&quot;#TOKEN&quot;</span>
@@ -3945,7 +3931,6 @@ <h3 id="retrieve-specific-data-about-all-devices">Retrieve specific data about a
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 
 <!-- Link to previous and/or next page -->

diff --git a/docs/API_documentation/Guides/Create_a_domain_and_add_users/index.html b/docs/API_documentation/Guides/Create_a_domain_and_add_users/index.html
@@ -1022,7 +1022,7 @@ <h5 class="topLinePageInfo__text">
 
     <li class="md-nav__item">
       <a href="../../../Coiote_IoT_DM/Configurations/" class="md-nav__link">
-        Configurations
+        FOTA Configurations
       </a>
     </li>
 
@@ -1046,7 +1046,7 @@ <h5 class="topLinePageInfo__text">
 
     <li class="md-nav__item">
       <a href="../../../Coiote_IoT_DM/Campaigns/" class="md-nav__link">
-        Campaigns
+        FOTA Campaigns
       </a>
     </li>
 
@@ -3509,17 +3509,15 @@ <h1 id="how-to-create-a-domain-and-add-users">How to create a domain and add use
 </ul>
 <h3 id="step-1-create-a-domain">Step 1: Create a domain<a class="headerlink" href="#step-1-create-a-domain" title="Permanent link">#</a></h3>
 <p>To create a domain, send a <code>POST</code> request to the endpoint <code>/domains</code>. Customize the data in the request body with the necessary parameters for creating a domain: the domain identity and description. Domain identity consists of the root domain name followed by any number of sub-domain names, and must start and end with ”/”, for example: “/sub_domain1/sub_domain2/”. The following is an example of the request:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">cURL</label><label for="__tabbed_1_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><label for="__tabbed_1_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X POST \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 -H &quot;Content-Type: application/json&quot; \
 -d &#39;{&quot;id&quot;:&quot;/sub_domain1/sub_domain2/&quot;,&quot;description&quot;:&quot;Example domain&quot;}&#39; \
 https://#HOSTNAME/api/coiotedm/v3/domains
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><label for="__tabbed_1_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 <span class="kn">from</span> <span class="nn">coiote.v3.model.domains</span> <span class="kn">import</span> <span class="n">Domain</span>
 
@@ -3538,7 +3536,6 @@ <h3 id="step-1-create-a-domain">Step 1: Create a domain<a class="headerlink" hre
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 <h3 id="step-2-add-users-to-your-domain">Step 2: Add users to your domain<a class="headerlink" href="#step-2-add-users-to-your-domain" title="Permanent link">#</a></h3>
 <p>To add users, send a <code>POST</code> request to the endpoint <code>/users</code>. Specify your domain in the path parameter. In the request body provide a user object. You have to include the following information:</p>
@@ -3553,17 +3550,15 @@ <h3 id="step-2-add-users-to-your-domain">Step 2: Add users to your domain<a clas
 <li>tosAccepted - set true to create a user with already accepted Terms of Service</li>
 </ul>
 <p>The following is an example of the request:</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">cURL</label><label for="__tabbed_2_2">Coiote Python</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
+<div class="tabbed-set" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><label for="__tabbed_2_1">cURL</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code>curl -X POST \
 -H &quot;Authorization: Bearer #TOKEN&quot; \
 -H &quot;Content-Type: application/json&quot; \
 -d &#39;{&quot;login&quot;:&quot;example_user&quot;,&quot;email&quot;:&quot;[email protected]&quot;,&quot;emailVerified&quot;:true,&quot;domain&quot;:&quot;/sub_domain1/sub_domain2/&quot;,&quot;password&quot;:&quot;example_password&quot;,&quot;roles&quot;:[&quot;string&quot;],&quot;permissions&quot;:[&quot;string&quot;],&quot;tosAccepted&quot;:true&quot;}&#39; \
 https://#HOSTNAME/api/coiotedm/v3/users
 </code></pre></div>
 </div>
-<div class="tabbed-block">
+<input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><label for="__tabbed_2_2">Coiote Python</label><div class="tabbed-content">
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">coiote.client</span> <span class="kn">import</span> <span class="n">Coiote</span>
 <span class="kn">from</span> <span class="nn">coiote.v3.model.users</span> <span class="kn">import</span> <span class="n">UserCreateRequest</span>
 
@@ -3589,7 +3584,6 @@ <h3 id="step-2-add-users-to-your-domain">Step 2: Add users to your domain<a clas
 </code></pre></div>
 </div>
 </div>
-</div>
 <p>Replace <code>#TOKEN</code> with your actual access token and <code>#HOSTNAME</code> with your actual hostname.</p>
 
 <!-- Link to previous and/or next page -->