diff --git a/source/_static/api/deployer.html b/source/_static/api/deployer.html
index 196823836..0d106e28b 100644
--- a/source/_static/api/deployer.html
+++ b/source/_static/api/deployer.html
@@ -410,7 +410,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Deployer<!-- --> <span>(<!-- -->4.4.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Deployer API&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Deployer<!-- --> <span>(<!-- -->4.5.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Deployer API&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Crafter Deployer API</p>
 </div><div class="sc-ixcdjX gvxrGF"><a href="https://craftercms.com/docs/current/reference/modules/deployer.html">CrafterCMS - Deployer</a></div></div></div></div><div id="tag/target" data-section-id="tag/target" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/target" aria-label="tag/target"></a>target</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="&lt;p&gt;Target management  operations&lt;/p&gt;
 "><p>Target management  operations</p>
@@ -434,8 +434,8 @@
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The branch name of the remote Git repo to pull from. If not specified, the branch will be whatever branch is the current one in the remote repo.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="repo_username" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">repo_username</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The username of the remote Git repo.&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The username of the remote Git repo.</p>
-</div></div></div></td></tr><tr class=""><td kind="field" title="repo_password" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">repo_password</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The username of the remote Git repo.&lt;/p&gt;
-" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The username of the remote Git repo.</p>
+</div></div></div></td></tr><tr class=""><td kind="field" title="repo_password" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">repo_password</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The password of the remote Git repo.&lt;/p&gt;
+" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The password of the remote Git repo.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="ssh_private_key_path" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">ssh_private_key_path</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The path for the private key used for the remote Git repo.&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The path for the private key used for the remote Git repo.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="ssh_private_key_passphrase" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">ssh_private_key_passphrase</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The passphrase for the private key for the remote Git repo (only if the key is passphrase-protected).&lt;/p&gt;
@@ -462,7 +462,7 @@
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Resource not found</p>
 </div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">500<!-- --> </strong><div html="&lt;p&gt;Internal server error&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Internal server error</p>
-</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/api/1/target/get/{env}/{site_name}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:9191</span>/api/1/target/get/{env}/{site_name}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174kq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R174kq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R174kq»1" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R174kq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R174kq»2" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174kq»0" aria-labelledby="tab«R174kq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"env"</span>: <span class="token string">&quot;dev&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"siteName"</span>: <span class="token string">&quot;editorial&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;editorial-dev&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"load_date"</span>: <span class="token string">&quot;2023-01-26T10:00:1.234-05:00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;INIT_COMPLETED&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174kq»1" aria-labelledby="tab«R174kq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174kq»2" aria-labelledby="tab«R174kq»2"></div></div></div></div></div></div><div id="tag/target/operation/getAllTargets" data-section-id="tag/target/operation/getAllTargets" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getAllTargets" id="operation/getAllTargets" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/target/operation/getAllTargets" aria-label="tag/target/operation/getAllTargets"></a>Get all Crafter Deployer targets.<!-- --> </h2><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="&lt;p&gt;OK&lt;/p&gt;
+</div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/api/1/target/get/{env}/{site_name}</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:9191</span>/api/1/target/get/{env}/{site_name}</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R174kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R174kq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R174kq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R174kq»1" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R174kq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R174kq»2" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R174kq»0" aria-labelledby="tab«R174kq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"env"</span>: <span class="token string">&quot;dev&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"siteName"</span>: <span class="token string">&quot;editorial&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;editorial-dev&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"load_date"</span>: <span class="token string">&quot;2023-01-26T10:00:01.234-05:00&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token string">&quot;INIT_COMPLETED&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174kq»1" aria-labelledby="tab«R174kq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R174kq»2" aria-labelledby="tab«R174kq»2"></div></div></div></div></div></div><div id="tag/target/operation/getAllTargets" data-section-id="tag/target/operation/getAllTargets" class="sc-dTvVRJ gHrCVQ"><div data-section-id="operation/getAllTargets" id="operation/getAllTargets" class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/target/operation/getAllTargets" aria-label="tag/target/operation/getAllTargets"></a>Get all Crafter Deployer targets.<!-- --> </h2><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">200<!-- --> </strong><div html="&lt;p&gt;OK&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>OK</p>
 </div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">500<!-- --> </strong><div html="&lt;p&gt;Internal server error&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Internal server error</p>
@@ -494,8 +494,8 @@
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>If all files in all the target repos should be reprocessed.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="from_commit_id" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">from_commit_id</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;The id of the commit to start processing changes&lt;br&gt;&lt;br&gt; &lt;i&gt;Available since version 4.0.0&lt;/i&gt;&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The id of the commit to start processing changes<br><br> <i>Available since version 4.0.0</i></p>
-</div></div></div></td></tr><tr class="last "><td kind="field" title="deployment_mode" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">deployment_mode</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;The deployment mode to execute. Possible values: &lt;br&gt; nbsp;&amp;nbsp;&amp;nbsp;&lt;b&gt;PUBLISH&lt;/b&gt;: All processors will run&lt;br&gt; &amp;nbsp;&amp;nbsp;&amp;nbsp;&lt;b&gt;SEARCH_INDEX&lt;/b&gt;: Only the indexing processor will run &lt;br&gt;&lt;br&gt; &lt;i&gt;Available since version 4.0.0&lt;/i&gt;&lt;/p&gt;
-" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The deployment mode to execute. Possible values: <br> nbsp;&nbsp;&nbsp;<b>PUBLISH</b>: All processors will run<br> &nbsp;&nbsp;&nbsp;<b>SEARCH_INDEX</b>: Only the indexing processor will run <br><br> <i>Available since version 4.0.0</i></p>
+</div></div></div></td></tr><tr class="last "><td kind="field" title="deployment_mode" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">deployment_mode</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;The deployment mode to execute. Possible values: &lt;br&gt; &amp;nbsp;&amp;nbsp;&amp;nbsp;&lt;b&gt;PUBLISH&lt;/b&gt;: All processors will run&lt;br&gt; &amp;nbsp;&amp;nbsp;&amp;nbsp;&lt;b&gt;SEARCH_INDEX&lt;/b&gt;: Only the indexing processor will run &lt;br&gt;&lt;br&gt; &lt;i&gt;Available since version 4.0.0&lt;/i&gt;&lt;/p&gt;
+" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>The deployment mode to execute. Possible values: <br> &nbsp;&nbsp;&nbsp;<b>PUBLISH</b>: All processors will run<br> &nbsp;&nbsp;&nbsp;<b>SEARCH_INDEX</b>: Only the indexing processor will run <br><br> <i>Available since version 4.0.0</i></p>
 </div></div></div></td></tr></tbody></table><div><h3 class="sc-gDzyrw kjrVcG">Responses</h3><div><button class="sc-jIDBmd lkmdtA"><svg class="sc-dntSTA cGxVlA" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">202<!-- --> </strong><div html="&lt;p&gt;Accepted&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Accepted</p>
 </div></button></div><div><button class="sc-jIDBmd ifAHvq"><svg class="sc-dntSTA jKYZgc" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eJvlPh fBhAXU">404<!-- --> </strong><div html="&lt;p&gt;Resource not found&lt;/p&gt;
@@ -596,8 +596,8 @@
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The branch name of the remote Git repo to pull from. If not specified, the branch will be whatever branch is the current one in the remote repo.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="repo_username" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">repo_username</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The username of the remote Git repo.&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The username of the remote Git repo.</p>
-</div></div></div></td></tr><tr class=""><td kind="field" title="repo_password" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">repo_password</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The username of the remote Git repo.&lt;/p&gt;
-" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The username of the remote Git repo.</p>
+</div></div></div></td></tr><tr class=""><td kind="field" title="repo_password" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">repo_password</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The password of the remote Git repo.&lt;/p&gt;
+" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The password of the remote Git repo.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="ssh_private_key_path" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">ssh_private_key_path</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The path for the private key used for the remote Git repo.&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"><p>Only use with <i>remote</i> template. The path for the private key used for the remote Git repo.</p>
 </div></div></div></td></tr><tr class=""><td kind="field" title="ssh_private_key_passphrase" class="sc-kCuUfV sc-fbQrwq gdmNWp dFOJWJ"><span class="sc-hwddKA cteAyA"></span><span class="property-name">ssh_private_key_passphrase</span></td><td class="sc-gGKoUb ixGaBD"><div><div><span class="sc-bEjUoa sc-boKDdR lhyyLL jYezsP"></span><span class="sc-bEjUoa sc-fOOuSg lhyyLL dbKJYq">string</span></div> <div><div html="&lt;p&gt;Only use with &lt;i&gt;remote&lt;/i&gt; template. The passphrase for the private key for the remote Git repo (only if the key is passphrase-protected).&lt;/p&gt;
@@ -652,7 +652,7 @@
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Internal server error</p>
 </div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/api/1/monitoring/memory</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:9191</span>/api/1/monitoring/memory</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pta»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pta»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pta»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pta»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R9pta»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pta»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R9pta»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pta»3" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pta»0" aria-labelledby="tab«R9pta»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"MemoryInfo"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"totalJvmMemory"</span>: <span class="token number">154140672</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"freeJvmMemory"</span>: <span class="token number">102165520</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"maxJvmMemory"</span>: <span class="token number">1073741824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalOsMemory"</span>: <span class="token number">34359738368</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"freeOsMemory"</span>: <span class="token number">59957248</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"totalSwapMemory"</span>: <span class="token number">8589934592</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"freeSwapMemory"</span>: <span class="token number">1076363264</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pta»1" aria-labelledby="tab«R9pta»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pta»2" aria-labelledby="tab«R9pta»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pta»3" aria-labelledby="tab«R9pta»3"></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:9191"}],"info":{"description":"Crafter Deployer API","version":"4.4.4","title":"Crafter Deployer","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Deployer","url":"https://craftercms.com/docs/current/reference/modules/deployer.html"},"tags":[{"name":"target","description":"Target management  operations"},{"name":"monitoring","description":"Monitoring operations"}],"paths":{"/api/1/target/create":{"post":{"security":[],"tags":["target"],"summary":"Create a Crafter Deployer target","description":"Target creation is based on templates. The deployer comes with two out of the box: remote and local. The remote template creates targets that pull changes from a remote Git repository, making it ideal to create targets for delivery environments. The local template instead generates targets that use a local Git repo and the last processed commit to infer the changes, without executing a pull, so it’s used mostly to create targets for authoring environments. <br><br> If a target already exists and <b><i>replace</i></b> is true, then the new target will replace the existing one. If <b><i>replace</i></b> is false and the target exists, a 409 is returned.","operationId":"createTarget","requestBody":{"description":"Create target request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTargetRequest"},"examples":{"simpleExample":{"summary":"Simple example of the request body","value":{"env":"preview","site_name":"my-editorial","replace":true,"disable_deploy_cron":true,"template_name":"local","repo_url":"/opt/crafter/data/repos/sites/my-editorial/sandbox","engine_url":"http://localhost:8080"}},"withNotificationAddresses":{"summary":"Example of request body with notification addresses","value":{"env":"dev","site_name":"my-editorial","replace":false,"template_name":"remote","repo_url":"ssh://crafter@server/opt/crafter/data/repos/sites/my-editorial/published","repo_username":"crafter","repo_password":"crafter","repo_branch":"live","engine_url":"http://localhost:8080","notification_addresses":"admin1@my-editorial.com\", \"admin2@my-editorial.com"}},"withGitPullOptions":{"summary":"Example of request body with git pull options","value":{"env":"dev","site_name":"my-editorial","replace":false,"template_name":"remote","repo_url":"ssh://crafter@server/opt/crafter/data/repos/sites/my-editorial/published","repo_username":"crafter","repo_password":"crafter","repo_branch":"live","engine_url":"http://localhost:8080","fast_forward_mode":"FF","merge_strategy":"recursive","content_merge_option":"THEIRS"}}}}}},"responses":{"201":{"$ref":"#/components/responses/Created"},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/get/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get a Crafter Deployer target.","operationId":"getTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Targets"},"example":{"env":"dev","siteName":"editorial","id":"editorial-dev","load_date":"2023-01-26T10:00:1.234-05:00","status":"INIT_COMPLETED"}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/get-all":{"get":{"security":[],"tags":["target"],"summary":"Get all Crafter Deployer targets.","operationId":"getAllTargets","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Targets"}},"example":[{"load_date":"2023-03-30T13:24:36.042181-04:00","env":"preview","siteName":"hi","status":"INIT_COMPLETED","id":"hi-preview"},{"load_date":"2023-03-31T09:48:48.214383-04:00","env":"preview","siteName":"third","status":"INIT_COMPLETED","id":"third-preview"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/delete/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Delete a Crafter Deployer target.","operationId":"deleteTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"204":{"description":"NO CONTENT"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/delete-if-exists/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Delete a Crafter Deployer target if it exists.","operationId":"deleteTargetIfExists","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"204":{"description":"NO CONTENT"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deploy/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Deploy a Crafter Deployer target.","operationId":"deployTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reprocess_all_files":{"description":"If all files in all the target repos should be reprocessed.","type":"boolean"},"from_commit_id":{"description":"The id of the commit to start processing changes<br><br> <i>Available since version 4.0.0</i>","type":"string"},"deployment_mode":{"description":"The deployment mode to execute. Possible values: <br> nbsp;&nbsp;&nbsp;<b>PUBLISH</b>: All processors will run<br> &nbsp;&nbsp;&nbsp;<b>SEARCH_INDEX</b>: Only the indexing processor will run <br><br> <i>Available since version 4.0.0</i>","type":"string"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"OK"}}}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deploy-all":{"post":{"security":[],"tags":["target"],"summary":"Deploy all Crafter Deployer targets.","operationId":"deployAllTargets","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reprocess_all_files":{"description":"If all files in all the target repos should be reprocessed.","type":"boolean"},"deployment_mode":{"description":"The deployment mode to execute. Possible values: <br> &nbsp;&nbsp;&nbsp;<b>PUBLISH</b>: All processors will run<br> &nbsp;&nbsp;&nbsp;<b>SEARCH_INDEX</b>: Only the indexing processor will run <br><br> <i>Available since version 4.0.0</i>","type":"string"}}}}}},"responses":{"202":{"$ref":"#/components/responses/Accepted"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deployments/get-pending/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get the pending deployments for a target.","operationId":"getPendingDeployments","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"example":[{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]},{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]}]}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deployments/get-current/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get the current deployment for a target.","operationId":"getCurrentDeployments","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deployment"},"example":{"mode":"PUBLISH","status":null,"running":true,"duration":null,"start":"2025-03-11T17:07:00.006221-04:00","end":null,"target":{"env":"default","site_name":"ed","load_date":"2025-03-11T17:00:09.935316-04:00","status":"INIT_COMPLETED","id":"ed-default"},"changeSet":{"created_files":["/site/website/articles/2023/2/10-tips-to-get-in-shape/index.xml","/site/website/articles/2023/2/top-romantic-valentine-movies/index.xml","/site/website/articles/2023/3/5-popular-diets-for-women/index.xml","/site/website/articles/2023/3/top-clubs-in-virginia/index.xml","/site/website/articles/2023/jan/men-styles-for-winter/index.xml","/site/website/articles/2023/jan/women-styles-for-winter/index.xml"],"updated_files":[],"deleted_files":[]},"processorExecutions":[{"processor_name":"gitPullProcessor","start":"2025-03-11T17:07:00.006486-04:00","end":"2025-03-11T17:07:00.241206-04:00","status":"SUCCESS","status_details":"Changes successfully pulled from remote repo /Users/craftercms/crafter-authoring/data/repos/sites/ed/published into local repo /Users/craftercms/crafter-delivery/data/repos/sites/ed (merge result with status Fast-forward)","running":false},{"processor_name":"gitDiffProcessor","start":"2025-03-11T17:07:00.241546-04:00","end":"2025-03-11T17:07:00.254525-04:00","status":"SUCCESS","status_details":"Changes detected and resolved successfully","running":false},{"processor_name":"searchIndexingProcessor","start":"2025-03-11T17:07:00.255056-04:00","end":null,"status":null,"status_details":{"successful_updates":["/site/website/articles/2023/2/10-tips-to-get-in-shape/index.xml","/site/website/articles/2023/2/top-romantic-valentine-movies/index.xml","/site/website/articles/2023/3/5-popular-diets-for-women/index.xml"],"successful_deletes":[],"failed_updates":[],"failed_deletes":[],"successful_updates_and_deletes":3,"attempted_updates_and_deletes":3,"failed_updates_and_deletes":0},"running":true}]}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deployments/get-all/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get the current and pending deployments for a target.","operationId":"getAllDeployments","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"example":[{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]},{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]}]}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/unlock/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Clear git lock of a Crafter Deployer target.","operationId":"unlockTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}},{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/recreate/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Recreate the underlying search index for a Crafter Deployer target.","operationId":"recreateIndex","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}},{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"202":{"$ref":"#/components/responses/Accepted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/duplicate/{env}/{source_site_name}":{"post":{"tags":["target"],"summary":"Duplicate a target","operationId":"duplicateTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":"dev"},{"name":"source_site_name","in":"path","description":"The source project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":"editorial"}],"requestBody":{"description":"Duplicate target's request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateTargetRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/Created"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/version":{"get":{"security":[],"tags":["monitoring"],"summary":"Get a Crafter Deployer's version details.","operationId":"version","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"VersionInfo":{"type":"object","properties":{"packageName":{"type":"string"},"packageVersion":{"type":"string"},"packageBuild":{"type":"string"},"packageBuildDate":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"osArch":{"type":"string"},"javaVersion":{"type":"string"},"javaVendor":{"type":"string"},"javaVm":{"type":"string"}},"example":{"packageName":"Crafter Deployer","packageVersion":"4.1.0-SNAPSHOT","packageBuild":"f33f1804c95dd0df4902c9732203841d22022459","packageBuildDate":"2023-04-17T21:28:40.642Z","osName":"Mac OS X","osVersion":"13.2.1","osArch":"x86_64","javaVersion":17,"javaVendor":"Oracle Corporation","javaVm":"OpenJDK 64-Bit Server VM"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/status":{"get":{"security":[],"tags":["monitoring"],"summary":"Get a Crafter Deployer's status details.","operationId":"status","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"StatusInfo":{"type":"object","properties":{"uptime":{"type":"string"},"startup":{"type":"string"}},"example":{"uptime":49986,"startup":"2023-04-17T14:16:29.188Z"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/memory":{"get":{"security":[],"tags":["monitoring"],"summary":"Get a Crafter Deployer's memory details.","operationId":"memory","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"MemoryInfo":{"type":"object","properties":{"totalJvmMemory":{"type":"string"},"freeJvmMemory":{"type":"string"},"maxJvmMemory":{"type":"string"},"totalOsMemory":{"type":"string"},"freeOsMemory":{"type":"string"},"totalSwapMemory":{"type":"string"},"freeSwapMemory":{"type":"string"}},"example":{"totalJvmMemory":154140672,"freeJvmMemory":102165520,"maxJvmMemory":1073741824,"totalOsMemory":34359738368,"freeOsMemory":59957248,"totalSwapMemory":8589934592,"freeSwapMemory":1076363264}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"Targets":{"type":"object","properties":{"env":{"type":"string"},"siteName":{"type":"string"},"id":{"type":"string"},"load_date":{"type":"string"},"status":{"type":"string"}}},"Deployment":{"type":"object","properties":{"mode":{"type":"string"},"status":{"type":"string"},"running":{"type":"boolean"},"duration":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"target":{"$ref":"#/components/schemas/Targets"},"changeSet":{"$ref":"#/components/schemas/ChangeSet"},"processorExecutions":{"type":"array","items":{"type":"string"}}}},"ChangeSet":{"type":"object","properties":{"created_files":{"type":"array","items":{"type":"string"}},"updated_files":{"type":"array","items":{"type":"string"}},"deleted_files":{"type":"array","items":{"type":"string"}}}},"DuplicateTargetRequest":{"allOf":[{"$ref":"#/components/schemas/CreateTargetRequest"},{"type":"object","properties":{"source":{"allOf":[{"$ref":"#/components/schemas/CreateTargetRequest"}]}}}]},"CreateTargetRequest":{"type":"object","properties":{"env":{"type":"string","description":"The target’s environment (e.g. dev)."},"site_name":{"type":"string","description":"The target’s project/site name (e.g. my-editorial)."},"replace":{"type":"boolean","description":"Replace the existing target."},"template_name":{"type":"string","description":"The template to use for configuration generation. Out-of-the-box remote and local are provided. If not specified, remote will be used."},"disable_deploy_cron":{"type":"boolean","description":"Disables the cron job that runs deployments every certain amount of time."},"repo_url":{"type":"string","description":"Depends on the template. If <i>remote</i> is being used, it specifies the URL of the remote repo to pull from (e.g. ssh://…). If instead the template is <i>local</i>, <i>repo_url</i> is the filesystem path of the local repo (e.g. /opt/..)."},"repo_branch":{"type":"string","description":"Only use with <i>remote</i> template. The branch name of the remote Git repo to pull from. If not specified, the branch will be whatever branch is the current one in the remote repo."},"repo_username":{"type":"string","description":"Only use with <i>remote</i> template. The username of the remote Git repo."},"repo_password":{"type":"string","description":"Only use with <i>remote</i> template. The username of the remote Git repo."},"ssh_private_key_path":{"type":"string","description":"Only use with <i>remote</i> template. The path for the private key used for the remote Git repo."},"ssh_private_key_passphrase":{"type":"string","description":"Only use with <i>remote</i> template. The passphrase for the private key for the remote Git repo (only if the key is passphrase-protected)."},"engine_url":{"type":"string","description":"Base URL of Engine, used to make API calls like clear cache and rebuild context. If not specified, the default is http://localhost:8080."},"notification_addresses":{"type":"string","description":"The email addresses that should receive deployment notifications."}},"required":["env","site_name","repo_url"]}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Target not found"}}}}}},"Created":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Required request parameter 'token' for method parameter type String is not present"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid management token"}}}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Target already exists"}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}},"Accepted":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"OK"}}}}}}}}}},"searchIndex":{"store":["tag/target","tag/target/operation/createTarget","tag/target/operation/getTarget","tag/target/operation/getAllTargets","tag/target/operation/deleteTarget","tag/target/operation/deleteTargetIfExists","tag/target/operation/deployTarget","tag/target/operation/deployAllTargets","tag/target/operation/getPendingDeployments","tag/target/operation/getCurrentDeployments","tag/target/operation/getAllDeployments","tag/target/operation/unlockTarget","tag/target/operation/recreateIndex","tag/target/operation/duplicateTarget","tag/monitoring","tag/monitoring/operation/version","tag/monitoring/operation/status","tag/monitoring/operation/memory"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.201]],["description/0",[0,0.168,1,3.016,2,2.409]],["title/1",[0,0.136,3,1.955,4,0.404,5,0.329]],["description/1",[0,0.119,3,0.846,5,0.054,6,0.404,7,0.404,8,1.059,9,0.404,10,0.404,11,0.404,12,0.404,13,1.059,14,1.059,15,0.754,16,0.754,17,0.602,18,0.404,19,0.404,20,0.404,21,0.404,22,0.754,23,0.404,24,0.404,25,0.754,26,0.404,27,0.404,28,0.404,29,0.404,30,0.404,31,0.404,32,0.404,33,0.404,34,0.404,35,0.404,36,0.404,37,0.404,38,0.846,39,0.754,40,0.404,41,0.404,42,0.404,43,0.404,44,0.404,45,0.404,46,0.404,47,0.404]],["title/2",[0,0.152,4,0.452,5,0.369]],["description/2",[48,3.764]],["title/3",[0,0.152,4,0.452,5,0.369]],["description/3",[49,3.764]],["title/4",[0,0.136,4,0.404,5,0.329,50,1.955]],["description/4",[51,3.764]],["title/5",[0,0.123,4,0.364,5,0.297,38,1.766,50,1.766]],["description/5",[52,3.764]],["title/6",[0,0.136,4,0.404,5,0.458]],["description/6",[53,3.764]],["title/7",[0,0.136,4,0.404,5,0.458]],["description/7",[54,3.764]],["title/8",[0,0.152,5,0.369,55,2.191]],["description/8",[56,3.764]],["title/9",[0,0.152,5,0.369,57,2.191]],["description/9",[58,3.764]],["title/10",[0,0.136,5,0.329,55,1.955,57,1.955]],["description/10",[59,3.764]],["title/11",[0,0.112,4,0.332,5,0.271,17,1.609,60,2.015,61,2.015]],["description/11",[62,3.764]],["title/12",[0,0.103,4,0.305,5,0.249,63,1.851,64,1.851,65,1.851,66,1.851]],["description/12",[67,3.764]],["title/13",[0,0.173,68,3.119]],["description/13",[69,3.764]],["title/14",[70,2.887]],["description/14",[2,2.675,70,2.675]],["title/15",[4,0.404,71,1.631,72,2.448,73,1.631]],["description/15",[74,3.764]],["title/16",[4,0.404,71,1.631,73,1.631,75,2.448]],["description/16",[76,3.764]],["title/17",[4,0.404,71,1.631,73,1.631,77,2.448]],["description/17",[78,3.764]]],"invertedIndex":[["409",{"_index":45,"title":{},"description":{"1":{}}}],["alreadi",{"_index":37,"title":{},"description":{"1":{}}}],["api/1/monitoring/memori",{"_index":78,"title":{},"description":{"17":{}}}],["api/1/monitoring/statu",{"_index":76,"title":{},"description":{"16":{}}}],["api/1/monitoring/vers",{"_index":74,"title":{},"description":{"15":{}}}],["api/1/target/cr",{"_index":47,"title":{},"description":{"1":{}}}],["api/1/target/delete-if-exists/{env}/{site_nam",{"_index":52,"title":{},"description":{"5":{}}}],["api/1/target/delete/{env}/{site_nam",{"_index":51,"title":{},"description":{"4":{}}}],["api/1/target/deploy-al",{"_index":54,"title":{},"description":{"7":{}}}],["api/1/target/deploy/{env}/{site_nam",{"_index":53,"title":{},"description":{"6":{}}}],["api/1/target/deployments/get-all/{env}/{site_nam",{"_index":59,"title":{},"description":{"10":{}}}],["api/1/target/deployments/get-current/{env}/{site_nam",{"_index":58,"title":{},"description":{"9":{}}}],["api/1/target/deployments/get-pending/{env}/{site_nam",{"_index":56,"title":{},"description":{"8":{}}}],["api/1/target/duplicate/{env}/{source_site_nam",{"_index":69,"title":{},"description":{"13":{}}}],["api/1/target/get-al",{"_index":49,"title":{},"description":{"3":{}}}],["api/1/target/get/{env}/{site_nam",{"_index":48,"title":{},"description":{"2":{}}}],["api/1/target/recreate/{env}/{site_nam",{"_index":67,"title":{},"description":{"12":{}}}],["api/1/target/unlock/{env}/{site_nam",{"_index":62,"title":{},"description":{"11":{}}}],["author",{"_index":35,"title":{},"description":{"1":{}}}],["b><i>replace</i></b",{"_index":39,"title":{},"description":{"1":{}}}],["base",{"_index":7,"title":{},"description":{"1":{}}}],["box",{"_index":12,"title":{},"description":{"1":{}}}],["br><br",{"_index":36,"title":{},"description":{"1":{}}}],["chang",{"_index":16,"title":{},"description":{"1":{}}}],["clear",{"_index":60,"title":{"11":{}},"description":{}}],["come",{"_index":9,"title":{},"description":{"1":{}}}],["commit",{"_index":29,"title":{},"description":{"1":{}}}],["crafter",{"_index":4,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"11":{},"12":{},"15":{},"16":{},"17":{}},"description":{}}],["creat",{"_index":3,"title":{"1":{}},"description":{"1":{}}}],["creation",{"_index":6,"title":{},"description":{"1":{}}}],["current",{"_index":57,"title":{"9":{},"10":{}},"description":{}}],["delet",{"_index":50,"title":{"4":{},"5":{}},"description":{}}],["deliveri",{"_index":21,"title":{},"description":{"1":{}}}],["deploy",{"_index":5,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"1":{}}}],["deployer'",{"_index":71,"title":{"15":{},"16":{},"17":{}},"description":{}}],["detail",{"_index":73,"title":{"15":{},"16":{},"17":{}},"description":{}}],["duplic",{"_index":68,"title":{"13":{}},"description":{}}],["environ",{"_index":22,"title":{},"description":{"1":{}}}],["execut",{"_index":32,"title":{},"description":{"1":{}}}],["exist",{"_index":38,"title":{"5":{}},"description":{"1":{}}}],["fals",{"_index":44,"title":{},"description":{"1":{}}}],["gener",{"_index":24,"title":{},"description":{"1":{}}}],["git",{"_index":17,"title":{"11":{}},"description":{"1":{}}}],["ideal",{"_index":20,"title":{},"description":{"1":{}}}],["index",{"_index":66,"title":{"12":{}},"description":{}}],["infer",{"_index":30,"title":{},"description":{"1":{}}}],["instead",{"_index":23,"title":{},"description":{"1":{}}}],["it’",{"_index":33,"title":{},"description":{"1":{}}}],["last",{"_index":27,"title":{},"description":{"1":{}}}],["local",{"_index":14,"title":{},"description":{"1":{}}}],["lock",{"_index":61,"title":{"11":{}},"description":{}}],["make",{"_index":19,"title":{},"description":{"1":{}}}],["manag",{"_index":1,"title":{},"description":{"0":{}}}],["memori",{"_index":77,"title":{"17":{}},"description":{}}],["monitor",{"_index":70,"title":{"14":{}},"description":{"14":{}}}],["mostli",{"_index":34,"title":{},"description":{"1":{}}}],["new",{"_index":41,"title":{},"description":{"1":{}}}],["on",{"_index":43,"title":{},"description":{"1":{}}}],["oper",{"_index":2,"title":{},"description":{"0":{},"14":{}}}],["out",{"_index":11,"title":{},"description":{"1":{}}}],["pend",{"_index":55,"title":{"8":{},"10":{}},"description":{}}],["process",{"_index":28,"title":{},"description":{"1":{}}}],["pull",{"_index":15,"title":{},"description":{"1":{}}}],["recreat",{"_index":63,"title":{"12":{}},"description":{}}],["remot",{"_index":13,"title":{},"description":{"1":{}}}],["replac",{"_index":42,"title":{},"description":{"1":{}}}],["repo",{"_index":26,"title":{},"description":{"1":{}}}],["repositori",{"_index":18,"title":{},"description":{"1":{}}}],["return",{"_index":46,"title":{},"description":{"1":{}}}],["search",{"_index":65,"title":{"12":{}},"description":{}}],["statu",{"_index":75,"title":{"16":{}},"description":{}}],["target",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{}},"description":{"0":{},"1":{}}}],["templat",{"_index":8,"title":{},"description":{"1":{}}}],["true",{"_index":40,"title":{},"description":{"1":{}}}],["two",{"_index":10,"title":{},"description":{"1":{}}}],["underli",{"_index":64,"title":{"12":{}},"description":{}}],["us",{"_index":25,"title":{},"description":{"1":{}}}],["version",{"_index":72,"title":{"15":{}},"description":{}}],["without",{"_index":31,"title":{},"description":{"1":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:9191"}],"info":{"description":"Crafter Deployer API","version":"4.5.0","title":"Crafter Deployer","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Deployer","url":"https://craftercms.com/docs/current/reference/modules/deployer.html"},"tags":[{"name":"target","description":"Target management  operations"},{"name":"monitoring","description":"Monitoring operations"}],"paths":{"/api/1/target/create":{"post":{"security":[],"tags":["target"],"summary":"Create a Crafter Deployer target","description":"Target creation is based on templates. The deployer comes with two out of the box: remote and local. The remote template creates targets that pull changes from a remote Git repository, making it ideal to create targets for delivery environments. The local template instead generates targets that use a local Git repo and the last processed commit to infer the changes, without executing a pull, so it’s used mostly to create targets for authoring environments. <br><br> If a target already exists and <b><i>replace</i></b> is true, then the new target will replace the existing one. If <b><i>replace</i></b> is false and the target exists, a 409 is returned.","operationId":"createTarget","requestBody":{"description":"Create target request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTargetRequest"},"examples":{"simpleExample":{"summary":"Simple example of the request body","value":{"env":"preview","site_name":"my-editorial","replace":true,"disable_deploy_cron":true,"template_name":"local","repo_url":"/opt/crafter/data/repos/sites/my-editorial/sandbox","engine_url":"http://localhost:8080"}},"withNotificationAddresses":{"summary":"Example of request body with notification addresses","value":{"env":"dev","site_name":"my-editorial","replace":false,"template_name":"remote","repo_url":"ssh://crafter@server/opt/crafter/data/repos/sites/my-editorial/published","repo_username":"crafter","repo_password":"crafter","repo_branch":"live","engine_url":"http://localhost:8080","notification_addresses":"admin1@my-editorial.com, admin2@my-editorial.com"}},"withGitPullOptions":{"summary":"Example of request body with git pull options","value":{"env":"dev","site_name":"my-editorial","replace":false,"template_name":"remote","repo_url":"ssh://crafter@server/opt/crafter/data/repos/sites/my-editorial/published","repo_username":"crafter","repo_password":"crafter","repo_branch":"live","engine_url":"http://localhost:8080","fast_forward_mode":"FF","merge_strategy":"recursive","content_merge_option":"THEIRS"}}}}}},"responses":{"201":{"$ref":"#/components/responses/Created"},"400":{"$ref":"#/components/responses/BadRequest"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/get/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get a Crafter Deployer target.","operationId":"getTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Targets"},"example":{"env":"dev","siteName":"editorial","id":"editorial-dev","load_date":"2023-01-26T10:00:01.234-05:00","status":"INIT_COMPLETED"}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/get-all":{"get":{"security":[],"tags":["target"],"summary":"Get all Crafter Deployer targets.","operationId":"getAllTargets","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Targets"}},"example":[{"load_date":"2023-03-30T13:24:36.042181-04:00","env":"preview","siteName":"hi","status":"INIT_COMPLETED","id":"hi-preview"},{"load_date":"2023-03-31T09:48:48.214383-04:00","env":"preview","siteName":"third","status":"INIT_COMPLETED","id":"third-preview"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/delete/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Delete a Crafter Deployer target.","operationId":"deleteTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"204":{"description":"NO CONTENT"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/delete-if-exists/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Delete a Crafter Deployer target if it exists.","operationId":"deleteTargetIfExists","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"204":{"description":"NO CONTENT"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deploy/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Deploy a Crafter Deployer target.","operationId":"deployTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reprocess_all_files":{"description":"If all files in all the target repos should be reprocessed.","type":"boolean"},"from_commit_id":{"description":"The id of the commit to start processing changes<br><br> <i>Available since version 4.0.0</i>","type":"string"},"deployment_mode":{"description":"The deployment mode to execute. Possible values: <br> &nbsp;&nbsp;&nbsp;<b>PUBLISH</b>: All processors will run<br> &nbsp;&nbsp;&nbsp;<b>SEARCH_INDEX</b>: Only the indexing processor will run <br><br> <i>Available since version 4.0.0</i>","type":"string"}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"OK"}}}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deploy-all":{"post":{"security":[],"tags":["target"],"summary":"Deploy all Crafter Deployer targets.","operationId":"deployAllTargets","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reprocess_all_files":{"description":"If all files in all the target repos should be reprocessed.","type":"boolean"},"deployment_mode":{"description":"The deployment mode to execute. Possible values: <br> &nbsp;&nbsp;&nbsp;<b>PUBLISH</b>: All processors will run<br> &nbsp;&nbsp;&nbsp;<b>SEARCH_INDEX</b>: Only the indexing processor will run <br><br> <i>Available since version 4.0.0</i>","type":"string"}}}}}},"responses":{"202":{"$ref":"#/components/responses/Accepted"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deployments/get-pending/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get the pending deployments for a target.","operationId":"getPendingDeployments","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"example":[{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]},{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]}]}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deployments/get-current/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get the current deployment for a target.","operationId":"getCurrentDeployments","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deployment"},"example":{"mode":"PUBLISH","status":null,"running":true,"duration":null,"start":"2025-03-11T17:07:00.006221-04:00","end":null,"target":{"env":"default","site_name":"ed","load_date":"2025-03-11T17:00:09.935316-04:00","status":"INIT_COMPLETED","id":"ed-default"},"changeSet":{"created_files":["/site/website/articles/2023/2/10-tips-to-get-in-shape/index.xml","/site/website/articles/2023/2/top-romantic-valentine-movies/index.xml","/site/website/articles/2023/3/5-popular-diets-for-women/index.xml","/site/website/articles/2023/3/top-clubs-in-virginia/index.xml","/site/website/articles/2023/jan/men-styles-for-winter/index.xml","/site/website/articles/2023/jan/women-styles-for-winter/index.xml"],"updated_files":[],"deleted_files":[]},"processorExecutions":[{"processor_name":"gitPullProcessor","start":"2025-03-11T17:07:00.006486-04:00","end":"2025-03-11T17:07:00.241206-04:00","status":"SUCCESS","status_details":"Changes successfully pulled from remote repo /Users/craftercms/crafter-authoring/data/repos/sites/ed/published into local repo /Users/craftercms/crafter-delivery/data/repos/sites/ed (merge result with status Fast-forward)","running":false},{"processor_name":"gitDiffProcessor","start":"2025-03-11T17:07:00.241546-04:00","end":"2025-03-11T17:07:00.254525-04:00","status":"SUCCESS","status_details":"Changes detected and resolved successfully","running":false},{"processor_name":"searchIndexingProcessor","start":"2025-03-11T17:07:00.255056-04:00","end":null,"status":null,"status_details":{"successful_updates":["/site/website/articles/2023/2/10-tips-to-get-in-shape/index.xml","/site/website/articles/2023/2/top-romantic-valentine-movies/index.xml","/site/website/articles/2023/3/5-popular-diets-for-women/index.xml"],"successful_deletes":[],"failed_updates":[],"failed_deletes":[],"successful_updates_and_deletes":3,"attempted_updates_and_deletes":3,"failed_updates_and_deletes":0},"running":true}]}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/deployments/get-all/{env}/{site_name}":{"get":{"security":[],"tags":["target"],"summary":"Get the current and pending deployments for a target.","operationId":"getAllDeployments","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Deployment"}},"example":[{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]},{"mode":"PUBLISH","status":null,"running":false,"duration":null,"start":null,"end":null,"target":{"env":"preview","site_name":"ed","load_date":"2025-03-10T11:44:03.613404-04:00","status":"INIT_COMPLETED","id":"ed-preview"},"changeSet":{"created_files":[],"updated_files":[],"deleted_files":[]},"processorExecutions":[]}]}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/unlock/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Clear git lock of a Crafter Deployer target.","operationId":"unlockTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}},{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/recreate/{env}/{site_name}":{"post":{"security":[],"tags":["target"],"summary":"Recreate the underlying search index for a Crafter Deployer target.","operationId":"recreateIndex","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":{"env":"dev"}},{"name":"site_name","in":"path","description":"The target’s project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":{"site_name":"editorial"}},{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"202":{"$ref":"#/components/responses/Accepted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/target/duplicate/{env}/{source_site_name}":{"post":{"tags":["target"],"summary":"Duplicate a target","operationId":"duplicateTarget","parameters":[{"name":"env","in":"path","description":"The target’s environment (e.g. dev).","required":true,"schema":{"type":"string"},"example":"dev"},{"name":"source_site_name","in":"path","description":"The source project/site name (e.g. editorial).","required":true,"schema":{"type":"string"},"example":"editorial"}],"requestBody":{"description":"Duplicate target's request body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateTargetRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/Created"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/version":{"get":{"security":[],"tags":["monitoring"],"summary":"Get a Crafter Deployer's version details.","operationId":"version","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"VersionInfo":{"type":"object","properties":{"packageName":{"type":"string"},"packageVersion":{"type":"string"},"packageBuild":{"type":"string"},"packageBuildDate":{"type":"string"},"osName":{"type":"string"},"osVersion":{"type":"string"},"osArch":{"type":"string"},"javaVersion":{"type":"string"},"javaVendor":{"type":"string"},"javaVm":{"type":"string"}},"example":{"packageName":"Crafter Deployer","packageVersion":"4.1.0-SNAPSHOT","packageBuild":"f33f1804c95dd0df4902c9732203841d22022459","packageBuildDate":"2023-04-17T21:28:40.642Z","osName":"Mac OS X","osVersion":"13.2.1","osArch":"x86_64","javaVersion":17,"javaVendor":"Oracle Corporation","javaVm":"OpenJDK 64-Bit Server VM"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/status":{"get":{"security":[],"tags":["monitoring"],"summary":"Get a Crafter Deployer's status details.","operationId":"status","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"StatusInfo":{"type":"object","properties":{"uptime":{"type":"string"},"startup":{"type":"string"}},"example":{"uptime":49986,"startup":"2023-04-17T14:16:29.188Z"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/memory":{"get":{"security":[],"tags":["monitoring"],"summary":"Get a Crafter Deployer's memory details.","operationId":"memory","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"MemoryInfo":{"type":"object","properties":{"totalJvmMemory":{"type":"string"},"freeJvmMemory":{"type":"string"},"maxJvmMemory":{"type":"string"},"totalOsMemory":{"type":"string"},"freeOsMemory":{"type":"string"},"totalSwapMemory":{"type":"string"},"freeSwapMemory":{"type":"string"}},"example":{"totalJvmMemory":154140672,"freeJvmMemory":102165520,"maxJvmMemory":1073741824,"totalOsMemory":34359738368,"freeOsMemory":59957248,"totalSwapMemory":8589934592,"freeSwapMemory":1076363264}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"Targets":{"type":"object","properties":{"env":{"type":"string"},"siteName":{"type":"string"},"id":{"type":"string"},"load_date":{"type":"string"},"status":{"type":"string"}}},"Deployment":{"type":"object","properties":{"mode":{"type":"string"},"status":{"type":"string"},"running":{"type":"boolean"},"duration":{"type":"string"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"target":{"$ref":"#/components/schemas/Targets"},"changeSet":{"$ref":"#/components/schemas/ChangeSet"},"processorExecutions":{"type":"array","items":{"type":"string"}}}},"ChangeSet":{"type":"object","properties":{"created_files":{"type":"array","items":{"type":"string"}},"updated_files":{"type":"array","items":{"type":"string"}},"deleted_files":{"type":"array","items":{"type":"string"}}}},"DuplicateTargetRequest":{"allOf":[{"$ref":"#/components/schemas/CreateTargetRequest"},{"type":"object","properties":{"source":{"allOf":[{"$ref":"#/components/schemas/CreateTargetRequest"}]}}}]},"CreateTargetRequest":{"type":"object","properties":{"env":{"type":"string","description":"The target’s environment (e.g. dev)."},"site_name":{"type":"string","description":"The target’s project/site name (e.g. my-editorial)."},"replace":{"type":"boolean","description":"Replace the existing target."},"template_name":{"type":"string","description":"The template to use for configuration generation. Out-of-the-box remote and local are provided. If not specified, remote will be used."},"disable_deploy_cron":{"type":"boolean","description":"Disables the cron job that runs deployments every certain amount of time."},"repo_url":{"type":"string","description":"Depends on the template. If <i>remote</i> is being used, it specifies the URL of the remote repo to pull from (e.g. ssh://…). If instead the template is <i>local</i>, <i>repo_url</i> is the filesystem path of the local repo (e.g. /opt/..)."},"repo_branch":{"type":"string","description":"Only use with <i>remote</i> template. The branch name of the remote Git repo to pull from. If not specified, the branch will be whatever branch is the current one in the remote repo."},"repo_username":{"type":"string","description":"Only use with <i>remote</i> template. The username of the remote Git repo."},"repo_password":{"type":"string","description":"Only use with <i>remote</i> template. The password of the remote Git repo."},"ssh_private_key_path":{"type":"string","description":"Only use with <i>remote</i> template. The path for the private key used for the remote Git repo."},"ssh_private_key_passphrase":{"type":"string","description":"Only use with <i>remote</i> template. The passphrase for the private key for the remote Git repo (only if the key is passphrase-protected)."},"engine_url":{"type":"string","description":"Base URL of Engine, used to make API calls like clear cache and rebuild context. If not specified, the default is http://localhost:8080."},"notification_addresses":{"type":"string","description":"The email addresses that should receive deployment notifications."}},"required":["env","site_name","repo_url"]}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Target not found"}}}}}},"Created":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Required request parameter 'token' for method parameter type String is not present"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid management token"}}}}}},"Conflict":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Target already exists"}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}},"Accepted":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"OK"}}}}}}}}}},"searchIndex":{"store":["tag/target","tag/target/operation/createTarget","tag/target/operation/getTarget","tag/target/operation/getAllTargets","tag/target/operation/deleteTarget","tag/target/operation/deleteTargetIfExists","tag/target/operation/deployTarget","tag/target/operation/deployAllTargets","tag/target/operation/getPendingDeployments","tag/target/operation/getCurrentDeployments","tag/target/operation/getAllDeployments","tag/target/operation/unlockTarget","tag/target/operation/recreateIndex","tag/target/operation/duplicateTarget","tag/monitoring","tag/monitoring/operation/version","tag/monitoring/operation/status","tag/monitoring/operation/memory"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.201]],["description/0",[0,0.168,1,3.016,2,2.409]],["title/1",[0,0.136,3,1.955,4,0.404,5,0.329]],["description/1",[0,0.119,3,0.846,5,0.054,6,0.404,7,0.404,8,1.059,9,0.404,10,0.404,11,0.404,12,0.404,13,1.059,14,1.059,15,0.754,16,0.754,17,0.602,18,0.404,19,0.404,20,0.404,21,0.404,22,0.754,23,0.404,24,0.404,25,0.754,26,0.404,27,0.404,28,0.404,29,0.404,30,0.404,31,0.404,32,0.404,33,0.404,34,0.404,35,0.404,36,0.404,37,0.404,38,0.846,39,0.754,40,0.404,41,0.404,42,0.404,43,0.404,44,0.404,45,0.404,46,0.404,47,0.404]],["title/2",[0,0.152,4,0.452,5,0.369]],["description/2",[48,3.764]],["title/3",[0,0.152,4,0.452,5,0.369]],["description/3",[49,3.764]],["title/4",[0,0.136,4,0.404,5,0.329,50,1.955]],["description/4",[51,3.764]],["title/5",[0,0.123,4,0.364,5,0.297,38,1.766,50,1.766]],["description/5",[52,3.764]],["title/6",[0,0.136,4,0.404,5,0.458]],["description/6",[53,3.764]],["title/7",[0,0.136,4,0.404,5,0.458]],["description/7",[54,3.764]],["title/8",[0,0.152,5,0.369,55,2.191]],["description/8",[56,3.764]],["title/9",[0,0.152,5,0.369,57,2.191]],["description/9",[58,3.764]],["title/10",[0,0.136,5,0.329,55,1.955,57,1.955]],["description/10",[59,3.764]],["title/11",[0,0.112,4,0.332,5,0.271,17,1.609,60,2.015,61,2.015]],["description/11",[62,3.764]],["title/12",[0,0.103,4,0.305,5,0.249,63,1.851,64,1.851,65,1.851,66,1.851]],["description/12",[67,3.764]],["title/13",[0,0.173,68,3.119]],["description/13",[69,3.764]],["title/14",[70,2.887]],["description/14",[2,2.675,70,2.675]],["title/15",[4,0.404,71,1.631,72,2.448,73,1.631]],["description/15",[74,3.764]],["title/16",[4,0.404,71,1.631,73,1.631,75,2.448]],["description/16",[76,3.764]],["title/17",[4,0.404,71,1.631,73,1.631,77,2.448]],["description/17",[78,3.764]]],"invertedIndex":[["409",{"_index":45,"title":{},"description":{"1":{}}}],["alreadi",{"_index":37,"title":{},"description":{"1":{}}}],["api/1/monitoring/memori",{"_index":78,"title":{},"description":{"17":{}}}],["api/1/monitoring/statu",{"_index":76,"title":{},"description":{"16":{}}}],["api/1/monitoring/vers",{"_index":74,"title":{},"description":{"15":{}}}],["api/1/target/cr",{"_index":47,"title":{},"description":{"1":{}}}],["api/1/target/delete-if-exists/{env}/{site_nam",{"_index":52,"title":{},"description":{"5":{}}}],["api/1/target/delete/{env}/{site_nam",{"_index":51,"title":{},"description":{"4":{}}}],["api/1/target/deploy-al",{"_index":54,"title":{},"description":{"7":{}}}],["api/1/target/deploy/{env}/{site_nam",{"_index":53,"title":{},"description":{"6":{}}}],["api/1/target/deployments/get-all/{env}/{site_nam",{"_index":59,"title":{},"description":{"10":{}}}],["api/1/target/deployments/get-current/{env}/{site_nam",{"_index":58,"title":{},"description":{"9":{}}}],["api/1/target/deployments/get-pending/{env}/{site_nam",{"_index":56,"title":{},"description":{"8":{}}}],["api/1/target/duplicate/{env}/{source_site_nam",{"_index":69,"title":{},"description":{"13":{}}}],["api/1/target/get-al",{"_index":49,"title":{},"description":{"3":{}}}],["api/1/target/get/{env}/{site_nam",{"_index":48,"title":{},"description":{"2":{}}}],["api/1/target/recreate/{env}/{site_nam",{"_index":67,"title":{},"description":{"12":{}}}],["api/1/target/unlock/{env}/{site_nam",{"_index":62,"title":{},"description":{"11":{}}}],["author",{"_index":35,"title":{},"description":{"1":{}}}],["b><i>replace</i></b",{"_index":39,"title":{},"description":{"1":{}}}],["base",{"_index":7,"title":{},"description":{"1":{}}}],["box",{"_index":12,"title":{},"description":{"1":{}}}],["br><br",{"_index":36,"title":{},"description":{"1":{}}}],["chang",{"_index":16,"title":{},"description":{"1":{}}}],["clear",{"_index":60,"title":{"11":{}},"description":{}}],["come",{"_index":9,"title":{},"description":{"1":{}}}],["commit",{"_index":29,"title":{},"description":{"1":{}}}],["crafter",{"_index":4,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"11":{},"12":{},"15":{},"16":{},"17":{}},"description":{}}],["creat",{"_index":3,"title":{"1":{}},"description":{"1":{}}}],["creation",{"_index":6,"title":{},"description":{"1":{}}}],["current",{"_index":57,"title":{"9":{},"10":{}},"description":{}}],["delet",{"_index":50,"title":{"4":{},"5":{}},"description":{}}],["deliveri",{"_index":21,"title":{},"description":{"1":{}}}],["deploy",{"_index":5,"title":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"1":{}}}],["deployer'",{"_index":71,"title":{"15":{},"16":{},"17":{}},"description":{}}],["detail",{"_index":73,"title":{"15":{},"16":{},"17":{}},"description":{}}],["duplic",{"_index":68,"title":{"13":{}},"description":{}}],["environ",{"_index":22,"title":{},"description":{"1":{}}}],["execut",{"_index":32,"title":{},"description":{"1":{}}}],["exist",{"_index":38,"title":{"5":{}},"description":{"1":{}}}],["fals",{"_index":44,"title":{},"description":{"1":{}}}],["gener",{"_index":24,"title":{},"description":{"1":{}}}],["git",{"_index":17,"title":{"11":{}},"description":{"1":{}}}],["ideal",{"_index":20,"title":{},"description":{"1":{}}}],["index",{"_index":66,"title":{"12":{}},"description":{}}],["infer",{"_index":30,"title":{},"description":{"1":{}}}],["instead",{"_index":23,"title":{},"description":{"1":{}}}],["it’",{"_index":33,"title":{},"description":{"1":{}}}],["last",{"_index":27,"title":{},"description":{"1":{}}}],["local",{"_index":14,"title":{},"description":{"1":{}}}],["lock",{"_index":61,"title":{"11":{}},"description":{}}],["make",{"_index":19,"title":{},"description":{"1":{}}}],["manag",{"_index":1,"title":{},"description":{"0":{}}}],["memori",{"_index":77,"title":{"17":{}},"description":{}}],["monitor",{"_index":70,"title":{"14":{}},"description":{"14":{}}}],["mostli",{"_index":34,"title":{},"description":{"1":{}}}],["new",{"_index":41,"title":{},"description":{"1":{}}}],["on",{"_index":43,"title":{},"description":{"1":{}}}],["oper",{"_index":2,"title":{},"description":{"0":{},"14":{}}}],["out",{"_index":11,"title":{},"description":{"1":{}}}],["pend",{"_index":55,"title":{"8":{},"10":{}},"description":{}}],["process",{"_index":28,"title":{},"description":{"1":{}}}],["pull",{"_index":15,"title":{},"description":{"1":{}}}],["recreat",{"_index":63,"title":{"12":{}},"description":{}}],["remot",{"_index":13,"title":{},"description":{"1":{}}}],["replac",{"_index":42,"title":{},"description":{"1":{}}}],["repo",{"_index":26,"title":{},"description":{"1":{}}}],["repositori",{"_index":18,"title":{},"description":{"1":{}}}],["return",{"_index":46,"title":{},"description":{"1":{}}}],["search",{"_index":65,"title":{"12":{}},"description":{}}],["statu",{"_index":75,"title":{"16":{}},"description":{}}],["target",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{}},"description":{"0":{},"1":{}}}],["templat",{"_index":8,"title":{},"description":{"1":{}}}],["true",{"_index":40,"title":{},"description":{"1":{}}}],["two",{"_index":10,"title":{},"description":{"1":{}}}],["underli",{"_index":64,"title":{"12":{}},"description":{}}],["us",{"_index":25,"title":{},"description":{"1":{}}}],["version",{"_index":72,"title":{"15":{}},"description":{}}],["without",{"_index":31,"title":{},"description":{"1":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/source/_static/api/engine.html b/source/_static/api/engine.html
index 09395ae5e..bbac4b6e4 100644
--- a/source/_static/api/engine.html
+++ b/source/_static/api/engine.html
@@ -399,7 +399,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Engine<!-- --> <span>(<!-- -->4.4.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Engine API&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Engine<!-- --> <span>(<!-- -->4.5.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Engine API&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Crafter Engine API</p>
 </div><div class="sc-ixcdjX gvxrGF"><a href="https://craftercms.com/docs/current/reference/modules/engine.html">CrafterCMS - Engine</a></div></div></div></div><div id="tag/content" data-section-id="tag/content" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/content" aria-label="tag/content"></a>content</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="&lt;p&gt;Content retrieval operations&lt;/p&gt;
 "><p>Content retrieval operations</p>
@@ -799,7 +799,7 @@
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>OK</p>
 </div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/crafter-controller/component.json</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:8080</span>/crafter-controller/component.json</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176rq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176rq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176rq»0" aria-labelledby="tab«R176rq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><span class="token string">&quot;&lt;!-- Feature Component --&gt;\\n &lt;article class=\&quot;feature\&quot; data-craftercms-model-path=\&quot;/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\&quot; data-craftercms-model-id=\&quot;4be0a368-783c-8f73-7469-63a62636bd4c\&quot; &gt;  &lt;span class=\&quot;icon fa-smile far\&quot; data-craftercms-model-path=\&quot;/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\&quot; data-craftercms-model-id=\&quot;4be0a368-783c-8f73-7469-63a62636bd4c\&quot; data-craftercms-field-id=\&quot;icon_s\&quot; &gt;&lt;/span&gt; &lt;div class=\&quot;content\&quot;&gt; &lt;h3 data-craftercms-model-path=\&quot;/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\&quot; data-craftercms-model-id=\&quot;4be0a368-783c-8f73-7469-63a62636bd4c\&quot; data-craftercms-field-id=\&quot;title_t\&quot; &gt;      Smile &lt;/h3&gt; &lt;div data-craftercms-model-path=\&quot;/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\&quot; data-craftercms-model-id=\&quot;4be0a368-783c-8f73-7469-63a62636bd4c\&quot; data-craftercms-field-id=\&quot;body_html\&quot; &gt;      &lt;p&gt;Smile, aenean ornare velit lacus, ac varius enim lorem ullamcorper dolore. Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.&lt;/p&gt; &lt;/div&gt; &lt;/div&gt; &lt;/article&gt; &lt;!-- /Feature Component --&gt;&quot;</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080"}],"info":{"description":"Crafter Engine API","version":"4.4.4","title":"Crafter Engine","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Engine","url":"https://craftercms.com/docs/current/reference/modules/engine.html"},"tags":[{"name":"content","description":"Content retrieval operations"},{"name":"navigation","description":"Navigation and structure operations"},{"name":"search","description":"Search operations"},{"name":"cache","description":"Cache operations"},{"name":"context","description":"Project/site context operations"},{"name":"monitoring","description":"Monitoring operations"},{"name":"other","description":"Other miscellaneous operations"}],"paths":{"/api/1/site/context/id.json":{"get":{"security":[],"tags":["context"],"summary":"Get the ID for the site context","operationId":"getSiteContextID","description":"Get the ID for the site context resolved for the current request, the value returned will depend on the SiteResolver implementation used.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The site context Id","example":"405ffc233d075b010536bd2eb786b86c"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/status.json":{"get":{"security":[],"tags":["context"],"summary":"Get the site context status","operationId":"getSiteContextStatus","description":"Get the status for the site context resolved for the current request, the value returned will depend on the SiteResolver implementation used.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The site context status","example":"READY"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/destroy.json":{"get":{"security":[],"tags":["context"],"summary":"Destroy the site context","operationId":"destroySiteContext","description":"Destroy the site context resolved for the current request. Destroying the context involves clearing the cache, destroying any loaded configuration and Spring beans for the site, and destroying the Groovy classloader for the site.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Site context successfully destroyed","example":"Site context for 'sample' destroyed. Will be recreated on next request"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/rebuild.json":{"get":{"security":[],"tags":["context"],"summary":"Rebuild the site context","operationId":"rebuildSiteContext","description":"Rebuild the site context resolved for the current request, which means destroying and then creating the context again.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Site context rebuild started","example":"Started rebuild for site context for 'sample'"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/rebuild_all.json":{"get":{"security":[],"tags":["context"],"summary":"Rebuild all site contexts","operationId":"rebuildAllSiteContexts","description":"Rebuild all site contexts currently found in the registry","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"All site contexts rebuild started","example":"Started rebuild of all site contexts"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/graphql/rebuild.json":{"get":{"security":[],"tags":["context"],"summary":"Rebuild GraphQL Schema","operationId":"rebuildGraphQLSchema","description":"Rebuild the GraphQL schema for the site context resolved for the current request.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"GraphQL schema rebuild started message","example":"Rebuild of GraphQL schema started for 'sample'"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/jobs/list.json":{"get":{"security":[],"tags":["other"],"summary":"List jobs","operationId":"listJobs","description":"Get a list of all scheduled jobs for the current site.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of job"},"nextFireTime":{"type":"string","description":"Time when job will be executed"}}},"example":[{"name":"editorial:/scripts/jobs/hourly/hourly-job.groovy","nextFireTime":"2022-05-08T00:00:00Z"},{"name":"editorial:/scripts/jobs/custom-job.groovy","nextFireTime":"2022-05-08T00:00:00Z"}]}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/mappings/reload.json":{"get":{"security":[],"tags":["context"],"summary":"Reload the mappings","operationId":"mappingsReload","description":"Reload the mappings used to resolve sites by Crafter Engine. This endpoint is only available when Crafter Engine is in mapped multi-tenant mode.","parameters":[{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Successful reloading of mappings message","example":"Mappings reloaded"}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The current resolver is not a ReloadableMappingsSiteResolver. No mappings to reload"}}}}}}}}},"/api/1/site/cache/clear.json":{"get":{"security":[],"tags":["cache"],"summary":"Clear content cache","operationId":"cacheClear","description":"Clear the content cache scope and the Freemarker cache for the current site context.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"},{"name":"cacheType","in":"query","description":"Type of cache.\n\nPossible values are:\n- <b>system</b> : Cache for objects cached by Engine itself.\n- <b>application</b> : Cache for objects cached by Groovy code.\n  This cache is enabled by specifying the value \"crafter_core_applicationCache\" in the <b>SPRING_PROFILES_ACTIVE</b> env variable.\n\nDefault is \"system\".","schema":{"type":"string"},"example":"system"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Cache clear for site 'sample' started"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/cache/statistics.json":{"get":{"security":[],"tags":["cache"],"summary":"Statistics","operationId":"cacheStatistics","description":"Get the statistics for all cache scopes for the current site context. <br><br> <i>Note:</i> <br> <i>The result of this call can change based on the configuration of the system, for example when Crafter Engine is configured in preview mode the cache will be disabled and the result will always be an empty object. There could be also different statistics returned depending on the cache implementation that is being used.</i>","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"},{"name":"cacheType","in":"query","description":"Type of cache.\n\nPossible values are:\n- <b>system</b> : Cache for objects cached by Engine itself.\n- <b>application</b> : Cache for objects cached by Groovy code.\n  This cache is enabled by specifying the value \"crafter_core_applicationCache\" in the <b>SPRING_PROFILES_ACTIVE</b> env variable.\n\nDefault is \"system\".","schema":{"type":"string"},"example":"system"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statistics"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/content_store/item.json":{"get":{"security":[],"tags":["content"],"summary":"Get Item","operationId":"getItem","description":"Get an Item from the content store. <br> This API is used to get pages, components and folders. It returns the content and other metadata such as url, descriptorUrl, folder flag, and extra properties <br><br><i> Note: This API also returns 'disabled' items when Crafter Engine is in preview mode to support authoring use cases.</i>","parameters":[{"name":"url","in":"query","description":"The item’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","required":false,"schema":{"type":"boolean"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStoreItems"},"examples":{"Folder":{"value":{"name":"website","url":"/site/website","descriptorUrl":"/site/website.meta.xml","descriptorDom":null,"properties":null,"folder":true}},"WithAdditionalProperties":{"value":{"name":"index.xml","url":"/site/website/index.xml","descriptorUrl":"/site/website.meta.xml","descriptorDom":{"page":{"content-type":"/page/home","display-template":"/templates/web/pages/home.ftl","merge-strategy":"inherit-levels","placeInNav":false,"file-name":"index.xml","objectGroupId":"8d7f","objectId":"8d7f21fa-5e09-00aa-8340-853b7db302da","folder-name":null,"header":{"item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":false}},"createdDate":"1/31/2022 16:18:14","createdDate_dt":"1/31/2022 16:18:14","lastModifiedDate":"5/18/2022 15:52:21","lastModifiedDate_dt":"5/18/2022 15:52:21","left-rail":{"item":{"key":"/site/components/left-rails/left-rail-with-latest-articles.xml","value":"Left Rail with Latest Articles","include":"/site/components/left-rails/left-rail-with-latest-articles.xml","disableFlattening":false}},"internal-name":"Home","orderDefault_f":-1,"title":"Editorial","hero_text":"<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>","hero_title":"<h1><span>Hi, I&rsquo;m Editorial</span></h1>\n<h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>","features":{"item":[{"value":"Quam lorem ipsum","key":"/site/components/features/quam-lorem-ipsum.xml","include":"/site/components/features/quam-lorem-ipsum.xml","disableFlattening":false},{"key":"/site/components/features/sapien-veroeros.xml","value":"Sapien Veroeros","include":"/site/components/features/sapien-veroeros.xml","disableFlattening\"":false}]},"hero_image":"/static-assets/images/strawberries.jpg","features_title":"Erat lacinia"}},"properties":"//page/merge-strategy: inherit-levels //page/content-type: /page/home","folder":false}},"WithoutAdditionalProperties":{"value":{"name":"index.xml","url":"/site/website/index.xml","descriptorUrl":"/site/website.meta.xml","descriptorDom":{"page":{"content-type":"/page/home","display-template":"/templates/web/pages/home.ftl","merge-strategy":"inherit-levels","placeInNav":false,"file-name":"index.xml","objectGroupId":"8d7f","objectId":"8d7f21fa-5e09-00aa-8340-853b7db302da","folder-name":null,"header":{"item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":false}},"createdDate":"1/31/2022 16:18:14","createdDate_dt":"1/31/2022 16:18:14","lastModifiedDate":"5/18/2022 15:52:21","lastModifiedDate_dt":"5/18/2022 15:52:21","left-rail":{"item":{"key":"/site/components/left-rails/left-rail-with-latest-articles.xml","value":"Left Rail with Latest Articles","include":"/site/components/left-rails/left-rail-with-latest-articles.xml","disableFlattening":false}},"internal-name":"Home","orderDefault_f":-1,"title":"Editorial","hero_text":"<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>","hero_title":"<h1><span>Hi, I&rsquo;m Editorial</span></h1>\n<h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>","features":{"item":[{"key":"/site/components/features/quam-lorem-ipsum.xml","value":"Quam lorem ipsum","include":"/site/components/features/quam-lorem-ipsum.xml","disableFlattening":"false},"},{"key":"/site/components/features/sapien-veroeros.xml","value":"Sapien Veroeros","include":"/site/components/features/sapien-veroeros.xml","disableFlattening":"false}"}]},"hero_image":"/static-assets/images/strawberries.jpg","features_title":"Erat lacinia"}},"properties":"null","folder":false}}}}}},"404":{"$ref":"#/components/responses/NotFound","example":"No item found at /site/website/index.xml"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/content_store/children.json":{"get":{"security":[],"tags":["content"],"summary":"Get Children","operationId":"getChildren","description":"Get the list of Items directly under a folder in the content store.","parameters":[{"name":"url","in":"query","description":"The folder’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","required":false,"schema":{"type":"boolean"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentStoreItems"}},"example":[{"name":"articles","url":"/site/website/articles","descriptorUrl":"/site/website/articles.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"crafter-level-descriptor.level.xml","url":"/site/website/crafter-level-descriptor.level.xml","descriptorUrl":"/site/website/crafter-level-descriptor.level.xml","descriptorDom":{"component":{"content-type":"/component/level-descriptor","display-template":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor"},"merge-strategy":"inherit-levels","file-name":"crafter-level-descriptor.level.xml","objectGroupId":"0a68","objectId":"0a68e8ad-77d8-0a58-e7bf-09a71fb3077b","folder-name":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor"},"header_o":{"item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":"false"}},"createdDate":"2017-03-13T20:26:50.000Z","createdDate_dt":"2017-03-13T20:26:50.000Z","lastModifiedDate":"2017-05-18T15:38:58.000Z","lastModifiedDate_dt":"2017-05-18T15:38:58.000Z","left_rail_o":{"item":{"key":"/site/components/left-rails/left-rail-with-no-articles.xml","value":"Left Rail with No Articles","include":"/site/components/left-rails/left-rail-with-no-articles.xml","disableFlattening":"false"}}}},"properties":null,"folder":false},{"name":"entertainment","url":"/site/website/entertainment","descriptorUrl":"/site/website/entertainment.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"health","url":"/site/website/health","descriptorUrl":"/site/website/health.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"index.xml","url":"/site/website/index.xml","descriptorUrl":"/site/website/index.xml","descriptorDom":{"page":{"content-type":"/page/home","display-template":"/templates/web/pages/home.ftl","merge-strategy":"inherit-levels","file-name":"index.xml","objectGroupId":"8d7f","objectId":"8d7f21fa-5e09-00aa-8340-853b7db302da","folder-name":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor"},"header_o":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor","item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":"false"}},"createdDate":"2017-01-31T16:18:14.000Z","createdDate_dt":"2017-01-31T16:18:14.000Z","lastModifiedDate":"2021-03-31T18:08:03.196Z","lastModifiedDate_dt":"2021-03-31T18:20:09.599Z","left_rail_o":{"item":[{"key":"/site/components/left-rails/left-rail-with-latest-articles.xml","value":"Left Rail with Latest Articles","include":"/site/components/left-rails/left-rail-with-latest-articles.xml","disableFlattening":"false"}]},"no-template-required":null,"internal-name":"Home","orderDefault_f":"-1","title_t":"Editorial","hero_text_html":"<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>","hero_title_html":"<h1>Hi, I&rsquo;m Editorial</h1>\n    <h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>","features_o":{"item":[{"datasource":"features","key":"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml","value":"Smile","include":"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml","disableFlattening":"false"},{"datasource":"features","inline":"true","key":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce","value":"Download","disableFlattening":"false","component":{"id":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce","content-type":"/component/feature","display-template":"/templates/web/components/feature.ftl","no-template-required":null,"merge-strategy":"inherit-levels","objectGroupId":"310b","objectId":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce","file-name":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce.xml","internal-name":"Download","title_t":"Download","disabled":"false","icon_s":"fa-arrow-alt-circle-down far","body_html":"<p>Download ornare velit lacus, ac varius enim lorem ullamcorper dolore.\n          Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p>\n        ","createdDate":"2019-10-11T19:20:07.555Z","createdDate_dt":"2019-10-11T19:20:07.555Z","lastModifiedDate":"2019-12-22T11:56:51.172Z","lastModifiedDate_dt":"2019-12-22T11:56:51.172Z"}},{"datasource":"features","inline":"true","key":"a89386c4-a205-2681-2db1-c3606f714411","value":"Build","disableFlattening":"false","component":{"id":"a89386c4-a205-2681-2db1-c3606f714411","content-type":"/component/feature","display-template":"/templates/web/components/feature.ftl","no-template-required":null,"merge-strategy":"inherit-levels","objectGroupId":"a893","objectId":"a89386c4-a205-2681-2db1-c3606f714411","file-name":"a89386c4-a205-2681-2db1-c3606f714411.xml","internal-name":"Build","title_t":"Build","disabled":"false","icon_s":"fa-building far","body_html":"<p>Build enean ornare velit lacus, ac varius enim lorem ullamcorper dolore.\n          Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p>\n        ","createdDate":"2019-10-11T19:19:53.590Z","createdDate_dt":"2019-10-11T19:19:53.590Z","lastModifiedDate":"2019-12-22T11:56:34.603Z","lastModifiedDate_dt":"2019-12-22T11:56:34.603Z"}},{"datasource":"features","key":"/site/components/features/72ef047f-02b7-89e2-bbd5-4763ac7dbca8.xml","value":"Closed captioning","include":"/site/components/features/72ef047f-02b7-89e2-bbd5-4763ac7dbca8.xml","disableFlattening":"false"}]},"hero_image_s":"/static-assets/images/strawberries.jpg","features_title_t":"Erat lacinia","disabled":"false"}},"properties":null,"folder":false},{"name":"search-results","url":"/site/website/search-results","descriptorUrl":"/site/website/search-results.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"style","url":"/site/website/style","descriptorUrl":"/site/website/style.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"technology","url":"/site/website/technology","descriptorUrl":"/site/website/technology.meta.xml","descriptorDom":null,"properties":null,"folder":true}]}}},"404":{"$ref":"#/components/responses/NotFound","example":"No item found at /site/website/index.xml"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/content_store/tree.json":{"get":{"security":[],"tags":["content"],"summary":"Get Tree","operationId":"getTree","description":"Get the complete Item hierarchy under the specified folder in the content store.","parameters":[{"name":"url","in":"query","description":"The folder’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","description":"Amount of levels to include (unlimited by default)","required":false,"schema":{"type":"integer"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","required":false,"schema":{"type":"boolean"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStoreItems"}}}},"404":{"$ref":"#/components/responses/NotFound","example":"No folder found at /site/website/index.xml"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/get.json":{"get":{"security":[],"tags":["other"],"summary":"Get Profile","operationId":"getProfile","description":"Get the current user’s profile from the session, if no profile is set an empty one will be created. Only use it in conjunction with Studio’s Personas.","parameters":[{"name":"url","in":"query","description":"The folder’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"},"examples":{"userProfileExample":{"$ref":"#/components/examples/userProfileExample"}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/set.json":{"get":{"security":[],"tags":["other"],"summary":"Set Profile","operationId":"setProfile","description":"Set the current user’s profile, all parameters are added to the profile and stored in the session. Only use it in conjunction with Studio’s Personas. <br><br> <i>Note:</i> <br> <i>Any parameter included in the request will be added as a property for the user profile, if the request is made without any parameter then profile will be cleared.</i>","parameters":[{"name":"age","in":"query","description":"The user age","schema":{"type":"integer"}},{"name":"username","in":"query","description":"The user name","schema":{"type":"string"}},{"name":"lastname","in":"query","description":"The user last name","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","example":"john"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/navigation/breadcrumb.json":{"get":{"security":[],"tags":["navigation"],"summary":"Breadcrumb","operationId":"breadcrumb","description":"Returns the navigation items that form the breadcrumb for the specified store URL.","parameters":[{"name":"url","in":"query","required":true,"description":"The URL used to build the breadcrumb","schema":{"type":"string"}},{"name":"root","in":"query","description":"The starting point of the breadcrumb","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NavigationTreeNode"}},"example":[{"label":"Home","url":"/","active":false,"subItem":null},{"label":"Style","url":"/style","active":false,"subItem":null}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/navigation/tree.json":{"get":{"security":[],"tags":["navigation"],"summary":"Tree","operationId":"tree","description":"Returns the navigation tree with the specified depth for the specified store URL.","parameters":[{"name":"url","in":"query","required":true,"description":"The root folder of the tree","schema":{"type":"string"},"example":"/site/website"},{"name":"depth","in":"query","description":"The depth of the tree (defaults to 1)","schema":{"type":"integer"},"example":2},{"name":"currentPageUrl","in":"query","description":"The URL of the current page","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NavigationTreeNode"},"example":{"label":"Home","url":"/","active":false,"subItem":[{"label":"Style","url":"/style","active":false,"subItem":[]},{"label":"Health","url":"/health","active":false,"subItem":[]},{"label":"Entertainment","url":"/entertainment","active":false,"subItem":[]},{"label":"Technology","url":"/technology","active":false,"subItem":[]}]}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/url/transform.json":{"get":{"security":[],"tags":["navigation"],"summary":"Transform","operationId":"transform","description":"Transforms a URL, based on the current site’s configuration.","parameters":[{"name":"url","in":"query","required":true,"description":"The URL to be transformed","schema":{"type":"string"},"example":"/site/website/style/index.xml"},{"name":"transformerName","in":"query","required":true,"description":"The name of the transformer to apply","schema":{"type":"string"},"example":"storeUrlToRenderUrl"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"/style"}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/search/search.json":{"post":{"security":[],"tags":["search"],"summary":"Search","operationId":"search","description":"Performs a search operation in the OpenSearch index of the current site resolved for the request and optional other indexes. See <a class=\"reference external\" href=\"https://craftercms.com/docs/current/reference/api/search.html#search-multi-index-query\" rel=\"noopener noreferrer\" target=\"_blank\">Multi-index Query</a> for more information on performing a multiple index search. <br><br> <i>Note:</i> <br> <i>The request body must be a valid OpenSearch JSON query as described in the</i> <a class=\"reference external\" href=\"https://opensearch.org/docs/latest/api-reference/search/\" rel=\"noopener noreferrer\" target=\"_blank\">official docs</a>","parameters":[{"name":"index","in":"query","description":"Comma separated list of index names to be searched in addition to the current site","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"requestBody":{"description":"User entity to create","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"_source":{"type":"string","example":"localId"},"size":{"type":"integer","example":1},"query":{"type":"object","example":{"match_all":{}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"example":{"took":41,"timed_out":false,"_shards":{"total":5,"successful":5,"skipped":0,"failed":0},"hits":{"total":28,"max_score":1,"hits":[{"_index":"editorial-preview_v1","_type":"_doc","_id":"f4a1af43fed0b4e246abb3a8c7d7323d","_score":1,"_source":{"localId":"/site/components/articles-widget/latest-articles-widget.xml"}}]}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/graphql.json":{"get":{"security":[],"tags":["content"],"summary":"Query (GET)","operationId":"query","description":"Performs a query in the GraphQL instance of the current site resolved for the request. <br><br> <i>Note:</i> <br> <i>The query string must be a valid GraphQL query as described in the</i> <a class=\"reference external\" href=\"https://graphql.org/learn/queries/\" rel=\"noopener noreferrer\" target=\"_blank\">official docs</a>","parameters":[{"name":"query","in":"query","required":true,"description":"The GraphQL query","schema":{"type":"string"},"example":"{page_article{items{title_t}}}"},{"name":"operationName","in":"query","description":"The GraphQL operation name","schema":{"type":"string"}},{"name":"variables","in":"query","description":"A JSON object containing variables for the query","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"example":{"data":{"page_article":{"items":[{"title_t":"New ACME Phone Released Today"},{"title_t":"Top Clubs In Virginia"},{"title_t":"Coffee is Good for Your Health"},{"title_t":"5 Popular Diets for Women"},{"title_t":"Top Romantic Valentine Movies"},{"title_t":"10 Tips to Get a Six Pack"},{"title_t":"Women Styles for Winter"},{"title_t":"Men Styles For Winter"},{"title_t":"Top Books For Young Women"}]}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"security":[],"tags":["content"],"summary":"Query (POST)","operationId":"queryPost","description":"Performs a query in the GraphQL instance of the current site resolved for the request. <br><br> <i>Note:</i> <br> <i>The query string must be a valid GraphQL query as described in the</i> <a class=\"reference external\" href=\"https://graphql.org/learn/queries/\" rel=\"noopener noreferrer\" target=\"_blank\">official docs</a>","parameters":[{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"requestBody":{"description":"Search Parameters","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"description":"The GraphQL query","type":"string","example":"query ArticlesByAuthor($author:String) { page_article { total items { title_t author_s(filter:{equals:$author}) date_dt } } }"},"variables":{"description":"A JSON object containing variables for the query","type":"object","example":{"author":"Jane Doe"}},"operationName":{"description":"Name you give to your query <br><br> <i>Required when there are multiple operations in the document (query)</i>","type":"string","example":"ArticlesByAuthor"}},"required":["query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"example":{"data":{"page_article":{"total":4,"items":[{"title_t":"Women Styles for Winter","author_s":"Jane Doe","date_dt":"2021-01-03T05:00:00Z"},{"title_t":"Top Books For Young Women","author_s":"Jane Doe","date_dt":"2020-12-28T05:00:00Z"},{"title_t":"5 Popular Diets for Women","author_s":"Jane Doe","date_dt":"2021-03-14T04:00:00Z"},{"title_t":"Top Romantic Valentine Movies","author_s":"Jane Doe","date_dt":"2021-02-14T05:00:00Z"}]}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/config/preview.json":{"get":{"security":[],"tags":["other"],"summary":"Preview","operationId":"preview","description":"Indicates if Engine is configured in preview mode.","parameters":[{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"preview":{"type":"boolean","example":true}}}}}}}}},"/api/1/monitoring/memory.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Memory Stats","operationId":"memory","description":"Returns the Crafter Engine JVM memory details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","example":2017984512},"freeJvmMemory":{"type":"integer","example":1113921056},"maxJvmMemory":{"type":"integer","example":3817865216},"totalOsMemory":{"type":"integer","example":17179869184},"freeOsMemory":{"type":"integer","example":2669301760},"totalSwapMemory":{"type":"integer","example":2147483648},"freeSwapMemory":{"type":"integer","example":1026555904}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/status.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Status","operationId":"status","description":"Returns the Crafter Engine JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uptime":{"type":"integer","example":2017984512},"startup":{"type":"string","example":"2019-03-07T21:29:11.049Z"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/version.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Version","operationId":"version","description":"Returns the Crafter Engine JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"packageName":{"type":"string","example":"Crafter Engine"},"packageVersion":{"type":"string","example":"4.0.3-SNAPSHOT"},"packageBuild":{"type":"string","example":"48d29a56c6011f2908fb160f7648f66785d44b81"},"packageBuildDate":{"type":"string","example":"2023-03-08T21:53:22.558Z"},"osName":{"type":"string","example":"Mac OS X"},"osVersion":{"type":"string","example":"11.2"},"osArch":{"type":"string","example":"x86_64"},"javaVersion":{"type":"string","example":"11"},"javaVendor":{"type":"string","example":"Oracle Corporation"},"javaVm":{"type":"string","example":"OpenJDK 64-Bit Server VM"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/log.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Log Events","operationId":"log","description":"Returns all events recorded in the Crafter Engine log for a given site in a specific time period.","parameters":[{"name":"site","in":"query","description":"The name of the site","required":true,"schema":{"type":"string"},"example":"my-editorial"},{"name":"since","in":"query","description":"The time in milliseconds from which events should be fetched","required":true,"schema":{"type":"integer"},"example":1396772083660},{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"exception":{"type":"string"},"site":{"type":"string"},"level":{"type":"string"},"thread":{"type":"string"},"message":{"type":"string"},"timestampm":{"type":"integer"},"timestaamp":{"type":"string"}}},"example":[{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"--------------------------------------------------","timestampm":1678683085456,"timestamp":"2023-03-13T04:51:25.456+0000"},{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"<Initializing context site: editorial>","timestampm":1678683085477,"timestamp":"2023-03-13T04:51:25.477+0000"},{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"--------------------------------------------------","timestampm":1678683085498,"timestamp":"2023-03-13T04:51:25.498+0000"},{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"Starting GraphQL schema build for site 'editorial'","timestampm":1678683085499,"timestamp":"2023-03-13T04:51:25.499+0000"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/crafter-controller/component.json":{"get":{"security":[],"tags":["other"],"summary":"Get Component","operationId":"getComponent","description":"Get a component.","parameters":[{"name":"path","in":"query","description":"Path to the component <br> (e.g. /site/components/headers/header.xml)","required":true,"schema":{"type":"string"},"example":"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"<!-- Feature Component -->\\n <article class=\"feature\" data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" >  <span class=\"icon fa-smile far\" data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"icon_s\" ></span> <div class=\"content\"> <h3 data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"title_t\" >      Smile </h3> <div data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"body_html\" >      <p>Smile, aenean ornare velit lacus, ac varius enim lorem ullamcorper dolore. Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p> </div> </div> </article> <!-- /Feature Component -->"}}}}}}},"components":{"schemas":{"Statistics":{"type":"object","properties":{"size":{"type":"integer"},"localHeapSize":{"type":"integer"},"localOffHeapSize":{"type":"integer"},"localDiskSize":{"type":"integer"},"cacheHitRatio":{"type":"integer"},"cacheHitCount":{"type":"integer"},"cacheMissCount":{"type":"integer"},"cacheMissExpiredCount":{"type":"integer"},"cacheMissNotFoundCount":{"type":"integer"}},"example":{"size":17,"localHeapSize":17,"localOffHeapSize":0,"localDiskSize":0,"cacheHitRatio":1,"cacheHitCount":4,"cacheMissCount":25,"cacheMissExpiredCount":0,"cacheMissNotFoundCount":25}},"ContentStoreItems":{"type":"object","properties":{"name":{"description":"Name of item being retrieved (e.g. index.xml)","type":"string"},"url":{"description":"The item’s URL (e.g. /site/website/index.xml)","type":"string"},"descriptorUrl":{"description":"The item’s descriptor URL (e.g. for a folder: /site/website.meta.xml, for a page: /site/website/index.xml)","type":"string"},"descriptorDom":{"description":"Contains the content of item being retrieved (DOM of xml)","type":"object","nullable":true},"properties":{"description":"Contains additional properties that are generated by an ItemProcessor","type":"string","nullable":true},"folder":{"description":"Indicates whether the item is a folder (true or false)","type":"boolean"}}},"UserProfile":{"type":"object","properties":{"age":{"type":"integer"},"username":{"type":"string"},"lastname":{"type":"string"}}},"NavigationTreeNode":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"subItems":{"type":"object"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"No item found at /site/website/index.xml"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Required String parameter 'token' is not present"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Management authorization failed, invalid token."}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}}},"examples":{"userProfileExample":{"value":{"age":30,"username":"john","lastname":"doe"}}}}}},"searchIndex":{"store":["tag/content","tag/content/operation/getItem","tag/content/operation/getChildren","tag/content/operation/getTree","tag/content/operation/query","tag/content/operation/queryPost","tag/navigation","tag/navigation/operation/breadcrumb","tag/navigation/operation/tree","tag/navigation/operation/transform","tag/search","tag/search/operation/search","tag/cache","tag/cache/operation/cacheClear","tag/cache/operation/cacheStatistics","tag/context","tag/context/operation/getSiteContextID","tag/context/operation/getSiteContextStatus","tag/context/operation/destroySiteContext","tag/context/operation/rebuildSiteContext","tag/context/operation/rebuildAllSiteContexts","tag/context/operation/rebuildGraphQLSchema","tag/context/operation/mappingsReload","tag/monitoring","tag/monitoring/operation/memory","tag/monitoring/operation/status","tag/monitoring/operation/version","tag/monitoring/operation/log","tag/other","tag/other/operation/listJobs","tag/other/operation/getProfile","tag/other/operation/setProfile","tag/other/operation/preview","tag/other/operation/getComponent"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.805]],["description/0",[0,2.233,1,4.566,2,2.052]],["title/1",[3,2.169]],["description/1",[0,1.422,3,1.709,4,0.984,5,0.984,6,2.908,7,1.554,8,1.84,9,1.345,10,2.126,11,1.112,12,1.84,13,1.84,14,1.198,15,1.84,16,1.84,17,1.84,18,1.542,19,1.84,20,1.84,21,1.542,22,0.9,23,0.827,24,1.198,25,1.198,26,1.84,27,1.84,28,1.84,29,1.84]],["title/2",[30,3.691]],["description/2",[0,1.803,3,2.165,4,1.97,10,2.694,31,2.694,32,3.686,33,3.088,34,3.686]],["title/3",[35,2.698]],["description/3",[0,1.736,3,2.085,4,1.897,10,2.594,33,2.973,36,3.549,37,3.549,38,2.594,39,3.549]],["title/4",[40,2.169]],["description/4",[5,1.137,40,2.323,41,1.555,42,2.12,43,1.782,44,0.55,45,0.395,46,0.881,47,0.881,48,1.25,49,1.25,50,1.385,51,1.782,52,1.555,53,1.555,54,1.555,55,1.555,56,1.555,57,1.782,58,1.555,59,1.555,60,1.555,61,1.555,62,1.782]],["title/5",[40,1.659,63,2.823]],["description/5",[5,1.137,40,2.323,41,1.555,42,2.12,43,1.782,44,0.55,45,0.395,46,0.881,47,0.881,48,1.25,49,1.25,50,1.385,51,1.782,52,1.555,53,1.555,54,1.555,55,1.555,56,1.555,57,1.782,58,1.555,59,1.555,60,1.555,61,1.555,62,1.782]],["title/6",[64,2.404]],["description/6",[2,2.052,64,2.974,65,4.566]],["title/7",[66,3.093]],["description/7",[3,2.085,4,1.897,11,1.357,14,2.311,38,2.594,64,2.311,66,2.973,67,3.549,68,3.549]],["title/8",[35,2.698]],["description/8",[4,1.897,11,1.357,14,2.311,35,2.594,38,3.431,64,2.311,69,3.549,70,3.549]],["title/9",[71,3.093]],["description/9",[14,2.497,44,0.991,71,3.212,72,3.212,73,3.834,74,2.497,75,3.834]],["title/10",[76,2.404]],["description/10",[2,2.155,76,3.123]],["title/11",[76,2.404]],["description/11",[2,0.682,5,0.812,40,0.892,41,1.821,44,0.393,45,0.282,46,0.629,47,1.031,48,0.892,49,0.892,50,0.989,52,1.11,53,1.11,54,1.11,55,1.821,56,1.821,58,1.821,59,1.821,60,1.11,61,1.11,76,1.622,77,2.491,78,3.168,79,1.519,80,1.519,81,1.519,82,1.519,83,1.519,84,1.519,85,1.519,86,1.519,87,1.519,88,1.519,89,1.519,90,1.519]],["title/12",[91,1.973]],["description/12",[2,2.155,91,2.563]],["title/13",[0,1.118,91,1.222,92,1.671]],["description/13",[0,1.673,44,0.885,45,0.635,91,2.449,92,2.501,93,2.867,94,3.422,95,0.885,96,3.422]],["title/14",[97,3.093]],["description/14",[5,0.93,11,0.665,21,1.458,22,0.851,23,0.782,24,1.133,25,1.133,44,0.45,45,0.323,48,1.022,49,1.022,50,1.133,72,1.458,74,1.811,91,1.857,93,1.458,95,0.45,97,2.33,98,2.781,99,1.74,100,1.74,101,1.74,102,1.74,103,1.74,104,1.458,105,1.74,106,1.74,107,1.272,108,1.272,109,1.74,110,1.74,111,1.74]],["title/15",[95,0.954]],["description/15",[2,2.052,95,1.181,112,4.566]],["title/16",[45,0.424,95,0.591,113,1.915]],["description/16",[7,1.652,11,1.181,44,0.799,45,0.574,46,1.279,47,1.279,95,0.799,107,2.259,108,2.259,113,2.589,114,2.589,115,2.589,116,3.09]],["title/17",[45,0.424,95,0.591,117,1.343]],["description/17",[7,1.652,11,1.181,44,0.799,45,0.574,46,1.279,47,1.279,95,0.799,107,2.259,108,2.259,114,2.589,115,2.589,117,1.815,118,3.09]],["title/18",[45,0.424,95,0.591,119,1.671]],["description/18",[44,0.619,45,0.789,46,0.991,47,0.991,74,1.559,91,1.279,92,1.75,95,0.92,119,3.437,120,2.393,121,2.393,122,2.393,123,2.393,124,2.393,125,2.393,126,2.393]],["title/19",[45,0.424,95,0.591,127,1.222]],["description/19",[44,0.826,45,0.593,46,1.322,47,1.322,95,1.13,119,2.334,127,1.707,128,3.193,129,2.675,130,3.193,131,3.193]],["title/20",[45,0.424,95,0.591,127,1.222]],["description/20",[44,0.991,45,0.712,95,0.991,127,2.049,132,3.834,133,3.834,134,3.834]],["title/21",[42,1.488,127,1.222,135,1.915]],["description/21",[42,2.311,44,0.918,45,0.659,46,1.469,47,1.469,95,0.918,127,1.897,135,2.973,136,3.549]],["title/22",[137,2.365,138,2.365]],["description/22",[7,1.551,22,2.001,23,1.838,25,1.89,45,0.539,46,1.202,137,2.432,138,3.428,139,2.902,140,2.902,141,2.902,142,2.902]],["title/23",[143,3.093]],["description/23",[2,2.155,143,4.018]],["title/24",[144,2.365,145,2.823]],["description/24",[11,1.465,22,1.875,23,1.723,144,3.212,146,2.802,147,2.802,148,3.834]],["title/25",[117,2.169]],["description/25",[11,1.465,22,1.875,23,1.723,117,2.252,146,2.802,147,2.802,149,3.834]],["title/26",[150,3.691]],["description/26",[11,1.465,22,1.875,23,1.723,117,2.252,146,2.802,147,2.802,151,3.834]],["title/27",[152,2.365,153,2.365]],["description/27",[11,1.221,22,1.562,23,1.435,45,0.593,152,2.675,153,2.675,154,3.193,155,3.193,156,3.193,157,3.193,158,3.193,159,3.193]],["title/28",[]],["description/28",[2,2.155,160,4.796]],["title/29",[31,2.064,161,2.365]],["description/29",[31,2.92,44,1.033,45,0.742,161,3.346,162,3.994,163,3.994]],["title/30",[164,2.404]],["description/30",[7,1.6,44,0.774,104,2.508,129,2.508,164,2.723,165,2.508,166,2.508,167,2.188,168,2.993,169,2.508,170,2.508,171,2.508,172,2.993]],["title/31",[164,1.838,167,2.064]],["description/31",[4,1.044,5,1.044,7,1.044,18,1.636,44,0.505,47,1.262,48,1.148,49,1.148,164,2.757,165,1.636,166,1.636,167,1.428,169,1.636,170,1.636,171,1.636,173,3.747,174,3.047,175,1.953,176,1.953,177,1.953,178,1.953,179,1.953,180,1.953,181,1.953]],["title/32",[24,2.404]],["description/32",[23,1.795,24,2.601,25,2.601,74,2.601,182,3.994,183,3.994]],["title/33",[9,2.698]],["description/33",[9,3.506,184,4.796]]],"invertedIndex":[["ad",{"_index":174,"title":{},"description":{"31":{}}}],["again",{"_index":130,"title":{},"description":{"19":{}}}],["alway",{"_index":103,"title":{},"description":{"14":{}}}],["api",{"_index":6,"title":{},"description":{"1":{}}}],["api/1/config/preview.json",{"_index":183,"title":{},"description":{"32":{}}}],["api/1/monitoring/log.json",{"_index":159,"title":{},"description":{"27":{}}}],["api/1/monitoring/memory.json",{"_index":148,"title":{},"description":{"24":{}}}],["api/1/monitoring/status.json",{"_index":149,"title":{},"description":{"25":{}}}],["api/1/monitoring/version.json",{"_index":151,"title":{},"description":{"26":{}}}],["api/1/profile/get.json",{"_index":172,"title":{},"description":{"30":{}}}],["api/1/profile/set.json",{"_index":181,"title":{},"description":{"31":{}}}],["api/1/site/cache/clear.json",{"_index":96,"title":{},"description":{"13":{}}}],["api/1/site/cache/statistics.json",{"_index":111,"title":{},"description":{"14":{}}}],["api/1/site/content_store/children.json",{"_index":34,"title":{},"description":{"2":{}}}],["api/1/site/content_store/item.json",{"_index":29,"title":{},"description":{"1":{}}}],["api/1/site/content_store/tree.json",{"_index":39,"title":{},"description":{"3":{}}}],["api/1/site/context/destroy.json",{"_index":126,"title":{},"description":{"18":{}}}],["api/1/site/context/graphql/rebuild.json",{"_index":136,"title":{},"description":{"21":{}}}],["api/1/site/context/id.json",{"_index":116,"title":{},"description":{"16":{}}}],["api/1/site/context/rebuild.json",{"_index":131,"title":{},"description":{"19":{}}}],["api/1/site/context/rebuild_all.json",{"_index":134,"title":{},"description":{"20":{}}}],["api/1/site/context/status.json",{"_index":118,"title":{},"description":{"17":{}}}],["api/1/site/graphql.json",{"_index":62,"title":{},"description":{"4":{},"5":{}}}],["api/1/site/jobs/list.json",{"_index":163,"title":{},"description":{"29":{}}}],["api/1/site/mappings/reload.json",{"_index":142,"title":{},"description":{"22":{}}}],["api/1/site/navigation/breadcrumb.json",{"_index":68,"title":{},"description":{"7":{}}}],["api/1/site/navigation/tree.json",{"_index":70,"title":{},"description":{"8":{}}}],["api/1/site/search/search.json",{"_index":90,"title":{},"description":{"11":{}}}],["api/1/site/url/transform.json",{"_index":75,"title":{},"description":{"9":{}}}],["author",{"_index":27,"title":{},"description":{"1":{}}}],["avail",{"_index":140,"title":{},"description":{"22":{}}}],["base",{"_index":72,"title":{},"description":{"9":{},"14":{}}}],["be",{"_index":109,"title":{},"description":{"14":{}}}],["bean",{"_index":123,"title":{},"description":{"18":{}}}],["bodi",{"_index":87,"title":{},"description":{"11":{}}}],["br",{"_index":5,"title":{},"description":{"1":{},"4":{},"5":{},"11":{},"14":{},"31":{}}}],["br><br",{"_index":48,"title":{},"description":{"4":{},"5":{},"11":{},"14":{},"31":{}}}],["br><br><i",{"_index":19,"title":{},"description":{"1":{}}}],["breadcrumb",{"_index":66,"title":{"7":{}},"description":{"7":{}}}],["cach",{"_index":91,"title":{"12":{},"13":{}},"description":{"12":{},"13":{},"14":{},"18":{}}}],["call",{"_index":99,"title":{},"description":{"14":{}}}],["cases.</i",{"_index":28,"title":{},"description":{"1":{}}}],["chang",{"_index":100,"title":{},"description":{"14":{}}}],["children",{"_index":30,"title":{"2":{}},"description":{}}],["class=\"refer",{"_index":55,"title":{},"description":{"4":{},"5":{},"11":{}}}],["classload",{"_index":125,"title":{},"description":{"18":{}}}],["clear",{"_index":92,"title":{"13":{}},"description":{"13":{},"18":{}}}],["cleared.</i",{"_index":180,"title":{},"description":{"31":{}}}],["complet",{"_index":36,"title":{},"description":{"3":{}}}],["compon",{"_index":9,"title":{"33":{}},"description":{"1":{},"33":{}}}],["configur",{"_index":74,"title":{},"description":{"9":{},"14":{},"18":{},"32":{}}}],["conjunct",{"_index":169,"title":{},"description":{"30":{},"31":{}}}],["content",{"_index":0,"title":{"0":{},"13":{}},"description":{"0":{},"1":{},"2":{},"3":{},"13":{}}}],["context",{"_index":95,"title":{"15":{},"16":{},"17":{},"18":{},"19":{},"20":{}},"description":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{}}}],["crafter",{"_index":22,"title":{},"description":{"1":{},"14":{},"22":{},"24":{},"25":{},"26":{},"27":{}}}],["crafter-controller/component.json",{"_index":184,"title":{},"description":{"33":{}}}],["creat",{"_index":129,"title":{},"description":{"19":{},"30":{}}}],["current",{"_index":44,"title":{},"description":{"4":{},"5":{},"9":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"29":{},"30":{},"31":{}}}],["depend",{"_index":107,"title":{},"description":{"14":{},"16":{},"17":{}}}],["depth",{"_index":69,"title":{},"description":{"8":{}}}],["describ",{"_index":53,"title":{},"description":{"4":{},"5":{},"11":{}}}],["descriptorurl",{"_index":15,"title":{},"description":{"1":{}}}],["destroy",{"_index":119,"title":{"18":{}},"description":{"18":{},"19":{}}}],["detail",{"_index":147,"title":{},"description":{"24":{},"25":{},"26":{}}}],["differ",{"_index":106,"title":{},"description":{"14":{}}}],["directli",{"_index":32,"title":{},"description":{"2":{}}}],["disabl",{"_index":21,"title":{},"description":{"1":{},"14":{}}}],["docs</a",{"_index":61,"title":{},"description":{"4":{},"5":{},"11":{}}}],["empti",{"_index":104,"title":{},"description":{"14":{},"30":{}}}],["endpoint",{"_index":139,"title":{},"description":{"22":{}}}],["engin",{"_index":23,"title":{},"description":{"1":{},"14":{},"22":{},"24":{},"25":{},"26":{},"27":{},"32":{}}}],["event",{"_index":153,"title":{"27":{}},"description":{"27":{}}}],["exampl",{"_index":102,"title":{},"description":{"14":{}}}],["extern",{"_index":56,"title":{},"description":{"4":{},"5":{},"11":{}}}],["extra",{"_index":17,"title":{},"description":{"1":{}}}],["flag",{"_index":16,"title":{},"description":{"1":{}}}],["folder",{"_index":10,"title":{},"description":{"1":{},"2":{},"3":{}}}],["form",{"_index":67,"title":{},"description":{"7":{}}}],["found",{"_index":132,"title":{},"description":{"20":{}}}],["freemark",{"_index":94,"title":{},"description":{"13":{}}}],["given",{"_index":155,"title":{},"description":{"27":{}}}],["graphql",{"_index":42,"title":{"21":{}},"description":{"4":{},"5":{},"21":{}}}],["groovi",{"_index":124,"title":{},"description":{"18":{}}}],["hierarchi",{"_index":37,"title":{},"description":{"3":{}}}],["href=\"https://craftercms.com/docs/current/reference/api/search.html#search-multi-index-queri",{"_index":81,"title":{},"description":{"11":{}}}],["href=\"https://graphql.org/learn/queri",{"_index":57,"title":{},"description":{"4":{},"5":{}}}],["href=\"https://opensearch.org/docs/latest/api-reference/search",{"_index":89,"title":{},"description":{"11":{}}}],["i>ani",{"_index":175,"title":{},"description":{"31":{}}}],["i>note:</i",{"_index":49,"title":{},"description":{"4":{},"5":{},"11":{},"14":{},"31":{}}}],["i>th",{"_index":50,"title":{},"description":{"4":{},"5":{},"11":{},"14":{}}}],["id",{"_index":113,"title":{"16":{}},"description":{"16":{}}}],["implement",{"_index":108,"title":{},"description":{"14":{},"16":{},"17":{}}}],["includ",{"_index":176,"title":{},"description":{"31":{}}}],["index",{"_index":78,"title":{},"description":{"11":{}}}],["indic",{"_index":182,"title":{},"description":{"32":{}}}],["inform",{"_index":85,"title":{},"description":{"11":{}}}],["instanc",{"_index":43,"title":{},"description":{"4":{},"5":{}}}],["involv",{"_index":120,"title":{},"description":{"18":{}}}],["item",{"_index":3,"title":{"1":{}},"description":{"1":{},"2":{},"3":{},"7":{}}}],["job",{"_index":161,"title":{"29":{}},"description":{"29":{}}}],["json",{"_index":88,"title":{},"description":{"11":{}}}],["jvm",{"_index":146,"title":{},"description":{"24":{},"25":{},"26":{}}}],["list",{"_index":31,"title":{"29":{}},"description":{"2":{},"29":{}}}],["load",{"_index":121,"title":{},"description":{"18":{}}}],["log",{"_index":152,"title":{"27":{}},"description":{"27":{}}}],["made",{"_index":178,"title":{},"description":{"31":{}}}],["map",{"_index":138,"title":{"22":{}},"description":{"22":{}}}],["mean",{"_index":128,"title":{},"description":{"19":{}}}],["memori",{"_index":144,"title":{"24":{}},"description":{"24":{}}}],["metadata",{"_index":12,"title":{},"description":{"1":{}}}],["miscellan",{"_index":160,"title":{},"description":{"28":{}}}],["mode",{"_index":25,"title":{},"description":{"1":{},"14":{},"22":{},"32":{}}}],["monitor",{"_index":143,"title":{"23":{}},"description":{"23":{}}}],["more",{"_index":84,"title":{},"description":{"11":{}}}],["multi-ten",{"_index":141,"title":{},"description":{"22":{}}}],["multipl",{"_index":86,"title":{},"description":{"11":{}}}],["navig",{"_index":64,"title":{"6":{}},"description":{"6":{},"7":{},"8":{}}}],["noreferr",{"_index":59,"title":{},"description":{"4":{},"5":{},"11":{}}}],["note",{"_index":20,"title":{},"description":{"1":{}}}],["object",{"_index":105,"title":{},"description":{"14":{}}}],["on",{"_index":168,"title":{},"description":{"30":{}}}],["opensearch",{"_index":77,"title":{},"description":{"11":{}}}],["oper",{"_index":2,"title":{},"description":{"0":{},"6":{},"10":{},"11":{},"12":{},"15":{},"23":{},"28":{}}}],["option",{"_index":79,"title":{},"description":{"11":{}}}],["page",{"_index":8,"title":{},"description":{"1":{}}}],["paramet",{"_index":173,"title":{},"description":{"31":{}}}],["perform",{"_index":41,"title":{},"description":{"4":{},"5":{},"11":{}}}],["period",{"_index":158,"title":{},"description":{"27":{}}}],["persona",{"_index":171,"title":{},"description":{"30":{},"31":{}}}],["post",{"_index":63,"title":{"5":{}},"description":{}}],["preview",{"_index":24,"title":{"32":{}},"description":{"1":{},"14":{},"32":{}}}],["profil",{"_index":164,"title":{"30":{},"31":{}},"description":{"30":{},"31":{}}}],["project/sit",{"_index":112,"title":{},"description":{"15":{}}}],["properti",{"_index":18,"title":{},"description":{"1":{},"31":{}}}],["queri",{"_index":40,"title":{"4":{},"5":{}},"description":{"4":{},"5":{},"11":{}}}],["query</a",{"_index":83,"title":{},"description":{"11":{}}}],["rebuild",{"_index":127,"title":{"19":{},"20":{},"21":{}},"description":{"19":{},"20":{},"21":{}}}],["record",{"_index":154,"title":{},"description":{"27":{}}}],["registri",{"_index":133,"title":{},"description":{"20":{}}}],["rel=\"noopen",{"_index":58,"title":{},"description":{"4":{},"5":{},"11":{}}}],["reload",{"_index":137,"title":{"22":{}},"description":{"22":{}}}],["request",{"_index":47,"title":{},"description":{"4":{},"5":{},"11":{},"16":{},"17":{},"18":{},"19":{},"21":{},"31":{}}}],["resolv",{"_index":46,"title":{},"description":{"4":{},"5":{},"11":{},"16":{},"17":{},"18":{},"19":{},"21":{},"22":{}}}],["result",{"_index":98,"title":{},"description":{"14":{}}}],["retriev",{"_index":1,"title":{},"description":{"0":{}}}],["return",{"_index":11,"title":{},"description":{"1":{},"7":{},"8":{},"14":{},"16":{},"17":{},"24":{},"25":{},"26":{},"27":{}}}],["schedul",{"_index":162,"title":{},"description":{"29":{}}}],["schema",{"_index":135,"title":{"21":{}},"description":{"21":{}}}],["scope",{"_index":93,"title":{},"description":{"13":{},"14":{}}}],["search",{"_index":76,"title":{"10":{},"11":{}},"description":{"10":{},"11":{}}}],["see",{"_index":80,"title":{},"description":{"11":{}}}],["session",{"_index":166,"title":{},"description":{"30":{},"31":{}}}],["set",{"_index":167,"title":{"31":{}},"description":{"30":{},"31":{}}}],["site",{"_index":45,"title":{"16":{},"17":{},"18":{},"19":{},"20":{}},"description":{"4":{},"5":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"27":{},"29":{}}}],["siteresolv",{"_index":115,"title":{},"description":{"16":{},"17":{}}}],["site’",{"_index":73,"title":{},"description":{"9":{}}}],["specif",{"_index":156,"title":{},"description":{"27":{}}}],["specifi",{"_index":38,"title":{},"description":{"3":{},"7":{},"8":{}}}],["spring",{"_index":122,"title":{},"description":{"18":{}}}],["stat",{"_index":145,"title":{"24":{}},"description":{}}],["statist",{"_index":97,"title":{"14":{}},"description":{"14":{}}}],["statu",{"_index":117,"title":{"17":{},"25":{}},"description":{"17":{},"25":{},"26":{}}}],["store",{"_index":4,"title":{},"description":{"1":{},"2":{},"3":{},"7":{},"8":{},"31":{}}}],["string",{"_index":51,"title":{},"description":{"4":{},"5":{}}}],["structur",{"_index":65,"title":{},"description":{"6":{}}}],["studio’",{"_index":170,"title":{},"description":{"30":{},"31":{}}}],["such",{"_index":13,"title":{},"description":{"1":{}}}],["support",{"_index":26,"title":{},"description":{"1":{}}}],["system",{"_index":101,"title":{},"description":{"14":{}}}],["target=\"_blank\">multi-index",{"_index":82,"title":{},"description":{"11":{}}}],["target=\"_blank\">offici",{"_index":60,"title":{},"description":{"4":{},"5":{},"11":{}}}],["the</i",{"_index":54,"title":{},"description":{"4":{},"5":{},"11":{}}}],["time",{"_index":157,"title":{},"description":{"27":{}}}],["transform",{"_index":71,"title":{"9":{}},"description":{"9":{}}}],["tree",{"_index":35,"title":{"3":{},"8":{}},"description":{"8":{}}}],["under",{"_index":33,"title":{},"description":{"2":{},"3":{}}}],["url",{"_index":14,"title":{},"description":{"1":{},"7":{},"8":{},"9":{}}}],["us",{"_index":7,"title":{},"description":{"1":{},"16":{},"17":{},"22":{},"30":{},"31":{}}}],["used.</i",{"_index":110,"title":{},"description":{"14":{}}}],["user",{"_index":177,"title":{},"description":{"31":{}}}],["user’",{"_index":165,"title":{},"description":{"30":{},"31":{}}}],["valid",{"_index":52,"title":{},"description":{"4":{},"5":{},"11":{}}}],["valu",{"_index":114,"title":{},"description":{"16":{},"17":{}}}],["version",{"_index":150,"title":{"26":{}},"description":{}}],["without",{"_index":179,"title":{},"description":{"31":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080"}],"info":{"description":"Crafter Engine API","version":"4.5.0","title":"Crafter Engine","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Engine","url":"https://craftercms.com/docs/current/reference/modules/engine.html"},"tags":[{"name":"content","description":"Content retrieval operations"},{"name":"navigation","description":"Navigation and structure operations"},{"name":"search","description":"Search operations"},{"name":"cache","description":"Cache operations"},{"name":"context","description":"Project/site context operations"},{"name":"monitoring","description":"Monitoring operations"},{"name":"other","description":"Other miscellaneous operations"}],"paths":{"/api/1/site/context/id.json":{"get":{"security":[],"tags":["context"],"summary":"Get the ID for the site context","operationId":"getSiteContextID","description":"Get the ID for the site context resolved for the current request, the value returned will depend on the SiteResolver implementation used.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The site context Id","example":"405ffc233d075b010536bd2eb786b86c"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/status.json":{"get":{"security":[],"tags":["context"],"summary":"Get the site context status","operationId":"getSiteContextStatus","description":"Get the status for the site context resolved for the current request, the value returned will depend on the SiteResolver implementation used.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The site context status","example":"READY"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/destroy.json":{"get":{"security":[],"tags":["context"],"summary":"Destroy the site context","operationId":"destroySiteContext","description":"Destroy the site context resolved for the current request. Destroying the context involves clearing the cache, destroying any loaded configuration and Spring beans for the site, and destroying the Groovy classloader for the site.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Site context successfully destroyed","example":"Site context for 'sample' destroyed. Will be recreated on next request"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/rebuild.json":{"get":{"security":[],"tags":["context"],"summary":"Rebuild the site context","operationId":"rebuildSiteContext","description":"Rebuild the site context resolved for the current request, which means destroying and then creating the context again.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Site context rebuild started","example":"Started rebuild for site context for 'sample'"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/rebuild_all.json":{"get":{"security":[],"tags":["context"],"summary":"Rebuild all site contexts","operationId":"rebuildAllSiteContexts","description":"Rebuild all site contexts currently found in the registry","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"All site contexts rebuild started","example":"Started rebuild of all site contexts"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/context/graphql/rebuild.json":{"get":{"security":[],"tags":["context"],"summary":"Rebuild GraphQL Schema","operationId":"rebuildGraphQLSchema","description":"Rebuild the GraphQL schema for the site context resolved for the current request.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"GraphQL schema rebuild started message","example":"Rebuild of GraphQL schema started for 'sample'"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/jobs/list.json":{"get":{"security":[],"tags":["other"],"summary":"List jobs","operationId":"listJobs","description":"Get a list of all scheduled jobs for the current site.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of job"},"nextFireTime":{"type":"string","description":"Time when job will be executed"}}},"example":[{"name":"editorial:/scripts/jobs/hourly/hourly-job.groovy","nextFireTime":"2022-05-08T00:00:00Z"},{"name":"editorial:/scripts/jobs/custom-job.groovy","nextFireTime":"2022-05-08T00:00:00Z"}]}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/mappings/reload.json":{"get":{"security":[],"tags":["context"],"summary":"Reload the mappings","operationId":"mappingsReload","description":"Reload the mappings used to resolve sites by Crafter Engine. This endpoint is only available when Crafter Engine is in mapped multi-tenant mode.","parameters":[{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Successful reloading of mappings message","example":"Mappings reloaded"}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The current resolver is not a ReloadableMappingsSiteResolver. No mappings to reload"}}}}}}}}},"/api/1/site/cache/clear.json":{"get":{"security":[],"tags":["cache"],"summary":"Clear content cache","operationId":"cacheClear","description":"Clear the content cache scope and the Freemarker cache for the current site context.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"},{"name":"cacheType","in":"query","description":"Type of cache.\n\nPossible values are:\n- <b>system</b> : Cache for objects cached by Engine itself.\n- <b>application</b> : Cache for objects cached by Groovy code.\n  This cache is enabled by specifying the value \"crafter_core_applicationCache\" in the <b>SPRING_PROFILES_ACTIVE</b> env variable.\n\nDefault is \"system\".","schema":{"type":"string"},"example":"system"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Cache clear for site 'sample' started"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/cache/statistics.json":{"get":{"security":[],"tags":["cache"],"summary":"Statistics","operationId":"cacheStatistics","description":"Get the statistics for all cache scopes for the current site context. <br><br> <i>Note:</i> <br> <i>The result of this call can change based on the configuration of the system, for example when Crafter Engine is configured in preview mode the cache will be disabled and the result will always be an empty object. There could be also different statistics returned depending on the cache implementation that is being used.</i>","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"},{"name":"cacheType","in":"query","description":"Type of cache.\n\nPossible values are:\n- <b>system</b> : Cache for objects cached by Engine itself.\n- <b>application</b> : Cache for objects cached by Groovy code.\n  This cache is enabled by specifying the value \"crafter_core_applicationCache\" in the <b>SPRING_PROFILES_ACTIVE</b> env variable.\n\nDefault is \"system\".","schema":{"type":"string"},"example":"system"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statistics"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/content_store/item.json":{"get":{"security":[],"tags":["content"],"summary":"Get Item","operationId":"getItem","description":"Get an Item from the content store. <br> This API is used to get pages, components and folders. It returns the content and other metadata such as url, descriptorUrl, folder flag, and extra properties <br><br><i> Note: This API also returns 'disabled' items when Crafter Engine is in preview mode to support authoring use cases.</i>","parameters":[{"name":"url","in":"query","description":"The item’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","required":false,"schema":{"type":"boolean"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStoreItems"},"examples":{"Folder":{"value":{"name":"website","url":"/site/website","descriptorUrl":"/site/website.meta.xml","descriptorDom":null,"properties":null,"folder":true}},"WithAdditionalProperties":{"value":{"name":"index.xml","url":"/site/website/index.xml","descriptorUrl":"/site/website.meta.xml","descriptorDom":{"page":{"content-type":"/page/home","display-template":"/templates/web/pages/home.ftl","merge-strategy":"inherit-levels","placeInNav":false,"file-name":"index.xml","objectGroupId":"8d7f","objectId":"8d7f21fa-5e09-00aa-8340-853b7db302da","folder-name":null,"header":{"item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":false}},"createdDate":"1/31/2022 16:18:14","createdDate_dt":"1/31/2022 16:18:14","lastModifiedDate":"5/18/2022 15:52:21","lastModifiedDate_dt":"5/18/2022 15:52:21","left-rail":{"item":{"key":"/site/components/left-rails/left-rail-with-latest-articles.xml","value":"Left Rail with Latest Articles","include":"/site/components/left-rails/left-rail-with-latest-articles.xml","disableFlattening":false}},"internal-name":"Home","orderDefault_f":-1,"title":"Editorial","hero_text":"<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>","hero_title":"<h1><span>Hi, I&rsquo;m Editorial</span></h1>\n<h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>","features":{"item":[{"value":"Quam lorem ipsum","key":"/site/components/features/quam-lorem-ipsum.xml","include":"/site/components/features/quam-lorem-ipsum.xml","disableFlattening":false},{"key":"/site/components/features/sapien-veroeros.xml","value":"Sapien Veroeros","include":"/site/components/features/sapien-veroeros.xml","disableFlattening":false}]},"hero_image":"/static-assets/images/strawberries.jpg","features_title":"Erat lacinia"}},"properties":"//page/merge-strategy: inherit-levels\n//page/content-type: /page/home\n","folder":false}},"WithoutAdditionalProperties":{"value":{"name":"index.xml","url":"/site/website/index.xml","descriptorUrl":"/site/website.meta.xml","descriptorDom":{"page":{"content-type":"/page/home","display-template":"/templates/web/pages/home.ftl","merge-strategy":"inherit-levels","placeInNav":false,"file-name":"index.xml","objectGroupId":"8d7f","objectId":"8d7f21fa-5e09-00aa-8340-853b7db302da","folder-name":null,"header":{"item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":false}},"createdDate":"1/31/2022 16:18:14","createdDate_dt":"1/31/2022 16:18:14","lastModifiedDate":"5/18/2022 15:52:21","lastModifiedDate_dt":"5/18/2022 15:52:21","left-rail":{"item":{"key":"/site/components/left-rails/left-rail-with-latest-articles.xml","value":"Left Rail with Latest Articles","include":"/site/components/left-rails/left-rail-with-latest-articles.xml","disableFlattening":false}},"internal-name":"Home","orderDefault_f":-1,"title":"Editorial","hero_text":"<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>","hero_title":"<h1><span>Hi, I&rsquo;m Editorial</span></h1>\n<h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>","features":{"item":[{"key":"/site/components/features/quam-lorem-ipsum.xml","value":"Quam lorem ipsum","include":"/site/components/features/quam-lorem-ipsum.xml","disableFlattening":false},{"key":"/site/components/features/sapien-veroeros.xml","value":"Sapien Veroeros","include":"/site/components/features/sapien-veroeros.xml","disableFlattening":false}]},"hero_image":"/static-assets/images/strawberries.jpg","features_title":"Erat lacinia"}},"properties":"null","folder":false}}}}}},"404":{"$ref":"#/components/responses/NotFound","example":"No item found at /site/website/index.xml"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/content_store/children.json":{"get":{"security":[],"tags":["content"],"summary":"Get Children","operationId":"getChildren","description":"Get the list of Items directly under a folder in the content store.","parameters":[{"name":"url","in":"query","description":"The folder’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","required":false,"schema":{"type":"boolean"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentStoreItems"}},"example":[{"name":"articles","url":"/site/website/articles","descriptorUrl":"/site/website/articles.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"crafter-level-descriptor.level.xml","url":"/site/website/crafter-level-descriptor.level.xml","descriptorUrl":"/site/website/crafter-level-descriptor.level.xml","descriptorDom":{"component":{"content-type":"/component/level-descriptor","display-template":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor"},"merge-strategy":"inherit-levels","file-name":"crafter-level-descriptor.level.xml","objectGroupId":"0a68","objectId":"0a68e8ad-77d8-0a58-e7bf-09a71fb3077b","folder-name":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor"},"header_o":{"item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":"false"}},"createdDate":"2017-03-13T20:26:50.000Z","createdDate_dt":"2017-03-13T20:26:50.000Z","lastModifiedDate":"2017-05-18T15:38:58.000Z","lastModifiedDate_dt":"2017-05-18T15:38:58.000Z","left_rail_o":{"item":{"key":"/site/components/left-rails/left-rail-with-no-articles.xml","value":"Left Rail with No Articles","include":"/site/components/left-rails/left-rail-with-no-articles.xml","disableFlattening":"false"}}}},"properties":null,"folder":false},{"name":"entertainment","url":"/site/website/entertainment","descriptorUrl":"/site/website/entertainment.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"health","url":"/site/website/health","descriptorUrl":"/site/website/health.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"index.xml","url":"/site/website/index.xml","descriptorUrl":"/site/website/index.xml","descriptorDom":{"page":{"content-type":"/page/home","display-template":"/templates/web/pages/home.ftl","merge-strategy":"inherit-levels","file-name":"index.xml","objectGroupId":"8d7f","objectId":"8d7f21fa-5e09-00aa-8340-853b7db302da","folder-name":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor"},"header_o":{"crafter-source":"/site/website/crafter-level-descriptor.level.xml","crafter-source-content-type-id":"/component/level-descriptor","item":{"key":"/site/components/headers/header.xml","value":"Header","include":"/site/components/headers/header.xml","disableFlattening":"false"}},"createdDate":"2017-01-31T16:18:14.000Z","createdDate_dt":"2017-01-31T16:18:14.000Z","lastModifiedDate":"2021-03-31T18:08:03.196Z","lastModifiedDate_dt":"2021-03-31T18:20:09.599Z","left_rail_o":{"item":[{"key":"/site/components/left-rails/left-rail-with-latest-articles.xml","value":"Left Rail with Latest Articles","include":"/site/components/left-rails/left-rail-with-latest-articles.xml","disableFlattening":"false"}]},"no-template-required":null,"internal-name":"Home","orderDefault_f":"-1","title_t":"Editorial","hero_text_html":"<p>Aenean ornare velit lacus, ac varius enim ullamcorper eu. Proin aliquam facilisis ante interdum congue. Integer mollis, nisl amet convallis, porttitor magna ullamcorper, amet egestas mauris. Ut magna finibus nisi nec lacinia. Nam maximus erat id euismod egestas. Pellentesque sapien ac quam. Lorem ipsum dolor sit nullam.</p>","hero_title_html":"<h1>Hi, I&rsquo;m Editorial</h1>\n    <h3><span style=\"font-size: 1.5em;\">by HTML5 UP</span></h3>","features_o":{"item":[{"datasource":"features","key":"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml","value":"Smile","include":"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml","disableFlattening":"false"},{"datasource":"features","inline":"true","key":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce","value":"Download","disableFlattening":"false","component":{"id":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce","content-type":"/component/feature","display-template":"/templates/web/components/feature.ftl","no-template-required":null,"merge-strategy":"inherit-levels","objectGroupId":"310b","objectId":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce","file-name":"310b0c87-c3ca-4da0-4aa2-7002a318d7ce.xml","internal-name":"Download","title_t":"Download","disabled":"false","icon_s":"fa-arrow-alt-circle-down far","body_html":"<p>Download ornare velit lacus, ac varius enim lorem ullamcorper dolore.\n          Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p>\n        ","createdDate":"2019-10-11T19:20:07.555Z","createdDate_dt":"2019-10-11T19:20:07.555Z","lastModifiedDate":"2019-12-22T11:56:51.172Z","lastModifiedDate_dt":"2019-12-22T11:56:51.172Z"}},{"datasource":"features","inline":"true","key":"a89386c4-a205-2681-2db1-c3606f714411","value":"Build","disableFlattening":"false","component":{"id":"a89386c4-a205-2681-2db1-c3606f714411","content-type":"/component/feature","display-template":"/templates/web/components/feature.ftl","no-template-required":null,"merge-strategy":"inherit-levels","objectGroupId":"a893","objectId":"a89386c4-a205-2681-2db1-c3606f714411","file-name":"a89386c4-a205-2681-2db1-c3606f714411.xml","internal-name":"Build","title_t":"Build","disabled":"false","icon_s":"fa-building far","body_html":"<p>Build enean ornare velit lacus, ac varius enim lorem ullamcorper dolore.\n          Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p>\n        ","createdDate":"2019-10-11T19:19:53.590Z","createdDate_dt":"2019-10-11T19:19:53.590Z","lastModifiedDate":"2019-12-22T11:56:34.603Z","lastModifiedDate_dt":"2019-12-22T11:56:34.603Z"}},{"datasource":"features","key":"/site/components/features/72ef047f-02b7-89e2-bbd5-4763ac7dbca8.xml","value":"Closed captioning","include":"/site/components/features/72ef047f-02b7-89e2-bbd5-4763ac7dbca8.xml","disableFlattening":"false"}]},"hero_image_s":"/static-assets/images/strawberries.jpg","features_title_t":"Erat lacinia","disabled":"false"}},"properties":null,"folder":false},{"name":"search-results","url":"/site/website/search-results","descriptorUrl":"/site/website/search-results.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"style","url":"/site/website/style","descriptorUrl":"/site/website/style.meta.xml","descriptorDom":null,"properties":null,"folder":true},{"name":"technology","url":"/site/website/technology","descriptorUrl":"/site/website/technology.meta.xml","descriptorDom":null,"properties":null,"folder":true}]}}},"404":{"$ref":"#/components/responses/NotFound","example":"No item found at /site/website/index.xml"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/content_store/tree.json":{"get":{"security":[],"tags":["content"],"summary":"Get Tree","operationId":"getTree","description":"Get the complete Item hierarchy under the specified folder in the content store.","parameters":[{"name":"url","in":"query","description":"The folder’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"depth","in":"query","description":"Amount of levels to include (unlimited by default)","required":false,"schema":{"type":"integer"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","required":false,"schema":{"type":"boolean"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentStoreItems"}}}},"404":{"$ref":"#/components/responses/NotFound","example":"No folder found at /site/website/index.xml"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/get.json":{"get":{"security":[],"tags":["other"],"summary":"Get Profile","operationId":"getProfile","description":"Get the current user’s profile from the session, if no profile is set an empty one will be created. Only use it in conjunction with Studio’s Personas.","parameters":[{"name":"url","in":"query","description":"The folder’s url (e.g. /site/website/index.xml)","required":true,"schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfile"},"examples":{"userProfileExample":{"$ref":"#/components/examples/userProfileExample"}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/set.json":{"get":{"security":[],"tags":["other"],"summary":"Set Profile","operationId":"setProfile","description":"Set the current user’s profile, all parameters are added to the profile and stored in the session. Only use it in conjunction with Studio’s Personas. <br><br> <i>Note:</i> <br> <i>Any parameter included in the request will be added as a property for the user profile, if the request is made without any parameter then profile will be cleared.</i>","parameters":[{"name":"age","in":"query","description":"The user age","schema":{"type":"integer"}},{"name":"username","in":"query","description":"The user name","schema":{"type":"string"}},{"name":"lastname","in":"query","description":"The user last name","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","example":"john"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/navigation/breadcrumb.json":{"get":{"security":[],"tags":["navigation"],"summary":"Breadcrumb","operationId":"breadcrumb","description":"Returns the navigation items that form the breadcrumb for the specified store URL.","parameters":[{"name":"url","in":"query","required":true,"description":"The URL used to build the breadcrumb","schema":{"type":"string"}},{"name":"root","in":"query","description":"The starting point of the breadcrumb","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NavigationTreeNode"}},"example":[{"label":"Home","url":"/","active":false,"subItem":null},{"label":"Style","url":"/style","active":false,"subItem":null}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/navigation/tree.json":{"get":{"security":[],"tags":["navigation"],"summary":"Tree","operationId":"tree","description":"Returns the navigation tree with the specified depth for the specified store URL.","parameters":[{"name":"url","in":"query","required":true,"description":"The root folder of the tree","schema":{"type":"string"},"example":"/site/website"},{"name":"depth","in":"query","description":"The depth of the tree (defaults to 1)","schema":{"type":"integer"},"example":2},{"name":"currentPageUrl","in":"query","description":"The URL of the current page","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/NavigationTreeNode"},"example":{"label":"Home","url":"/","active":false,"subItem":[{"label":"Style","url":"/style","active":false,"subItem":[]},{"label":"Health","url":"/health","active":false,"subItem":[]},{"label":"Entertainment","url":"/entertainment","active":false,"subItem":[]},{"label":"Technology","url":"/technology","active":false,"subItem":[]}]}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/url/transform.json":{"get":{"security":[],"tags":["navigation"],"summary":"Transform","operationId":"transform","description":"Transforms a URL, based on the current site’s configuration.","parameters":[{"name":"url","in":"query","required":true,"description":"The URL to be transformed","schema":{"type":"string"},"example":"/site/website/style/index.xml"},{"name":"transformerName","in":"query","required":true,"description":"The name of the transformer to apply","schema":{"type":"string"},"example":"storeUrlToRenderUrl"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"/style"}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/search/search.json":{"post":{"security":[],"tags":["search"],"summary":"Search","operationId":"search","description":"Performs a search operation in the OpenSearch index of the current site resolved for the request and optional other indexes. See <a class=\"reference external\" href=\"https://craftercms.com/docs/current/reference/api/search.html#search-multi-index-query\" rel=\"noopener noreferrer\" target=\"_blank\">Multi-index Query</a> for more information on performing a multiple index search. <br><br> <i>Note:</i> <br> <i>The request body must be a valid OpenSearch JSON query as described in the</i> <a class=\"reference external\" href=\"https://opensearch.org/docs/latest/api-reference/search/\" rel=\"noopener noreferrer\" target=\"_blank\">official docs</a>","parameters":[{"name":"index","in":"query","description":"Comma separated list of index names to be searched in addition to the current site","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"requestBody":{"description":"User entity to create","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"_source":{"type":"string","example":"localId"},"size":{"type":"integer","example":1},"query":{"type":"object","example":{"match_all":{}}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"example":{"took":41,"timed_out":false,"_shards":{"total":5,"successful":5,"skipped":0,"failed":0},"hits":{"total":28,"max_score":1,"hits":[{"_index":"editorial-preview_v1","_type":"_doc","_id":"f4a1af43fed0b4e246abb3a8c7d7323d","_score":1,"_source":{"localId":"/site/components/articles-widget/latest-articles-widget.xml"}}]}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/site/graphql.json":{"get":{"security":[],"tags":["content"],"summary":"Query (GET)","operationId":"query","description":"Performs a query in the GraphQL instance of the current site resolved for the request. <br><br> <i>Note:</i> <br> <i>The query string must be a valid GraphQL query as described in the</i> <a class=\"reference external\" href=\"https://graphql.org/learn/queries/\" rel=\"noopener noreferrer\" target=\"_blank\">official docs</a>","parameters":[{"name":"query","in":"query","required":true,"description":"The GraphQL query","schema":{"type":"string"},"example":"{page_article{items{title_t}}}"},{"name":"operationName","in":"query","description":"The GraphQL operation name","schema":{"type":"string"}},{"name":"variables","in":"query","description":"A JSON object containing variables for the query","schema":{"type":"string"}},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"example":{"data":{"page_article":{"items":[{"title_t":"New ACME Phone Released Today"},{"title_t":"Top Clubs In Virginia"},{"title_t":"Coffee is Good for Your Health"},{"title_t":"5 Popular Diets for Women"},{"title_t":"Top Romantic Valentine Movies"},{"title_t":"10 Tips to Get a Six Pack"},{"title_t":"Women Styles for Winter"},{"title_t":"Men Styles For Winter"},{"title_t":"Top Books For Young Women"}]}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"security":[],"tags":["content"],"summary":"Query (POST)","operationId":"queryPost","description":"Performs a query in the GraphQL instance of the current site resolved for the request. <br><br> <i>Note:</i> <br> <i>The query string must be a valid GraphQL query as described in the</i> <a class=\"reference external\" href=\"https://graphql.org/learn/queries/\" rel=\"noopener noreferrer\" target=\"_blank\">official docs</a>","parameters":[{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"requestBody":{"description":"Search Parameters","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"description":"The GraphQL query","type":"string","example":"query ArticlesByAuthor($author:String) { page_article { total items { title_t author_s(filter:{equals:$author}) date_dt } } }"},"variables":{"description":"A JSON object containing variables for the query","type":"object","example":{"author":"Jane Doe"}},"operationName":{"description":"Name you give to your query <br><br> <i>Required when there are multiple operations in the document (query)</i>","type":"string","example":"ArticlesByAuthor"}},"required":["query"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"},"example":{"data":{"page_article":{"total":4,"items":[{"title_t":"Women Styles for Winter","author_s":"Jane Doe","date_dt":"2021-01-03T05:00:00Z"},{"title_t":"Top Books For Young Women","author_s":"Jane Doe","date_dt":"2020-12-28T05:00:00Z"},{"title_t":"5 Popular Diets for Women","author_s":"Jane Doe","date_dt":"2021-03-14T04:00:00Z"},{"title_t":"Top Romantic Valentine Movies","author_s":"Jane Doe","date_dt":"2021-02-14T05:00:00Z"}]}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/config/preview.json":{"get":{"security":[],"tags":["other"],"summary":"Preview","operationId":"preview","description":"Indicates if Engine is configured in preview mode.","parameters":[{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"preview":{"type":"boolean","example":true}}}}}}}}},"/api/1/monitoring/memory.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Memory Stats","operationId":"memory","description":"Returns the Crafter Engine JVM memory details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","example":2017984512},"freeJvmMemory":{"type":"integer","example":1113921056},"maxJvmMemory":{"type":"integer","example":3817865216},"totalOsMemory":{"type":"integer","example":17179869184},"freeOsMemory":{"type":"integer","example":2669301760},"totalSwapMemory":{"type":"integer","example":2147483648},"freeSwapMemory":{"type":"integer","example":1026555904}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/status.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Status","operationId":"status","description":"Returns the Crafter Engine JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uptime":{"type":"integer","example":2017984512},"startup":{"type":"string","example":"2019-03-07T21:29:11.049Z"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/version.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Version","operationId":"version","description":"Returns the Crafter Engine JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"packageName":{"type":"string","example":"Crafter Engine"},"packageVersion":{"type":"string","example":"4.0.3-SNAPSHOT"},"packageBuild":{"type":"string","example":"48d29a56c6011f2908fb160f7648f66785d44b81"},"packageBuildDate":{"type":"string","example":"2023-03-08T21:53:22.558Z"},"osName":{"type":"string","example":"Mac OS X"},"osVersion":{"type":"string","example":"11.2"},"osArch":{"type":"string","example":"x86_64"},"javaVersion":{"type":"string","example":"11"},"javaVendor":{"type":"string","example":"Oracle Corporation"},"javaVm":{"type":"string","example":"OpenJDK 64-Bit Server VM"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/log.json":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Log Events","operationId":"log","description":"Returns all events recorded in the Crafter Engine log for a given site in a specific time period.","parameters":[{"name":"site","in":"query","description":"The name of the site","required":true,"schema":{"type":"string"},"example":"my-editorial"},{"name":"since","in":"query","description":"The time in milliseconds from which events should be fetched","required":true,"schema":{"type":"integer"},"example":1396772083660},{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"exception":{"type":"string"},"site":{"type":"string"},"level":{"type":"string"},"thread":{"type":"string"},"message":{"type":"string"},"timestampm":{"type":"integer"},"timestamp":{"type":"string"}}},"example":[{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"--------------------------------------------------","timestampm":1678683085456,"timestamp":"2023-03-13T04:51:25.456+0000"},{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"<Initializing context site: editorial>","timestampm":1678683085477,"timestamp":"2023-03-13T04:51:25.477+0000"},{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"--------------------------------------------------","timestampm":1678683085498,"timestamp":"2023-03-13T04:51:25.498+0000"},{"exception":"","site":"editorial","level":"INFO","thread":"pool-16-thread-1","message":"Starting GraphQL schema build for site 'editorial'","timestampm":1678683085499,"timestamp":"2023-03-13T04:51:25.499+0000"}]}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/crafter-controller/component.json":{"get":{"security":[],"tags":["other"],"summary":"Get Component","operationId":"getComponent","description":"Get a component.","parameters":[{"name":"path","in":"query","description":"Path to the component <br> (e.g. /site/components/headers/header.xml)","required":true,"schema":{"type":"string"},"example":"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml"},{"name":"crafterSite","in":"query","required":true,"description":"Used to set the project/site value","schema":{"type":"string"},"example":"my-editorial"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"},"example":"<!-- Feature Component -->\\n <article class=\"feature\" data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" >  <span class=\"icon fa-smile far\" data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"icon_s\" ></span> <div class=\"content\"> <h3 data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"title_t\" >      Smile </h3> <div data-craftercms-model-path=\"/site/components/features/4be0a368-783c-8f73-7469-63a62636bd4c.xml\" data-craftercms-model-id=\"4be0a368-783c-8f73-7469-63a62636bd4c\" data-craftercms-field-id=\"body_html\" >      <p>Smile, aenean ornare velit lacus, ac varius enim lorem ullamcorper dolore. Proin aliquam facilisis ante interdum. Sed nulla amet lorem feugiat tempus aliquam.</p> </div> </div> </article> <!-- /Feature Component -->"}}}}}}},"components":{"schemas":{"Statistics":{"type":"object","properties":{"size":{"type":"integer"},"localHeapSize":{"type":"integer"},"localOffHeapSize":{"type":"integer"},"localDiskSize":{"type":"integer"},"cacheHitRatio":{"type":"integer"},"cacheHitCount":{"type":"integer"},"cacheMissCount":{"type":"integer"},"cacheMissExpiredCount":{"type":"integer"},"cacheMissNotFoundCount":{"type":"integer"}},"example":{"size":17,"localHeapSize":17,"localOffHeapSize":0,"localDiskSize":0,"cacheHitRatio":1,"cacheHitCount":4,"cacheMissCount":25,"cacheMissExpiredCount":0,"cacheMissNotFoundCount":25}},"ContentStoreItems":{"type":"object","properties":{"name":{"description":"Name of item being retrieved (e.g. index.xml)","type":"string"},"url":{"description":"The item’s URL (e.g. /site/website/index.xml)","type":"string"},"descriptorUrl":{"description":"The item’s descriptor URL (e.g. for a folder: /site/website.meta.xml, for a page: /site/website/index.xml)","type":"string"},"descriptorDom":{"description":"Contains the content of item being retrieved (DOM of xml)","type":"object","nullable":true},"properties":{"description":"Contains additional properties that are generated by an ItemProcessor","type":"string","nullable":true},"folder":{"description":"Indicates whether the item is a folder (true or false)","type":"boolean"}}},"UserProfile":{"type":"object","properties":{"age":{"type":"integer"},"username":{"type":"string"},"lastname":{"type":"string"}}},"NavigationTreeNode":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"},"active":{"type":"boolean"},"subItems":{"type":"object"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"No item found at /site/website/index.xml"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Required String parameter 'token' is not present"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Management authorization failed, invalid token."}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}}},"examples":{"userProfileExample":{"value":{"age":30,"username":"john","lastname":"doe"}}}}}},"searchIndex":{"store":["tag/content","tag/content/operation/getItem","tag/content/operation/getChildren","tag/content/operation/getTree","tag/content/operation/query","tag/content/operation/queryPost","tag/navigation","tag/navigation/operation/breadcrumb","tag/navigation/operation/tree","tag/navigation/operation/transform","tag/search","tag/search/operation/search","tag/cache","tag/cache/operation/cacheClear","tag/cache/operation/cacheStatistics","tag/context","tag/context/operation/getSiteContextID","tag/context/operation/getSiteContextStatus","tag/context/operation/destroySiteContext","tag/context/operation/rebuildSiteContext","tag/context/operation/rebuildAllSiteContexts","tag/context/operation/rebuildGraphQLSchema","tag/context/operation/mappingsReload","tag/monitoring","tag/monitoring/operation/memory","tag/monitoring/operation/status","tag/monitoring/operation/version","tag/monitoring/operation/log","tag/other","tag/other/operation/listJobs","tag/other/operation/getProfile","tag/other/operation/setProfile","tag/other/operation/preview","tag/other/operation/getComponent"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.805]],["description/0",[0,2.233,1,4.566,2,2.052]],["title/1",[3,2.169]],["description/1",[0,1.422,3,1.709,4,0.984,5,0.984,6,2.908,7,1.554,8,1.84,9,1.345,10,2.126,11,1.112,12,1.84,13,1.84,14,1.198,15,1.84,16,1.84,17,1.84,18,1.542,19,1.84,20,1.84,21,1.542,22,0.9,23,0.827,24,1.198,25,1.198,26,1.84,27,1.84,28,1.84,29,1.84]],["title/2",[30,3.691]],["description/2",[0,1.803,3,2.165,4,1.97,10,2.694,31,2.694,32,3.686,33,3.088,34,3.686]],["title/3",[35,2.698]],["description/3",[0,1.736,3,2.085,4,1.897,10,2.594,33,2.973,36,3.549,37,3.549,38,2.594,39,3.549]],["title/4",[40,2.169]],["description/4",[5,1.137,40,2.323,41,1.555,42,2.12,43,1.782,44,0.55,45,0.395,46,0.881,47,0.881,48,1.25,49,1.25,50,1.385,51,1.782,52,1.555,53,1.555,54,1.555,55,1.555,56,1.555,57,1.782,58,1.555,59,1.555,60,1.555,61,1.555,62,1.782]],["title/5",[40,1.659,63,2.823]],["description/5",[5,1.137,40,2.323,41,1.555,42,2.12,43,1.782,44,0.55,45,0.395,46,0.881,47,0.881,48,1.25,49,1.25,50,1.385,51,1.782,52,1.555,53,1.555,54,1.555,55,1.555,56,1.555,57,1.782,58,1.555,59,1.555,60,1.555,61,1.555,62,1.782]],["title/6",[64,2.404]],["description/6",[2,2.052,64,2.974,65,4.566]],["title/7",[66,3.093]],["description/7",[3,2.085,4,1.897,11,1.357,14,2.311,38,2.594,64,2.311,66,2.973,67,3.549,68,3.549]],["title/8",[35,2.698]],["description/8",[4,1.897,11,1.357,14,2.311,35,2.594,38,3.431,64,2.311,69,3.549,70,3.549]],["title/9",[71,3.093]],["description/9",[14,2.497,44,0.991,71,3.212,72,3.212,73,3.834,74,2.497,75,3.834]],["title/10",[76,2.404]],["description/10",[2,2.155,76,3.123]],["title/11",[76,2.404]],["description/11",[2,0.682,5,0.812,40,0.892,41,1.821,44,0.393,45,0.282,46,0.629,47,1.031,48,0.892,49,0.892,50,0.989,52,1.11,53,1.11,54,1.11,55,1.821,56,1.821,58,1.821,59,1.821,60,1.11,61,1.11,76,1.622,77,2.491,78,3.168,79,1.519,80,1.519,81,1.519,82,1.519,83,1.519,84,1.519,85,1.519,86,1.519,87,1.519,88,1.519,89,1.519,90,1.519]],["title/12",[91,1.973]],["description/12",[2,2.155,91,2.563]],["title/13",[0,1.118,91,1.222,92,1.671]],["description/13",[0,1.673,44,0.885,45,0.635,91,2.449,92,2.501,93,2.867,94,3.422,95,0.885,96,3.422]],["title/14",[97,3.093]],["description/14",[5,0.93,11,0.665,21,1.458,22,0.851,23,0.782,24,1.133,25,1.133,44,0.45,45,0.323,48,1.022,49,1.022,50,1.133,72,1.458,74,1.811,91,1.857,93,1.458,95,0.45,97,2.33,98,2.781,99,1.74,100,1.74,101,1.74,102,1.74,103,1.74,104,1.458,105,1.74,106,1.74,107,1.272,108,1.272,109,1.74,110,1.74,111,1.74]],["title/15",[95,0.954]],["description/15",[2,2.052,95,1.181,112,4.566]],["title/16",[45,0.424,95,0.591,113,1.915]],["description/16",[7,1.652,11,1.181,44,0.799,45,0.574,46,1.279,47,1.279,95,0.799,107,2.259,108,2.259,113,2.589,114,2.589,115,2.589,116,3.09]],["title/17",[45,0.424,95,0.591,117,1.343]],["description/17",[7,1.652,11,1.181,44,0.799,45,0.574,46,1.279,47,1.279,95,0.799,107,2.259,108,2.259,114,2.589,115,2.589,117,1.815,118,3.09]],["title/18",[45,0.424,95,0.591,119,1.671]],["description/18",[44,0.619,45,0.789,46,0.991,47,0.991,74,1.559,91,1.279,92,1.75,95,0.92,119,3.437,120,2.393,121,2.393,122,2.393,123,2.393,124,2.393,125,2.393,126,2.393]],["title/19",[45,0.424,95,0.591,127,1.222]],["description/19",[44,0.826,45,0.593,46,1.322,47,1.322,95,1.13,119,2.334,127,1.707,128,3.193,129,2.675,130,3.193,131,3.193]],["title/20",[45,0.424,95,0.591,127,1.222]],["description/20",[44,0.991,45,0.712,95,0.991,127,2.049,132,3.834,133,3.834,134,3.834]],["title/21",[42,1.488,127,1.222,135,1.915]],["description/21",[42,2.311,44,0.918,45,0.659,46,1.469,47,1.469,95,0.918,127,1.897,135,2.973,136,3.549]],["title/22",[137,2.365,138,2.365]],["description/22",[7,1.551,22,2.001,23,1.838,25,1.89,45,0.539,46,1.202,137,2.432,138,3.428,139,2.902,140,2.902,141,2.902,142,2.902]],["title/23",[143,3.093]],["description/23",[2,2.155,143,4.018]],["title/24",[144,2.365,145,2.823]],["description/24",[11,1.465,22,1.875,23,1.723,144,3.212,146,2.802,147,2.802,148,3.834]],["title/25",[117,2.169]],["description/25",[11,1.465,22,1.875,23,1.723,117,2.252,146,2.802,147,2.802,149,3.834]],["title/26",[150,3.691]],["description/26",[11,1.465,22,1.875,23,1.723,117,2.252,146,2.802,147,2.802,151,3.834]],["title/27",[152,2.365,153,2.365]],["description/27",[11,1.221,22,1.562,23,1.435,45,0.593,152,2.675,153,2.675,154,3.193,155,3.193,156,3.193,157,3.193,158,3.193,159,3.193]],["title/28",[]],["description/28",[2,2.155,160,4.796]],["title/29",[31,2.064,161,2.365]],["description/29",[31,2.92,44,1.033,45,0.742,161,3.346,162,3.994,163,3.994]],["title/30",[164,2.404]],["description/30",[7,1.6,44,0.774,104,2.508,129,2.508,164,2.723,165,2.508,166,2.508,167,2.188,168,2.993,169,2.508,170,2.508,171,2.508,172,2.993]],["title/31",[164,1.838,167,2.064]],["description/31",[4,1.044,5,1.044,7,1.044,18,1.636,44,0.505,47,1.262,48,1.148,49,1.148,164,2.757,165,1.636,166,1.636,167,1.428,169,1.636,170,1.636,171,1.636,173,3.747,174,3.047,175,1.953,176,1.953,177,1.953,178,1.953,179,1.953,180,1.953,181,1.953]],["title/32",[24,2.404]],["description/32",[23,1.795,24,2.601,25,2.601,74,2.601,182,3.994,183,3.994]],["title/33",[9,2.698]],["description/33",[9,3.506,184,4.796]]],"invertedIndex":[["ad",{"_index":174,"title":{},"description":{"31":{}}}],["again",{"_index":130,"title":{},"description":{"19":{}}}],["alway",{"_index":103,"title":{},"description":{"14":{}}}],["api",{"_index":6,"title":{},"description":{"1":{}}}],["api/1/config/preview.json",{"_index":183,"title":{},"description":{"32":{}}}],["api/1/monitoring/log.json",{"_index":159,"title":{},"description":{"27":{}}}],["api/1/monitoring/memory.json",{"_index":148,"title":{},"description":{"24":{}}}],["api/1/monitoring/status.json",{"_index":149,"title":{},"description":{"25":{}}}],["api/1/monitoring/version.json",{"_index":151,"title":{},"description":{"26":{}}}],["api/1/profile/get.json",{"_index":172,"title":{},"description":{"30":{}}}],["api/1/profile/set.json",{"_index":181,"title":{},"description":{"31":{}}}],["api/1/site/cache/clear.json",{"_index":96,"title":{},"description":{"13":{}}}],["api/1/site/cache/statistics.json",{"_index":111,"title":{},"description":{"14":{}}}],["api/1/site/content_store/children.json",{"_index":34,"title":{},"description":{"2":{}}}],["api/1/site/content_store/item.json",{"_index":29,"title":{},"description":{"1":{}}}],["api/1/site/content_store/tree.json",{"_index":39,"title":{},"description":{"3":{}}}],["api/1/site/context/destroy.json",{"_index":126,"title":{},"description":{"18":{}}}],["api/1/site/context/graphql/rebuild.json",{"_index":136,"title":{},"description":{"21":{}}}],["api/1/site/context/id.json",{"_index":116,"title":{},"description":{"16":{}}}],["api/1/site/context/rebuild.json",{"_index":131,"title":{},"description":{"19":{}}}],["api/1/site/context/rebuild_all.json",{"_index":134,"title":{},"description":{"20":{}}}],["api/1/site/context/status.json",{"_index":118,"title":{},"description":{"17":{}}}],["api/1/site/graphql.json",{"_index":62,"title":{},"description":{"4":{},"5":{}}}],["api/1/site/jobs/list.json",{"_index":163,"title":{},"description":{"29":{}}}],["api/1/site/mappings/reload.json",{"_index":142,"title":{},"description":{"22":{}}}],["api/1/site/navigation/breadcrumb.json",{"_index":68,"title":{},"description":{"7":{}}}],["api/1/site/navigation/tree.json",{"_index":70,"title":{},"description":{"8":{}}}],["api/1/site/search/search.json",{"_index":90,"title":{},"description":{"11":{}}}],["api/1/site/url/transform.json",{"_index":75,"title":{},"description":{"9":{}}}],["author",{"_index":27,"title":{},"description":{"1":{}}}],["avail",{"_index":140,"title":{},"description":{"22":{}}}],["base",{"_index":72,"title":{},"description":{"9":{},"14":{}}}],["be",{"_index":109,"title":{},"description":{"14":{}}}],["bean",{"_index":123,"title":{},"description":{"18":{}}}],["bodi",{"_index":87,"title":{},"description":{"11":{}}}],["br",{"_index":5,"title":{},"description":{"1":{},"4":{},"5":{},"11":{},"14":{},"31":{}}}],["br><br",{"_index":48,"title":{},"description":{"4":{},"5":{},"11":{},"14":{},"31":{}}}],["br><br><i",{"_index":19,"title":{},"description":{"1":{}}}],["breadcrumb",{"_index":66,"title":{"7":{}},"description":{"7":{}}}],["cach",{"_index":91,"title":{"12":{},"13":{}},"description":{"12":{},"13":{},"14":{},"18":{}}}],["call",{"_index":99,"title":{},"description":{"14":{}}}],["cases.</i",{"_index":28,"title":{},"description":{"1":{}}}],["chang",{"_index":100,"title":{},"description":{"14":{}}}],["children",{"_index":30,"title":{"2":{}},"description":{}}],["class=\"refer",{"_index":55,"title":{},"description":{"4":{},"5":{},"11":{}}}],["classload",{"_index":125,"title":{},"description":{"18":{}}}],["clear",{"_index":92,"title":{"13":{}},"description":{"13":{},"18":{}}}],["cleared.</i",{"_index":180,"title":{},"description":{"31":{}}}],["complet",{"_index":36,"title":{},"description":{"3":{}}}],["compon",{"_index":9,"title":{"33":{}},"description":{"1":{},"33":{}}}],["configur",{"_index":74,"title":{},"description":{"9":{},"14":{},"18":{},"32":{}}}],["conjunct",{"_index":169,"title":{},"description":{"30":{},"31":{}}}],["content",{"_index":0,"title":{"0":{},"13":{}},"description":{"0":{},"1":{},"2":{},"3":{},"13":{}}}],["context",{"_index":95,"title":{"15":{},"16":{},"17":{},"18":{},"19":{},"20":{}},"description":{"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{}}}],["crafter",{"_index":22,"title":{},"description":{"1":{},"14":{},"22":{},"24":{},"25":{},"26":{},"27":{}}}],["crafter-controller/component.json",{"_index":184,"title":{},"description":{"33":{}}}],["creat",{"_index":129,"title":{},"description":{"19":{},"30":{}}}],["current",{"_index":44,"title":{},"description":{"4":{},"5":{},"9":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"29":{},"30":{},"31":{}}}],["depend",{"_index":107,"title":{},"description":{"14":{},"16":{},"17":{}}}],["depth",{"_index":69,"title":{},"description":{"8":{}}}],["describ",{"_index":53,"title":{},"description":{"4":{},"5":{},"11":{}}}],["descriptorurl",{"_index":15,"title":{},"description":{"1":{}}}],["destroy",{"_index":119,"title":{"18":{}},"description":{"18":{},"19":{}}}],["detail",{"_index":147,"title":{},"description":{"24":{},"25":{},"26":{}}}],["differ",{"_index":106,"title":{},"description":{"14":{}}}],["directli",{"_index":32,"title":{},"description":{"2":{}}}],["disabl",{"_index":21,"title":{},"description":{"1":{},"14":{}}}],["docs</a",{"_index":61,"title":{},"description":{"4":{},"5":{},"11":{}}}],["empti",{"_index":104,"title":{},"description":{"14":{},"30":{}}}],["endpoint",{"_index":139,"title":{},"description":{"22":{}}}],["engin",{"_index":23,"title":{},"description":{"1":{},"14":{},"22":{},"24":{},"25":{},"26":{},"27":{},"32":{}}}],["event",{"_index":153,"title":{"27":{}},"description":{"27":{}}}],["exampl",{"_index":102,"title":{},"description":{"14":{}}}],["extern",{"_index":56,"title":{},"description":{"4":{},"5":{},"11":{}}}],["extra",{"_index":17,"title":{},"description":{"1":{}}}],["flag",{"_index":16,"title":{},"description":{"1":{}}}],["folder",{"_index":10,"title":{},"description":{"1":{},"2":{},"3":{}}}],["form",{"_index":67,"title":{},"description":{"7":{}}}],["found",{"_index":132,"title":{},"description":{"20":{}}}],["freemark",{"_index":94,"title":{},"description":{"13":{}}}],["given",{"_index":155,"title":{},"description":{"27":{}}}],["graphql",{"_index":42,"title":{"21":{}},"description":{"4":{},"5":{},"21":{}}}],["groovi",{"_index":124,"title":{},"description":{"18":{}}}],["hierarchi",{"_index":37,"title":{},"description":{"3":{}}}],["href=\"https://craftercms.com/docs/current/reference/api/search.html#search-multi-index-queri",{"_index":81,"title":{},"description":{"11":{}}}],["href=\"https://graphql.org/learn/queri",{"_index":57,"title":{},"description":{"4":{},"5":{}}}],["href=\"https://opensearch.org/docs/latest/api-reference/search",{"_index":89,"title":{},"description":{"11":{}}}],["i>ani",{"_index":175,"title":{},"description":{"31":{}}}],["i>note:</i",{"_index":49,"title":{},"description":{"4":{},"5":{},"11":{},"14":{},"31":{}}}],["i>th",{"_index":50,"title":{},"description":{"4":{},"5":{},"11":{},"14":{}}}],["id",{"_index":113,"title":{"16":{}},"description":{"16":{}}}],["implement",{"_index":108,"title":{},"description":{"14":{},"16":{},"17":{}}}],["includ",{"_index":176,"title":{},"description":{"31":{}}}],["index",{"_index":78,"title":{},"description":{"11":{}}}],["indic",{"_index":182,"title":{},"description":{"32":{}}}],["inform",{"_index":85,"title":{},"description":{"11":{}}}],["instanc",{"_index":43,"title":{},"description":{"4":{},"5":{}}}],["involv",{"_index":120,"title":{},"description":{"18":{}}}],["item",{"_index":3,"title":{"1":{}},"description":{"1":{},"2":{},"3":{},"7":{}}}],["job",{"_index":161,"title":{"29":{}},"description":{"29":{}}}],["json",{"_index":88,"title":{},"description":{"11":{}}}],["jvm",{"_index":146,"title":{},"description":{"24":{},"25":{},"26":{}}}],["list",{"_index":31,"title":{"29":{}},"description":{"2":{},"29":{}}}],["load",{"_index":121,"title":{},"description":{"18":{}}}],["log",{"_index":152,"title":{"27":{}},"description":{"27":{}}}],["made",{"_index":178,"title":{},"description":{"31":{}}}],["map",{"_index":138,"title":{"22":{}},"description":{"22":{}}}],["mean",{"_index":128,"title":{},"description":{"19":{}}}],["memori",{"_index":144,"title":{"24":{}},"description":{"24":{}}}],["metadata",{"_index":12,"title":{},"description":{"1":{}}}],["miscellan",{"_index":160,"title":{},"description":{"28":{}}}],["mode",{"_index":25,"title":{},"description":{"1":{},"14":{},"22":{},"32":{}}}],["monitor",{"_index":143,"title":{"23":{}},"description":{"23":{}}}],["more",{"_index":84,"title":{},"description":{"11":{}}}],["multi-ten",{"_index":141,"title":{},"description":{"22":{}}}],["multipl",{"_index":86,"title":{},"description":{"11":{}}}],["navig",{"_index":64,"title":{"6":{}},"description":{"6":{},"7":{},"8":{}}}],["noreferr",{"_index":59,"title":{},"description":{"4":{},"5":{},"11":{}}}],["note",{"_index":20,"title":{},"description":{"1":{}}}],["object",{"_index":105,"title":{},"description":{"14":{}}}],["on",{"_index":168,"title":{},"description":{"30":{}}}],["opensearch",{"_index":77,"title":{},"description":{"11":{}}}],["oper",{"_index":2,"title":{},"description":{"0":{},"6":{},"10":{},"11":{},"12":{},"15":{},"23":{},"28":{}}}],["option",{"_index":79,"title":{},"description":{"11":{}}}],["page",{"_index":8,"title":{},"description":{"1":{}}}],["paramet",{"_index":173,"title":{},"description":{"31":{}}}],["perform",{"_index":41,"title":{},"description":{"4":{},"5":{},"11":{}}}],["period",{"_index":158,"title":{},"description":{"27":{}}}],["persona",{"_index":171,"title":{},"description":{"30":{},"31":{}}}],["post",{"_index":63,"title":{"5":{}},"description":{}}],["preview",{"_index":24,"title":{"32":{}},"description":{"1":{},"14":{},"32":{}}}],["profil",{"_index":164,"title":{"30":{},"31":{}},"description":{"30":{},"31":{}}}],["project/sit",{"_index":112,"title":{},"description":{"15":{}}}],["properti",{"_index":18,"title":{},"description":{"1":{},"31":{}}}],["queri",{"_index":40,"title":{"4":{},"5":{}},"description":{"4":{},"5":{},"11":{}}}],["query</a",{"_index":83,"title":{},"description":{"11":{}}}],["rebuild",{"_index":127,"title":{"19":{},"20":{},"21":{}},"description":{"19":{},"20":{},"21":{}}}],["record",{"_index":154,"title":{},"description":{"27":{}}}],["registri",{"_index":133,"title":{},"description":{"20":{}}}],["rel=\"noopen",{"_index":58,"title":{},"description":{"4":{},"5":{},"11":{}}}],["reload",{"_index":137,"title":{"22":{}},"description":{"22":{}}}],["request",{"_index":47,"title":{},"description":{"4":{},"5":{},"11":{},"16":{},"17":{},"18":{},"19":{},"21":{},"31":{}}}],["resolv",{"_index":46,"title":{},"description":{"4":{},"5":{},"11":{},"16":{},"17":{},"18":{},"19":{},"21":{},"22":{}}}],["result",{"_index":98,"title":{},"description":{"14":{}}}],["retriev",{"_index":1,"title":{},"description":{"0":{}}}],["return",{"_index":11,"title":{},"description":{"1":{},"7":{},"8":{},"14":{},"16":{},"17":{},"24":{},"25":{},"26":{},"27":{}}}],["schedul",{"_index":162,"title":{},"description":{"29":{}}}],["schema",{"_index":135,"title":{"21":{}},"description":{"21":{}}}],["scope",{"_index":93,"title":{},"description":{"13":{},"14":{}}}],["search",{"_index":76,"title":{"10":{},"11":{}},"description":{"10":{},"11":{}}}],["see",{"_index":80,"title":{},"description":{"11":{}}}],["session",{"_index":166,"title":{},"description":{"30":{},"31":{}}}],["set",{"_index":167,"title":{"31":{}},"description":{"30":{},"31":{}}}],["site",{"_index":45,"title":{"16":{},"17":{},"18":{},"19":{},"20":{}},"description":{"4":{},"5":{},"11":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"27":{},"29":{}}}],["siteresolv",{"_index":115,"title":{},"description":{"16":{},"17":{}}}],["site’",{"_index":73,"title":{},"description":{"9":{}}}],["specif",{"_index":156,"title":{},"description":{"27":{}}}],["specifi",{"_index":38,"title":{},"description":{"3":{},"7":{},"8":{}}}],["spring",{"_index":122,"title":{},"description":{"18":{}}}],["stat",{"_index":145,"title":{"24":{}},"description":{}}],["statist",{"_index":97,"title":{"14":{}},"description":{"14":{}}}],["statu",{"_index":117,"title":{"17":{},"25":{}},"description":{"17":{},"25":{},"26":{}}}],["store",{"_index":4,"title":{},"description":{"1":{},"2":{},"3":{},"7":{},"8":{},"31":{}}}],["string",{"_index":51,"title":{},"description":{"4":{},"5":{}}}],["structur",{"_index":65,"title":{},"description":{"6":{}}}],["studio’",{"_index":170,"title":{},"description":{"30":{},"31":{}}}],["such",{"_index":13,"title":{},"description":{"1":{}}}],["support",{"_index":26,"title":{},"description":{"1":{}}}],["system",{"_index":101,"title":{},"description":{"14":{}}}],["target=\"_blank\">multi-index",{"_index":82,"title":{},"description":{"11":{}}}],["target=\"_blank\">offici",{"_index":60,"title":{},"description":{"4":{},"5":{},"11":{}}}],["the</i",{"_index":54,"title":{},"description":{"4":{},"5":{},"11":{}}}],["time",{"_index":157,"title":{},"description":{"27":{}}}],["transform",{"_index":71,"title":{"9":{}},"description":{"9":{}}}],["tree",{"_index":35,"title":{"3":{},"8":{}},"description":{"8":{}}}],["under",{"_index":33,"title":{},"description":{"2":{},"3":{}}}],["url",{"_index":14,"title":{},"description":{"1":{},"7":{},"8":{},"9":{}}}],["us",{"_index":7,"title":{},"description":{"1":{},"16":{},"17":{},"22":{},"30":{},"31":{}}}],["used.</i",{"_index":110,"title":{},"description":{"14":{}}}],["user",{"_index":177,"title":{},"description":{"31":{}}}],["user’",{"_index":165,"title":{},"description":{"30":{},"31":{}}}],["valid",{"_index":52,"title":{},"description":{"4":{},"5":{},"11":{}}}],["valu",{"_index":114,"title":{},"description":{"16":{},"17":{}}}],["version",{"_index":150,"title":{"26":{}},"description":{}}],["without",{"_index":179,"title":{},"description":{"31":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/source/_static/api/profile.html b/source/_static/api/profile.html
index 422c2ca57..3d4c31614 100644
--- a/source/_static/api/profile.html
+++ b/source/_static/api/profile.html
@@ -410,7 +410,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Profile<!-- --> <span>(<!-- -->4.4.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Profile API&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Profile<!-- --> <span>(<!-- -->4.5.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Profile API&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Crafter Profile API</p>
 </div><div class="sc-ixcdjX gvxrGF"><a href="https://craftercms.com/docs/current/reference/modules/profile.html">CrafterCMS - Profile</a></div></div></div></div><div id="tag/access_token" data-section-id="tag/access_token" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/access_token" aria-label="tag/access_token"></a>access_token</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="&lt;p&gt;Access token management&lt;/p&gt;
 "><p>Access token management</p>
@@ -1192,7 +1192,7 @@
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Internal server error</p>
 </div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/api/1/monitoring/version</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:8080/crafter-profile</span>/api/1/monitoring/version</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjjqq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjjqq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«Rjjqq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjqq»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«Rjjqq»2" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjqq»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«Rjjqq»3" aria-selected="false" aria-disabled="false" aria-controls="panel«Rjjqq»3" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjjqq»0" aria-labelledby="tab«Rjjqq»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"packageName"</span>: <span class="token string">&quot;Crafter Profile&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packageVersion"</span>: <span class="token string">&quot;3.1.0-SNAPSHOT&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packageBuild"</span>: <span class="token string">&quot;a68f1ff7ad84d5ecbeaa008f392e4cef0ca02f41&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packageBuildDate"</span>: <span class="token string">&quot;2019-03-07T21:03:05.422Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"osName"</span>: <span class="token string">&quot;Mac OS X&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"osVersion"</span>: <span class="token string">&quot;10.13.6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"osArch"</span>: <span class="token string">&quot;x86_64&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"javaVersion"</span>: <span class="token string">&quot;1.8&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"javaVendor"</span>: <span class="token string">&quot;Oracle Corporation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"javaVm"</span>: <span class="token string">&quot;Java HotSpot(TM) 64-Bit Server VM&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjjqq»1" aria-labelledby="tab«Rjjqq»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjjqq»2" aria-labelledby="tab«Rjjqq»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«Rjjqq»3" aria-labelledby="tab«Rjjqq»3"></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080/crafter-profile"}],"info":{"description":"Crafter Profile API","version":"4.4.4","title":"Crafter Profile","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Profile","url":"https://craftercms.com/docs/current/reference/modules/profile.html"},"tags":[{"name":"access_token","description":"Access token management"},{"name":"tenant","description":"Tenant management"},{"name":"profile","description":"Profile management"},{"name":"authentication","description":"Authentication"},{"name":"monitoring","description":"Monitoring operations"}],"paths":{"/api/1/access_token/create":{"post":{"security":[],"tags":["access_token"],"summary":"Create Access Token","operationId":"createAccessToken","description":"Creates a new access token","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The access token","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":{"application":"sample-app","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"sample-tenant"}],"expiresOn":1704067200000}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":{"application":"sample-app","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"sample-tenant"}],"expiresOn":1704067200000,"id":"a3f1a69c-3a7d-4b28-a944-61a7dc6877b8"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/access_token/{id}":{"get":{"security":[],"tags":["access_token"],"summary":"Get Access Token","operationId":"getAccessToken","description":"Get the information for a specific access token.","parameters":[{"name":"id","in":"path","description":"The ID of specific access token being requested for more information","required":true,"schema":{"type":"string"},"example":"b4d44030-d0af-11e3-9c1a-0800200c9a66"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessToken"}},"example":{"application":"crafterengine","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"*"}],"expiresOn":1704067200000,"id":"b4d44030-d0af-11e3-9c1a-0800200c9a66"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/access_token/all":{"get":{"security":[],"tags":["access_token"],"summary":"Get All Access Tokens","operationId":"getAllAccessToken","description":"Get all existing access tokens.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":[{"application":"adminconsole","master":true,"tenantPermissions":[{"allowedActions":["*"],"tenant":"*"}],"expiresOn":1704067200000,"id":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"application":"crafterengine","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"*"}],"expiresOn":1704067200000,"id":"b4d44030-d0af-11e3-9c1a-0800200c9a66"},{"application":"craftersocial","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"*"}],"expiresOn":1704067200000,"id":"2ba3ac10-c43e-11e3-9c1a-0800200c9a66"}]}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/access_token/{id}/delete":{"post":{"security":[],"tags":["access_token"],"summary":"Delete Access Token","operationId":"deleteAccessToken","description":"Deletes an access token","parameters":[{"name":"id","in":"path","description":"The ID to be deleted","required":true,"schema":{"type":"string"},"example":"a3f1a69c-3a7d-4b28-a944-61a7dc6877b8"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The access token","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":{"application":"sample-app","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"sample-tenant"}],"expiresOn":1704067200000}}}},"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/create":{"post":{"security":[],"tags":["tenant"],"summary":"Create Tenant","operationId":"createTenant","description":"Creates the given tenant","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The tenant to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}":{"get":{"security":[],"tags":["tenant"],"summary":"Get Tenant","operationId":"getTenant","description":"Returns a tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/update":{"post":{"security":[],"tags":["tenant"],"summary":"Update Tenant","operationId":"updateTenant","description":"Updates the given tenant","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The updates to tenant","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"ssoEnable":true,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"ssoEnabled":true,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/delete":{"post":{"security":[],"tags":["tenant"],"summary":"Delete Tenant","operationId":"deleteTenant","description":"Deletes a tenant","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/count":{"get":{"security":[],"tags":["tenant"],"summary":"Count Tenants","operationId":"countTenants","description":"Returns the total number of tenants.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer"},"example":1}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/all":{"get":{"security":[],"tags":["tenant"],"summary":"Get All Tenants","operationId":"getAllTenants","description":"Returns a list with all the tenants.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":[{"name":"default","verifyNewProfiles":false,"availableRoles":["SOCIAL_SUPERADMIN","PROFILE_ADMIN","PROFILE_SUPERADMIN","PROFILE_TENANT_ADMIN"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"displayName","metadata":[{"label":"Display Name","type":"TEXT","displayOrder":2}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"socialContexts","metadata":[{"label":"Social Contexts","type":"COMPLEX","displayOrder":5}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926f6c524d9aaad9804a401"},{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/verify_new_profiles":{"post":{"security":[],"tags":["tenant"],"summary":"Verify New Profiles","operationId":"verifyNewProfiles","description":"Sets if new profiles for the specified tenant should be verified or not.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"verify","in":"query","description":"True to verify new profiles through email, false otherwise","required":true,"schema":{"type":"string"},"example":"true"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/roles/add":{"post":{"security":[],"tags":["tenant"],"summary":"Add Roles","operationId":"addRoles","description":"Adds the given roles to the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"role","in":"query","description":"The roles to add","required":true,"schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER","APP_TEST","APP_REPORT"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/roles/remove":{"post":{"security":[],"tags":["tenant"],"summary":"Remove Roles","operationId":"removeRoles","description":"Removes the given roles to the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"role","in":"query","description":"The roles to add","required":true,"schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/attribute_definitions/add":{"post":{"security":[],"tags":["tenant"],"summary":"Add Attributes","operationId":"addAttributes","description":"Adds the given attribute definitions to the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The attribute(s) to be added","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenantAttribute"}},"example":{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/attribute_definitions/update":{"post":{"security":[],"tags":["tenant"],"summary":"Update Attributes","operationId":"updateAttributes","description":"Updates the given attribute definitions of the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The attribute(s) to be updated","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenantAttribute"}},"example":{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":10}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":10}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/attribute_definitions/remove":{"post":{"security":[],"tags":["tenant"],"summary":"Remove Attributes","operationId":"removeAttributes","description":"Removes the given attribute definitions from the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"attributeName","in":"query","description":"The name of the attributes whose definitions should be removed (the parameter can be repeated)","required":true,"schema":{"type":"string"},"example":"nickname"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/create":{"post":{"security":[],"tags":["profile"],"summary":"Create Profile","operationId":"createProfile","description":"Creates a new profile for a specific tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The name of the tenant to add the profile to.","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"username","in":"query","description":"The profile’s username.","required":true,"schema":{"type":"string"},"example":"john.doe"},{"name":"password","in":"query","description":"The profile’s password.","schema":{"type":"string"},"example":"passw0rd"},{"name":"email","in":"query","description":"The profile’s email.","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"},{"name":"enabled","in":"query","description":"If the profile should be enabled or not.","required":true,"schema":{"type":"string"},"example":false},{"name":"role","in":"query","description":"The profile’s roles.","schema":{"type":"string"},"example":false},{"name":"attributes","in":"query","description":"The additional attributes to add to the profile (specify a JSON string)","schema":{"type":"string"},"example":{"firstName":"John","lastName":"Doe"}},{"name":"verificationUrl","in":"query","description":"The URL (sans token) the user needs to go in case it needs to verify the created profile (verification depends on tenant)","schema":{"type":"string"},"example":"verificationUrl"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592715d4d4c650e226b03b62"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/update":{"post":{"security":[],"tags":["profile"],"summary":"Update Profile","operationId":"updateProfile","description":"Updates the profile’s info.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"query","description":"The profile's id.","schema":{"type":"string"},"example":"592887d7d4c650213cc2f400"},{"name":"username","in":"query","description":"The new username for the profile.","required":true,"schema":{"type":"string"},"example":"john.doe"},{"name":"password","in":"query","description":"The new password for the profile.","schema":{"type":"string"},"example":"passw0rd"},{"name":"email","in":"query","description":"The new email for the profile.","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"},{"name":"enabled","in":"query","description":"If the profile should be enabled or not.","required":true,"schema":{"type":"string"},"example":false},{"name":"role","in":"query","description":"The new roles for the profile.","schema":{"type":"string"},"example":false},{"name":"attributes","in":"query","description":"The attributes to update (specify a JSON string)","schema":{"type":"string"},"example":{"firstName":"John","lastName":"Doe"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe"},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/verify":{"post":{"security":[],"tags":["profile"],"summary":"Verify Profile","operationId":"verifyProfile","description":"Sets the profile as verified if the verification token is valid.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"verificationTokenId","in":"query","description":"The verification token ID.","schema":{"type":"string"},"example":"055d58c4-fabb-44da-96eb-261e24e1d0c9"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/enable":{"post":{"security":[],"tags":["profile"],"summary":"Enable Profile","operationId":"enableProfile","description":"Enables a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/disable":{"post":{"security":[],"tags":["profile"],"summary":"Disable Profile","operationId":"disableProfile","description":"Disables a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/roles/add":{"post":{"security":[],"tags":["profile"],"summary":"Add Roles","operationId":"addRoles","description":"Assign roles to a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"roles","in":"query","description":"The roles to assign","schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"592715d4d4c650e226b03b62"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/roles/remove":{"post":{"security":[],"tags":["profile"],"summary":"Remove Roles","operationId":"removeRoles","description":"Remove assigned roles from a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"roles","in":"query","description":"The roles to remove","schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592715d4d4c650e226b03b62"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attributes":{"get":{"security":[],"tags":["profile"],"summary":"Get Attributes","operationId":"getAttributes","description":"Returns the attributes of a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"firstName":"John","lastName":"Doe"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attributes/update":{"post":{"security":[],"tags":["profile"],"summary":"Update Attributes","operationId":"updateAttributes","description":"Updates the attributes of a profile. <br><br> <i>NOTE:</i> <i>The specified attributes will be merged with existing attributes.</i>","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"requestBody":{"description":"The attribute(s) to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"avatarLink":"/static-assets/images/avatar.png"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe","avatarLink":"/static-assets/images/avatar.png"},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attributes/remove":{"post":{"security":[],"tags":["profile"],"summary":"Remove Attributes","operationId":"removeAttributes","description":"Removes a list of attributes of a profile","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesName","in":"query","description":"The name of the attributes to remove","schema":{"type":"string"},"example":"avatarLink"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"requestBody":{"description":"The attribute(s) to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"avatarLink":"/static-assets/images/avatar.png"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe"},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/delete":{"post":{"security":[],"tags":["profile"],"summary":"Delete Profile","operationId":"deleteProfile","description":"Deletes a profile","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/one_by_query":{"post":{"security":[],"tags":["profile"],"summary":"Get Profile By Query","operationId":"getProfileByQuery","description":"Returns the single profile that matches the specified query","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"query","in":"query","description":"The Mongo query used to search for the profiles <br><br> <b><i>Warning:</i></b> The query must not contain the <i>$where</i> operator, the tenant's name (already specified) or any non-readable attribute by the application","schema":{"type":"string"},"example":"%7B%20%22username%22%3A%20%22john.doe%22%20%7D"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile","operationId":"getProfile","description":"Returns the profile for a specified ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_username":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile By Username","operationId":"getProfileByUsername","description":"Returns the user for the specified tenant and username.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"username","in":"query","description":"The profile's username","required":true,"schema":{"type":"string"},"example":"john.doe"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_ticket":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile By Ticket","operationId":"getProfileByTicket","description":"Returns the profile for the specified ticket.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"ticketId","in":"query","description":"The ID ticket of the authenticated profile","required":true,"schema":{"type":"string"},"example":"592887d7d4c650213cc2f400"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/count":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Count","operationId":"getProfileCount","description":"Returns the number of profiles for the specified tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"},"example":1}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/count_by_query":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Count By Query","operationId":"getProfileCountByQuery","description":"Returns the number of profiles that match the query for the specified tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"query","in":"query","description":"The Mongo query used to search for the profiles. <br><br> <b><i>Warning:</i></b> The query must not contain the <i>$where</i> operator, the tenant's name (already specified) or any non-readable attribute by the application","schema":{"type":"string"},"example":"%7B%20%22username%22%3A%20%22john.doe%22%20%7D"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"},"example":1}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_query":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Query","operationId":"getProfilesByQuery","description":"Returns the profiles that match the specified query.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"query","in":"query","description":"The Mongo query used to search for the profiles. <br><br> <b><i>Warning:</i></b> The query must not contain the <i>$where</i> operator, the tenant's name (already specified) or any non-readable attribute by the application","schema":{"type":"string"},"example":"%7B%20%22username%22%3A%20%22john.doe%22%20%7D"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"start","in":"query","description":"From the entire list of results, the position where the actual results should start (useful for pagination)","schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of profiles to return","schema":{"type":"string"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_ids":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Ids","operationId":"getProfilesByIds","description":"Returns a list of profiles for the specified IDs.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"query","description":"The IDs of the profiles to look for","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc,59284659d4c650213cc2f3ff"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/range":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Range","operationId":"getProfilesByRange","description":"Returns a range of profiles for the specified tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"start","in":"query","description":"From the entire list of results, the position where the actual results should start (useful for pagination)","schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of profiles to return","schema":{"type":"string"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_role":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Role","operationId":"getProfilesByRole","description":"Returns a list of profiles for a specific role and tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"role","in":"query","description":"The role's name","required":true,"schema":{"type":"string"},"example":"APP_TEST"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_existing_attribute":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Attribute Value","operationId":"getProfilesByAttributeValue","description":"Returns the list of profiles that have the given attribute with the given value.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"attributeName","in":"query","description":"The name of the attribute the profiles must have","required":true,"schema":{"type":"string"},"example":"lastName"},{"name":"attributeValue","in":"query","description":"The value of the attribute the profiles must have","required":true,"schema":{"type":"string"},"example":"Doe"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe"},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/reset_password":{"post":{"security":[],"tags":["profile"],"summary":"Reset Password","operationId":"resetPassword","description":"Sends an email to the profile’s user to indicate that the password needs to be reset.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"},{"name":"resetPasswordUrl","in":"query","description":"The base URL to use to build the final URL the profile will use to reset their password","required":true,"schema":{"type":"string"},"example":"http://example.com"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"59284659d4c650213cc2f3fc"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/change_password":{"post":{"security":[],"tags":["profile"],"summary":"Change Password","operationId":"changePassword","description":"Resets a profile’s password.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"resetTokenId","in":"query","description":"The reset token ID","required":true,"schema":{"type":"string"},"example":"a2be0e86-7c71-4edf-aed9-6b00c0c60c33"},{"name":"newPassword","in":"query","description":"The new password","required":true,"schema":{"type":"string"},"example":"test123"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"59284659d4c650213cc2f3fc"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/verification_token/create":{"post":{"security":[],"tags":["profile"],"summary":"Create Verification Token","operationId":"createVerificationToken","description":"Creates a token that can be sent to the user in an email as a link.<br><br><i>Note:</i><br>After the user clicks the link, the token then can be passed to <b><i>/verify</i></b> or <b><i>/change_password</i></b> to verify user requesting the token.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile ID of the user","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tenant":{"type":"string"},"profileId":{"type":"string"},"timestamp":{"type":"string"},"id":{"type":"string"}}},"example":{"tenant":"sample-tenant","profileId":"592715d4d4c650e226b03b62","timestamp":1495746285875,"id":"055d58c4-fabb-44da-96eb-261e24e1d0c9"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/verification_token/{id}":{"get":{"security":[],"tags":["profile"],"summary":"Get Verification Token","operationId":"getVerificationToken","description":"Returns the verification token that corresponds to the given ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The token ID","required":true,"schema":{"type":"string"},"example":"de60f56d-3a4b-4dec-b798-fb22b2964c14"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tenant":{"type":"string"},"profileId":{"type":"string"},"timestamp":{"type":"string"},"id":{"type":"string"}}},"example":{"tenant":"sample-tenant","profileId":"592715d4d4c650e226b03b62","timestamp":1495746285875,"id":"de60f56d-3a4b-4dec-b798-fb22b2964c14"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/verification_token/{id}/delete":{"post":{"security":[],"tags":["profile"],"summary":"Delete Verification Token","operationId":"deleteVerificationToken","description":"Deletes a verification token when it’s not needed anymore.<br><br><i>Note:</i><br>Not necessary to call if <b><i>/verify</i></b> or <b><i>/change_password</i></b> were called, since they already delete the token.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The token ID","required":true,"schema":{"type":"string"},"example":"de60f56d-3a4b-4dec-b798-fb22b2964c14"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/uploadAttachment":{"post":{"security":[],"tags":["profile"],"summary":"Upload Profile Attachment","operationId":"uploadProfileAttachment","description":"Upload a attachment to the specified profile.<br><br><i>Note:</i><br>If the mime type of the attachment is not on the valid list will fail.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"description":"File to be uploaded.","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttachment"},"example":{"md5":"498a1e16be56873ef53a1a61295d1781","contentType":"image/jpeg","fileSize":"22.6 KB","fileName":"picture1","fileSizeBytes":23193,"id":"59285cd3d4c650213cc2f3fd"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attachment/{attachmentName}":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Attachment","operationId":"getProfileAttachment","description":"Gets the requested attachment of the given profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"},{"name":"attachmentName","in":"path","description":"Name of the attachment to get","required":true,"schema":{"type":"string"},"example":"picture1"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"example":"image/jpeg;charset=UTF-8"},"Content-Length":{"schema":{"type":"integer","format":"int32"},"example":23193}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}},"text/*":{"schema":{"type":"string","format":"binary"}},"application/*":{"schema":{"type":"string","format":"binary"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attachments":{"get":{"security":[],"tags":["profile"],"summary":"Get All Profile Attachments","operationId":"getAllProfileAttachments","description":"Gets all attachments for the given profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttachment"},"example":[{"md5":"498a1e16be56873ef53a1a61295d1781","contentType":"image/jpeg","fileSize":"22.6 KB","fileName":"picture1","fileSizeBytes":23193,"id":"59285cd3d4c650213cc2f3fd"}]}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attachment/{attachmentName}/details":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Attachment Details","operationId":"getProfileAttachmentDetails","description":"Returns the details for a given attachment in a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"},{"name":"attachmentName","in":"path","description":"Name of the attachment to get","required":true,"schema":{"type":"string"},"example":"picture1"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttachment"},"example":{"md5":"498a1e16be56873ef53a1a61295d1781","contentType":"image/jpeg","fileSize":"22.6 KB","fileName":"picture1","fileSizeBytes":23193,"id":"59285cd3d4c650213cc2f3fd"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/authenticate":{"post":{"security":[],"tags":["authentication"],"summary":"Authenticate","operationId":"authenticate","description":"Authenticates the user, and returns a ticket identifying the authentication.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"default"},{"name":"username","in":"query","description":"The username","required":true,"schema":{"type":"string"},"example":"admin"},{"name":"password","in":"query","description":"The password","required":true,"schema":{"type":"string"},"example":"admin"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"59284659d4c650213cc2f3fc"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/ticket/create":{"post":{"security":[],"tags":["authentication"],"summary":"Create Ticket","operationId":"createTicket","description":"Creates a new ticket for the specified profile.<br><br><i>Note:</i><br>This method should only be used when actual authentication is done through other means (like when authenticating through Facebook or Twitter) different than profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"profileId","in":"query","description":"The ID of the profile","required":true,"schema":{"type":"string"},"example":"5925a68def86951f895cf497"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"7f036af3-1ab9-4791-b615-ecaece3f0010"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/ticket/{ticketId}":{"get":{"security":[],"tags":["authentication"],"summary":"Get Ticket","operationId":"getTicket","description":"Returns the ticket info for the given ticket ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"ticketId","in":"path","description":"The ID of the ticket","required":true,"schema":{"type":"string"},"example":"b4d44030-d0af-11e3-9c1a-0800200c9a66"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"2e911e0b-ac47-423e-9174-4e8896f1b387"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/ticket/{ticketId}/invalidate":{"get":{"security":[],"tags":["authentication"],"summary":"Invalidate Ticket","operationId":"invalidateTicket","description":"Invalidates the given ticket.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"ticketId","in":"path","description":"The ID of the ticket","required":true,"schema":{"type":"string"},"example":"b4d44030-d0af-11e3-9c1a-0800200c9a66"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"2e911e0b-ac47-423e-9174-4e8896f1b387"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/create":{"post":{"security":[],"tags":["authentication"],"summary":"Create Persistent Login","operationId":"createPersistentLogin","description":"Creates a persistent login, used for remember me functionality.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"profileId","in":"query","description":"The ID of the profile","required":true,"schema":{"type":"string"},"example":"5925a68def86951f895cf497"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","timestamp":1495733716728,"id":"2e911e0b-ac47-423e-9174-4e8896f1b387","token":"adf88dca-4960-474c-be63-c8c5e3bedaa7"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/{id}":{"get":{"security":[],"tags":["authentication"],"summary":"Get Persistent Login","operationId":"getPersistentLogin","description":"Returns the persistent login info for the given ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The ID of the persistent login","required":true,"schema":{"type":"string"},"example":"b68c0013-d7b2-4004-8463-d7ba03e15d94"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","timestamp":1495733716728,"id":"b68c0013-d7b2-4004-8463-d7ba03e15d94","token":"adf88dca-4960-474c-be63-c8c5e3bedaa7"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/{id}/refresh_token":{"post":{"security":[],"tags":["authentication"],"summary":"Refresh Persistent Login","operationId":"refreshPersistentLogin","description":"Refreshes the token of the specified persistent login.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The ID of the persistent login","required":true,"schema":{"type":"string"},"example":"b68c0013-d7b2-4004-8463-d7ba03e15d94"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","timestamp":1495733716728,"id":"b68c0013-d7b2-4004-8463-d7ba03e15d94","token":"f390e222-c844-44a2-ad38-afa471527101"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/{id}/delete":{"post":{"security":[],"tags":["authentication"],"summary":"Delete Persistent Login","operationId":"deletePersistentLogin","description":"Deletes a persistent login.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The ID of the persistent login","required":true,"schema":{"type":"string"},"example":"b68c0013-d7b2-4004-8463-d7ba03e15d94"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/memory":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Memory Stats","operationId":"getMemoryStats","description":"Returns the Crafter Profile JVM memory details.","parameters":[{"name":"token","in":"query","description":"The authorization token.","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringJVMMemoryStats"},"example":{"totalJvmMemory":2017984512,"freeJvmMemory":1113921056,"maxJvmMemory":3817865216,"totalOsMemory":17179869184,"freeOsMemory":2669301760,"totalSwapMemory":2147483648,"freeSwapMemory":1026555904}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/status":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Status","operationId":"getStatus","description":"Returns the Crafter Profile JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token.","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatus"},"example":{"uptime":4801,"startup":"2019-03-07T21:29:11.049Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/version":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Version","operationId":"getVersion","description":"Returns the Crafter Profile JVM version details.","parameters":[{"name":"token","in":"query","description":"The authorization token.","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatus"},"example":{"packageName":"Crafter Profile","packageVersion":"3.1.0-SNAPSHOT","packageBuild":"a68f1ff7ad84d5ecbeaa008f392e4cef0ca02f41","packageBuildDate":"2019-03-07T21:03:05.422Z","osName":"Mac OS X","osVersion":"10.13.6","osArch":"x86_64","javaVersion":"1.8","javaVendor":"Oracle Corporation","javaVm":"Java HotSpot(TM) 64-Bit Server VM"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"AccessToken":{"type":"object","properties":{"application":{"type":"string"},"master":{"type":"boolean"},"tenantPermissions":{"type":"array","items":{"type":"object","properties":{"allowedActions":{"type":"array"},"tenant":{"type":"string"}}}},"expiresOn":{"type":"integer"},"id":{"type":"string"}}},"ProfileTenantAttribute":{"type":"object","properties":{"name":{"type":"string"},"metadata":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string"},"displayOrder":{"type":"number","format":"float"}}},"permissions":{"type":"array","items":{"type":"object","properties":{"application":{"type":"string"},"allowedActions":{"type":"array","items":{"type":"string"}}}}},"defaultValue":{"type":"object"}}},"ProfileTenant":{"type":"object","properties":{"name":{"type":"string"},"verifyNewProfiles":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"availableRoles":{"type":"array","items":{"type":"string"}},"attributeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenantAttribute"}},"id":{"type":"string"}}},"Profile":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string"},"verified":{"type":"boolean"},"enabled":{"type":"boolean"},"createdOn":{"type":"number"},"lastModified":{"type":"number"},"tenant":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"$ref":"#/components/schemas/ProfileAttributes"},"id":{"type":"string"}}},"UserProfile":{"type":"object","properties":{"age":{"type":"integer"},"username":{"type":"string"},"lastname":{"type":"string"}}},"ProfileAttributes":{"type":"object","description":"Object containing attributes for the profile","additionalProperties":{"type":"string"}},"ProfileAttachment":{"type":"object","properties":{"md5":{"type":"string"},"contentType":{"type":"string"},"fileSize":{"type":"string"},"fileName":{"type":"string"},"fileSizeBytes":{"type":"integer","format":"int32"},"id":{"type":"string"}}},"AuthenticationTicket":{"type":"object","properties":{"tenant":{"type":"string"},"profileId":{"type":"string"},"lastRequestTime":{"type":"string"},"id":{"type":"string"},"token":{"type":"string"},"timestamp":{"type":"string"}}},"MonitoringJVMMemoryStats":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","format":"int64"},"freeJvmMemory":{"type":"integer","format":"int64"},"maxJvmMemory":{"type":"integer","format":"int64"},"totalOSMemory":{"type":"integer","format":"int64"},"freeOSMemory":{"type":"integer","format":"int64"},"totalSwapMemory":{"type":"integer","format":"int64"},"freeSwapMemory":{"type":"integer","format":"int64"}}},"MonitoringStatus":{"type":"object","properties":{"uptime":{"type":"integer","format":"int32"},"startup":{"type":"string","format":"date-time"}}},"MonitoringJVMVersion":{"type":"object","properties":{"packageName":{"type":"string"},"packageVersion":{"type":"string"},"packageBuild":{"type":"string"},"packageBuildDate":{"type":"string","format":"date-time"},"osName":{"type":"string"},"osVersion":{"type":"string"},"osArch":{"type":"string"},"javaVersion":{"type":"string"},"javaVendor":{"type":"string"},"javaVm":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"access_token":{"value":{"errorCode":"ACTION_DENIED","message":"Current subject does not have permission to execute global action \"CREATE_TOKEN\""}},"tenant":{"value":{"errorCode":"TENANT_EXISTS","message":"The tenant \"sample-tenant\" already exists"}},"profile":{"value":{"errorCode":"PROFILE_EXISTS","message":"A profile with name \"john.doe\" already exists"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"tenant":{"value":{"errorCode":"NO_SUCH_TENANT","message":"No tenant with name ‘sample-tenant’ found"}},"monitoring":{"value":{"errorCode":"OTHER","message":"”Required String parameter ‘token’ is not present”"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"authentication":{"value":{"errorCode":"BAD_CREDENTIALS","message":"Invalid username and/or password"}},"monitoring":{"value":{"errorCode":"ACCESS_DENIED","message":"”Management authorization failed, invalid token.”"}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"accessToken":{"value":{"errorCode":"ACTION_DENIED","message":"Current subject does not have permission to execute global action \\\"CREATE_TOKEN\\\""}},"profile":{"value":{"errorCode":"DISABLED_PROFILE","message":"Profile \\\"59284659d4c650213cc2f3fc\\\" of tenant \\\"sample-tenant\\\" is disabled"}},"authentication":{"value":{"errorCode":"NO_SUCH_ACCESS_TOKEN_ID","message":"No access token found for ID \\\"e8f5170c-877b-416f-b70f-4b09772f8e2d\\\""}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}}},"examples":{"userProfileExample":{"value":{"age":30,"username":"john","lastname":"doe"}}}}}},"searchIndex":{"store":["tag/access_token","tag/access_token/operation/createAccessToken","tag/access_token/operation/getAccessToken","tag/access_token/operation/getAllAccessToken","tag/access_token/operation/deleteAccessToken","tag/tenant","tag/tenant/operation/createTenant","tag/tenant/operation/getTenant","tag/tenant/operation/updateTenant","tag/tenant/operation/deleteTenant","tag/tenant/operation/countTenants","tag/tenant/operation/getAllTenants","tag/tenant/operation/verifyNewProfiles","tag/tenant/operation/addRoles","tag/tenant/operation/removeRoles","tag/tenant/operation/addAttributes","tag/tenant/operation/updateAttributes","tag/tenant/operation/removeAttributes","tag/profile","tag/profile/operation/createProfile","tag/profile/operation/updateProfile","tag/profile/operation/verifyProfile","tag/profile/operation/enableProfile","tag/profile/operation/disableProfile","tag/profile/operation/addRoles","tag/profile/operation/removeRoles","tag/profile/operation/getAttributes","tag/profile/operation/updateAttributes","tag/profile/operation/removeAttributes","tag/profile/operation/deleteProfile","tag/profile/operation/getProfileByQuery","tag/profile/operation/getProfile","tag/profile/operation/getProfileByUsername","tag/profile/operation/getProfileByTicket","tag/profile/operation/getProfileCount","tag/profile/operation/getProfileCountByQuery","tag/profile/operation/getProfilesByQuery","tag/profile/operation/getProfilesByIds","tag/profile/operation/getProfilesByRange","tag/profile/operation/getProfilesByRole","tag/profile/operation/getProfilesByAttributeValue","tag/profile/operation/resetPassword","tag/profile/operation/changePassword","tag/profile/operation/createVerificationToken","tag/profile/operation/getVerificationToken","tag/profile/operation/deleteVerificationToken","tag/profile/operation/uploadProfileAttachment","tag/profile/operation/getProfileAttachment","tag/profile/operation/getAllProfileAttachments","tag/profile/operation/getProfileAttachmentDetails","tag/authentication","tag/authentication/operation/authenticate","tag/authentication/operation/createTicket","tag/authentication/operation/getTicket","tag/authentication/operation/invalidateTicket","tag/authentication/operation/createPersistentLogin","tag/authentication/operation/getPersistentLogin","tag/authentication/operation/refreshPersistentLogin","tag/authentication/operation/deletePersistentLogin","tag/monitoring","tag/monitoring/operation/getMemoryStats","tag/monitoring/operation/getStatus","tag/monitoring/operation/getVersion"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.709]],["description/0",[1,2.401,2,1.632,3,3.658]],["title/1",[1,1.577,2,1.072,4,1.35]],["description/1",[1,2.051,2,1.394,4,1.756,5,2.639,6,4.036]],["title/2",[1,1.901,2,1.292]],["description/2",[1,2.051,2,1.394,7,4.036,8,3.125,9,4.036]],["title/3",[1,1.901,2,1.292]],["description/3",[1,2.212,2,1.504,10,3.761,11,4.353]],["title/4",[1,1.577,2,1.072,12,1.494]],["description/4",[1,2.212,2,1.504,12,2.096,13,4.353]],["title/5",[14,1.106]],["description/5",[3,4,14,1.214]],["title/6",[4,1.628,14,0.879]],["description/6",[4,1.894,14,1.023,15,1.645,16,4.353]],["title/7",[14,1.106]],["description/7",[14,1.11,17,1.261,18,4.725]],["title/8",[14,0.879,19,2.012]],["description/8",[14,1.023,15,1.645,19,2.341,20,4.353]],["title/9",[12,1.802,14,0.879]],["description/9",[12,2.275,14,1.11,21,4.725]],["title/10",[14,0.879,22,2.897]],["description/10",[14,0.948,17,1.077,23,4.036,24,3.125,25,4.036]],["title/11",[14,1.106]],["description/11",[14,1.023,17,1.162,26,2.653,27,4.353]],["title/12",[5,2.029,28,2.029,29,0.164]],["description/12",[5,2.303,14,0.827,28,2.303,29,0.186,30,3.043,31,1.115,32,3.522]],["title/13",[33,2.446,34,1.802]],["description/13",[14,0.884,15,1.421,31,1.191,33,2.459,34,1.811,35,3.762]],["title/14",[34,1.802,36,2.012]],["description/14",[14,0.884,15,1.421,31,1.191,34,1.811,36,2.023,37,3.762]],["title/15",[33,2.446,38,1.48]],["description/15",[14,0.827,15,1.331,31,1.115,33,2.303,38,1.393,39,2.727,40,3.522]],["title/16",[19,2.012,38,1.48]],["description/16",[14,0.827,15,1.331,19,1.894,31,1.115,38,1.393,39,2.727,41,3.522]],["title/17",[36,2.012,38,1.48]],["description/17",[14,0.827,15,1.331,31,1.115,36,1.894,38,1.393,39,2.727,42,3.522]],["title/18",[29,0.248]],["description/18",[3,4,29,0.273]],["title/19",[4,1.628,29,0.197]],["description/19",[4,1.637,5,2.459,8,2.912,14,0.884,29,0.198,43,3.762]],["title/20",[19,2.012,29,0.197]],["description/20",[19,2.341,44,3.371,45,3.371,46,4.353]],["title/21",[28,2.446,29,0.197]],["description/21",[2,1.217,28,2.303,29,0.186,30,3.043,47,2.146,48,3.043,49,3.522]],["title/22",[29,0.197,50,3.232]],["description/22",[29,0.249,50,4.082,51,4.725]],["title/23",[29,0.197,52,3.232]],["description/23",[29,0.249,52,4.082,53,4.725]],["title/24",[33,2.446,34,1.802]],["description/24",[29,0.23,34,2.096,54,3.761,55,4.353]],["title/25",[34,1.802,36,2.012]],["description/25",[29,0.213,34,1.944,36,2.171,54,3.487,56,4.036]],["title/26",[38,1.863]],["description/26",[17,1.162,29,0.23,38,1.722,57,4.353]],["title/27",[19,2.012,38,1.48]],["description/27",[10,2.308,19,1.437,29,0.141,31,0.846,38,1.597,58,2.672,59,2.672,60,2.672,61,2.672,62,2.672,63,2.672]],["title/28",[36,2.012,38,1.48]],["description/28",[26,2.459,29,0.213,36,2.171,38,1.596,64,4.036]],["title/29",[12,1.802,29,0.197]],["description/29",[12,2.275,29,0.249,65,4.725]],["title/30",[29,0.197,66,2.28]],["description/30",[17,0.94,29,0.186,31,1.115,66,2.146,67,3.522,68,2.727,69,3.522]],["title/31",[29,0.248]],["description/31",[17,1.077,29,0.213,31,1.278,70,2.459,71,4.036]],["title/32",[29,0.197,72,3.232]],["description/32",[14,0.884,17,1.004,31,1.191,72,3.25,73,2.661,74,3.762]],["title/33",[29,0.197,75,1.901]],["description/33",[17,1.077,29,0.213,31,1.278,75,2.051,76,4.036]],["title/34",[22,2.897,29,0.197]],["description/34",[14,0.884,17,1.004,24,2.912,29,0.198,31,1.191,77,3.762]],["title/35",[22,2.403,29,0.164,66,1.891]],["description/35",[14,0.778,17,0.884,24,2.564,29,0.175,31,1.049,66,2.018,68,2.564,78,3.311]],["title/36",[29,0.197,66,2.28]],["description/36",[17,1.004,29,0.198,31,1.191,66,2.292,68,2.912,79,3.762]],["title/37",[29,0.197,70,2.28]],["description/37",[17,1.004,26,2.292,29,0.198,31,1.191,70,2.292,80,3.762]],["title/38",[29,0.197,81,3.232]],["description/38",[14,0.884,17,1.004,29,0.198,31,1.191,81,3.25,82,3.762]],["title/39",[29,0.197,34,1.802]],["description/39",[8,2.727,14,0.827,17,0.94,26,2.146,29,0.186,34,1.696,83,3.522]],["title/40",[29,0.164,38,1.228,84,2.681]],["description/40",[15,1.786,17,0.884,26,2.018,29,0.175,38,1.31,84,2.861,85,3.311]],["title/41",[86,2.897,87,2.646]],["description/41",[44,2.419,73,2.21,86,2.419,87,2.21,88,3.124,89,2.699,90,3.124,91,2.699,92,3.124]],["title/42",[87,2.646,93,3.741]],["description/42",[44,3.371,86,3.371,87,3.079,94,4.353]],["title/43",[2,1.072,4,1.35,47,1.891]],["description/43",[2,1.43,4,0.901,28,1.355,73,2.927,89,1.79,95,2.072,96,2.072,97,2.072,98,2.072,99,2.072,100,1.79,101,1.79,102,1.79,103,2.072]],["title/44",[2,1.292,47,2.28]],["description/44",[2,1.217,15,1.331,17,0.94,47,2.146,70,2.146,104,3.522,105,3.522]],["title/45",[2,1.072,12,1.494,47,1.891]],["description/45",[2,1.257,12,1.752,47,1.422,91,2.016,100,2.016,101,2.016,106,2.334,107,2.334,108,2.334,109,3.639,110,2.334,111,2.334]],["title/46",[29,0.164,112,2.681,113,1.669]],["description/46",[26,1.711,31,0.889,48,2.425,112,2.425,113,2.254,114,2.807,115,2.807,116,2.807,117,2.807,118,2.807]],["title/47",[29,0.197,113,2.012]],["description/47",[15,1.421,29,0.198,102,3.25,113,2.023,119,3.25,120,3.762]],["title/48",[29,0.197,113,2.012]],["description/48",[15,1.525,29,0.213,113,2.171,119,3.487,121,4.036]],["title/49",[29,0.164,113,1.669,122,2.029]],["description/49",[15,1.421,17,1.004,29,0.198,113,2.023,122,2.459,123,3.762]],["title/50",[124,3.079]],["description/50",[124,3.726]],["title/51",[124,3.079]],["description/51",[17,0.94,73,2.491,75,1.79,124,3.229,125,3.522,126,3.522]],["title/52",[4,1.628,75,1.901]],["description/52",[4,0.869,5,1.306,29,0.105,31,0.632,75,1.015,124,2.103,127,1.997,128,1.997,129,1.725,130,1.997,131,1.997,132,3.216,133,1.997,134,1.997,135,1.997,136,1.997,137,1.997]],["title/53",[75,2.393]],["description/53",[15,1.331,17,0.94,45,2.727,70,2.146,75,2.51,138,3.522]],["title/54",[75,1.901,139,3.232]],["description/54",[15,1.645,75,2.212,139,3.761,140,4.353]],["title/55",[4,1.35,141,1.669,142,1.669]],["description/55",[4,1.533,129,3.043,141,1.894,142,1.894,143,3.522,144,3.522,145,3.522]],["title/56",[141,2.012,142,2.012]],["description/56",[15,1.331,17,0.94,45,2.727,70,2.146,141,1.894,142,1.894,146,3.522]],["title/57",[141,1.669,142,1.669,147,2.681]],["description/57",[2,1.299,31,1.191,141,2.023,142,2.023,147,3.25,148,3.762]],["title/58",[12,1.494,141,1.669,142,1.669]],["description/58",[12,2.096,141,2.341,142,2.341,149,4.353]],["title/59",[150,4.068]],["description/59",[150,4.463,151,5.166]],["title/60",[152,3.232,153,3.741]],["description/60",[17,0.94,29,0.186,122,2.303,152,3.043,154,2.727,155,2.727,156,3.522]],["title/61",[157,4.068]],["description/61",[17,0.94,29,0.186,122,2.303,154,2.727,155,2.727,157,3.043,158,3.522]],["title/62",[159,4.068]],["description/62",[17,0.94,29,0.186,122,2.303,154,2.727,155,2.727,159,3.043,160,3.522]]],"invertedIndex":[["access",{"_index":1,"title":{"1":{},"2":{},"3":{},"4":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{}}}],["access_token",{"_index":0,"title":{"0":{}},"description":{}}],["actual",{"_index":130,"title":{},"description":{"52":{}}}],["add",{"_index":33,"title":{"13":{},"15":{},"24":{}},"description":{"13":{},"15":{}}}],["alreadi",{"_index":110,"title":{},"description":{"45":{}}}],["anymore.<br><br><i>note:</i><br>not",{"_index":107,"title":{},"description":{"45":{}}}],["api/1/access_token/al",{"_index":11,"title":{},"description":{"3":{}}}],["api/1/access_token/cr",{"_index":6,"title":{},"description":{"1":{}}}],["api/1/access_token/{id",{"_index":9,"title":{},"description":{"2":{}}}],["api/1/access_token/{id}/delet",{"_index":13,"title":{},"description":{"4":{}}}],["api/1/authentication/authent",{"_index":126,"title":{},"description":{"51":{}}}],["api/1/authentication/persistent_login/cr",{"_index":145,"title":{},"description":{"55":{}}}],["api/1/authentication/persistent_login/{id",{"_index":146,"title":{},"description":{"56":{}}}],["api/1/authentication/persistent_login/{id}/delet",{"_index":149,"title":{},"description":{"58":{}}}],["api/1/authentication/persistent_login/{id}/refresh_token",{"_index":148,"title":{},"description":{"57":{}}}],["api/1/authentication/ticket/cr",{"_index":137,"title":{},"description":{"52":{}}}],["api/1/authentication/ticket/{ticketid",{"_index":138,"title":{},"description":{"53":{}}}],["api/1/authentication/ticket/{ticketid}/invalid",{"_index":140,"title":{},"description":{"54":{}}}],["api/1/monitoring/memori",{"_index":156,"title":{},"description":{"60":{}}}],["api/1/monitoring/statu",{"_index":158,"title":{},"description":{"61":{}}}],["api/1/monitoring/vers",{"_index":160,"title":{},"description":{"62":{}}}],["api/1/profile/by_existing_attribut",{"_index":85,"title":{},"description":{"40":{}}}],["api/1/profile/by_id",{"_index":80,"title":{},"description":{"37":{}}}],["api/1/profile/by_queri",{"_index":79,"title":{},"description":{"36":{}}}],["api/1/profile/by_rol",{"_index":83,"title":{},"description":{"39":{}}}],["api/1/profile/by_ticket",{"_index":76,"title":{},"description":{"33":{}}}],["api/1/profile/by_usernam",{"_index":74,"title":{},"description":{"32":{}}}],["api/1/profile/change_password",{"_index":94,"title":{},"description":{"42":{}}}],["api/1/profile/count",{"_index":77,"title":{},"description":{"34":{}}}],["api/1/profile/count_by_queri",{"_index":78,"title":{},"description":{"35":{}}}],["api/1/profile/cr",{"_index":43,"title":{},"description":{"19":{}}}],["api/1/profile/one_by_queri",{"_index":69,"title":{},"description":{"30":{}}}],["api/1/profile/rang",{"_index":82,"title":{},"description":{"38":{}}}],["api/1/profile/upd",{"_index":46,"title":{},"description":{"20":{}}}],["api/1/profile/verifi",{"_index":49,"title":{},"description":{"21":{}}}],["api/1/profile/verification_token/{id",{"_index":105,"title":{},"description":{"44":{}}}],["api/1/profile/verification_token/{id}/delet",{"_index":111,"title":{},"description":{"45":{}}}],["api/1/profile/{id",{"_index":71,"title":{},"description":{"31":{}}}],["api/1/profile/{id}/attach",{"_index":121,"title":{},"description":{"48":{}}}],["api/1/profile/{id}/attachment/{attachmentnam",{"_index":120,"title":{},"description":{"47":{}}}],["api/1/profile/{id}/attachment/{attachmentname}/detail",{"_index":123,"title":{},"description":{"49":{}}}],["api/1/profile/{id}/attribut",{"_index":57,"title":{},"description":{"26":{}}}],["api/1/profile/{id}/attributes/remov",{"_index":64,"title":{},"description":{"28":{}}}],["api/1/profile/{id}/attributes/upd",{"_index":63,"title":{},"description":{"27":{}}}],["api/1/profile/{id}/delet",{"_index":65,"title":{},"description":{"29":{}}}],["api/1/profile/{id}/dis",{"_index":53,"title":{},"description":{"23":{}}}],["api/1/profile/{id}/en",{"_index":51,"title":{},"description":{"22":{}}}],["api/1/profile/{id}/reset_password",{"_index":92,"title":{},"description":{"41":{}}}],["api/1/profile/{id}/roles/add",{"_index":55,"title":{},"description":{"24":{}}}],["api/1/profile/{id}/roles/remov",{"_index":56,"title":{},"description":{"25":{}}}],["api/1/profile/{id}/uploadattach",{"_index":118,"title":{},"description":{"46":{}}}],["api/1/profile/{id}/verification_token/cr",{"_index":103,"title":{},"description":{"43":{}}}],["api/1/tenant/al",{"_index":27,"title":{},"description":{"11":{}}}],["api/1/tenant/count",{"_index":25,"title":{},"description":{"10":{}}}],["api/1/tenant/cr",{"_index":16,"title":{},"description":{"6":{}}}],["api/1/tenant/upd",{"_index":20,"title":{},"description":{"8":{}}}],["api/1/tenant/{nam",{"_index":18,"title":{},"description":{"7":{}}}],["api/1/tenant/{name}/attribute_definitions/add",{"_index":40,"title":{},"description":{"15":{}}}],["api/1/tenant/{name}/attribute_definitions/remov",{"_index":42,"title":{},"description":{"17":{}}}],["api/1/tenant/{name}/attribute_definitions/upd",{"_index":41,"title":{},"description":{"16":{}}}],["api/1/tenant/{name}/delet",{"_index":21,"title":{},"description":{"9":{}}}],["api/1/tenant/{name}/roles/add",{"_index":35,"title":{},"description":{"13":{}}}],["api/1/tenant/{name}/roles/remov",{"_index":37,"title":{},"description":{"14":{}}}],["api/1/tenant/{name}/verify_new_profil",{"_index":32,"title":{},"description":{"12":{}}}],["assign",{"_index":54,"title":{},"description":{"24":{},"25":{}}}],["attach",{"_index":113,"title":{"46":{},"47":{},"48":{},"49":{}},"description":{"46":{},"47":{},"48":{},"49":{}}}],["attribut",{"_index":38,"title":{"15":{},"16":{},"17":{},"26":{},"27":{},"28":{},"40":{}},"description":{"15":{},"16":{},"17":{},"26":{},"27":{},"28":{},"40":{}}}],["attributes.</i",{"_index":62,"title":{},"description":{"27":{}}}],["authent",{"_index":124,"title":{"50":{},"51":{}},"description":{"50":{},"51":{},"52":{}}}],["b><i>/change_password</i></b",{"_index":101,"title":{},"description":{"43":{},"45":{}}}],["b><i>/verify</i></b",{"_index":100,"title":{},"description":{"43":{},"45":{}}}],["br><br",{"_index":58,"title":{},"description":{"27":{}}}],["call",{"_index":109,"title":{},"description":{"45":{}}}],["chang",{"_index":93,"title":{"42":{}},"description":{}}],["click",{"_index":97,"title":{},"description":{"43":{}}}],["correspond",{"_index":104,"title":{},"description":{"44":{}}}],["count",{"_index":22,"title":{"10":{},"34":{},"35":{}},"description":{}}],["crafter",{"_index":154,"title":{},"description":{"60":{},"61":{},"62":{}}}],["creat",{"_index":4,"title":{"1":{},"6":{},"19":{},"43":{},"52":{},"55":{}},"description":{"1":{},"6":{},"19":{},"43":{},"52":{},"55":{}}}],["definit",{"_index":39,"title":{},"description":{"15":{},"16":{},"17":{}}}],["delet",{"_index":12,"title":{"4":{},"9":{},"29":{},"45":{},"58":{}},"description":{"4":{},"9":{},"29":{},"45":{},"58":{}}}],["detail",{"_index":122,"title":{"49":{}},"description":{"49":{},"60":{},"61":{},"62":{}}}],["differ",{"_index":136,"title":{},"description":{"52":{}}}],["disabl",{"_index":52,"title":{"23":{}},"description":{"23":{}}}],["done",{"_index":131,"title":{},"description":{"52":{}}}],["email",{"_index":89,"title":{},"description":{"41":{},"43":{}}}],["enabl",{"_index":50,"title":{"22":{}},"description":{"22":{}}}],["exist",{"_index":10,"title":{},"description":{"3":{},"27":{}}}],["facebook",{"_index":134,"title":{},"description":{"52":{}}}],["fail",{"_index":117,"title":{},"description":{"46":{}}}],["function",{"_index":144,"title":{},"description":{"55":{}}}],["get",{"_index":119,"title":{},"description":{"47":{},"48":{}}}],["given",{"_index":15,"title":{},"description":{"6":{},"8":{},"13":{},"14":{},"15":{},"16":{},"17":{},"40":{},"44":{},"47":{},"48":{},"49":{},"53":{},"54":{},"56":{}}}],["i>note:</i",{"_index":59,"title":{},"description":{"27":{}}}],["i>th",{"_index":60,"title":{},"description":{"27":{}}}],["id",{"_index":70,"title":{"37":{}},"description":{"31":{},"37":{},"44":{},"53":{},"56":{}}}],["identifi",{"_index":125,"title":{},"description":{"51":{}}}],["indic",{"_index":90,"title":{},"description":{"41":{}}}],["info",{"_index":45,"title":{},"description":{"20":{},"53":{},"56":{}}}],["inform",{"_index":7,"title":{},"description":{"2":{}}}],["invalid",{"_index":139,"title":{"54":{}},"description":{"54":{}}}],["it’",{"_index":106,"title":{},"description":{"45":{}}}],["jvm",{"_index":155,"title":{},"description":{"60":{},"61":{},"62":{}}}],["link",{"_index":98,"title":{},"description":{"43":{}}}],["link.<br><br><i>note:</i><br>aft",{"_index":96,"title":{},"description":{"43":{}}}],["list",{"_index":26,"title":{},"description":{"11":{},"28":{},"37":{},"39":{},"40":{},"46":{}}}],["login",{"_index":142,"title":{"55":{},"56":{},"57":{},"58":{}},"description":{"55":{},"56":{},"57":{},"58":{}}}],["manag",{"_index":3,"title":{},"description":{"0":{},"5":{},"18":{}}}],["match",{"_index":68,"title":{},"description":{"30":{},"35":{},"36":{}}}],["mean",{"_index":133,"title":{},"description":{"52":{}}}],["memori",{"_index":152,"title":{"60":{}},"description":{"60":{}}}],["merg",{"_index":61,"title":{},"description":{"27":{}}}],["method",{"_index":128,"title":{},"description":{"52":{}}}],["mime",{"_index":115,"title":{},"description":{"46":{}}}],["monitor",{"_index":150,"title":{"59":{}},"description":{"59":{}}}],["necessari",{"_index":108,"title":{},"description":{"45":{}}}],["need",{"_index":91,"title":{},"description":{"41":{},"45":{}}}],["new",{"_index":5,"title":{"12":{}},"description":{"1":{},"12":{},"19":{},"52":{}}}],["number",{"_index":24,"title":{},"description":{"10":{},"34":{},"35":{}}}],["oper",{"_index":151,"title":{},"description":{"59":{}}}],["pass",{"_index":99,"title":{},"description":{"43":{}}}],["password",{"_index":87,"title":{"41":{},"42":{}},"description":{"41":{},"42":{}}}],["persist",{"_index":141,"title":{"55":{},"56":{},"57":{},"58":{}},"description":{"55":{},"56":{},"57":{},"58":{}}}],["profil",{"_index":29,"title":{"12":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"46":{},"47":{},"48":{},"49":{}},"description":{"12":{},"18":{},"19":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"47":{},"48":{},"49":{},"52":{},"60":{},"61":{},"62":{}}}],["profile.<br><br><i>note:</i><br>if",{"_index":114,"title":{},"description":{"46":{}}}],["profile.<br><br><i>note:</i><br>thi",{"_index":127,"title":{},"description":{"52":{}}}],["profile’",{"_index":44,"title":{},"description":{"20":{},"41":{},"42":{}}}],["queri",{"_index":66,"title":{"30":{},"35":{},"36":{}},"description":{"30":{},"35":{},"36":{}}}],["rang",{"_index":81,"title":{"38":{}},"description":{"38":{}}}],["refresh",{"_index":147,"title":{"57":{}},"description":{"57":{}}}],["rememb",{"_index":143,"title":{},"description":{"55":{}}}],["remov",{"_index":36,"title":{"14":{},"17":{},"25":{},"28":{}},"description":{"14":{},"17":{},"25":{},"28":{}}}],["request",{"_index":102,"title":{},"description":{"43":{},"47":{}}}],["reset",{"_index":86,"title":{"41":{}},"description":{"41":{},"42":{}}}],["return",{"_index":17,"title":{},"description":{"7":{},"10":{},"11":{},"26":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"44":{},"49":{},"51":{},"53":{},"56":{},"60":{},"61":{},"62":{}}}],["role",{"_index":34,"title":{"13":{},"14":{},"24":{},"25":{},"39":{}},"description":{"13":{},"14":{},"24":{},"25":{},"39":{}}}],["send",{"_index":88,"title":{},"description":{"41":{}}}],["sent",{"_index":95,"title":{},"description":{"43":{}}}],["set",{"_index":30,"title":{},"description":{"12":{},"21":{}}}],["singl",{"_index":67,"title":{},"description":{"30":{}}}],["specif",{"_index":8,"title":{},"description":{"2":{},"19":{},"39":{}}}],["specifi",{"_index":31,"title":{},"description":{"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"27":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"46":{},"52":{},"57":{}}}],["stat",{"_index":153,"title":{"60":{}},"description":{}}],["statu",{"_index":157,"title":{"61":{}},"description":{"61":{}}}],["tenant",{"_index":14,"title":{"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{}},"description":{"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"19":{},"32":{},"34":{},"35":{},"38":{},"39":{}}}],["through",{"_index":132,"title":{},"description":{"52":{}}}],["ticket",{"_index":75,"title":{"33":{},"52":{},"53":{},"54":{}},"description":{"33":{},"51":{},"52":{},"53":{},"54":{}}}],["token",{"_index":2,"title":{"1":{},"2":{},"3":{},"4":{},"43":{},"44":{},"45":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"21":{},"43":{},"44":{},"45":{},"57":{}}}],["total",{"_index":23,"title":{},"description":{"10":{}}}],["twitter",{"_index":135,"title":{},"description":{"52":{}}}],["type",{"_index":116,"title":{},"description":{"46":{}}}],["updat",{"_index":19,"title":{"8":{},"16":{},"20":{},"27":{}},"description":{"8":{},"16":{},"20":{},"27":{}}}],["upload",{"_index":112,"title":{"46":{}},"description":{"46":{}}}],["us",{"_index":129,"title":{},"description":{"52":{},"55":{}}}],["user",{"_index":73,"title":{},"description":{"32":{},"41":{},"43":{},"51":{}}}],["usernam",{"_index":72,"title":{"32":{}},"description":{"32":{}}}],["valid",{"_index":48,"title":{},"description":{"21":{},"46":{}}}],["valu",{"_index":84,"title":{"40":{}},"description":{"40":{}}}],["verif",{"_index":47,"title":{"43":{},"44":{},"45":{}},"description":{"21":{},"44":{},"45":{}}}],["verifi",{"_index":28,"title":{"12":{},"21":{}},"description":{"12":{},"21":{},"43":{}}}],["version",{"_index":159,"title":{"62":{}},"description":{"62":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080/crafter-profile"}],"info":{"description":"Crafter Profile API","version":"4.5.0","title":"Crafter Profile","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Profile","url":"https://craftercms.com/docs/current/reference/modules/profile.html"},"tags":[{"name":"access_token","description":"Access token management"},{"name":"tenant","description":"Tenant management"},{"name":"profile","description":"Profile management"},{"name":"authentication","description":"Authentication"},{"name":"monitoring","description":"Monitoring operations"}],"paths":{"/api/1/access_token/create":{"post":{"security":[],"tags":["access_token"],"summary":"Create Access Token","operationId":"createAccessToken","description":"Creates a new access token","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The access token","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":{"application":"sample-app","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"sample-tenant"}],"expiresOn":1704067200000}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":{"application":"sample-app","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"sample-tenant"}],"expiresOn":1704067200000,"id":"a3f1a69c-3a7d-4b28-a944-61a7dc6877b8"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/access_token/{id}":{"get":{"security":[],"tags":["access_token"],"summary":"Get Access Token","operationId":"getAccessToken","description":"Get the information for a specific access token.","parameters":[{"name":"id","in":"path","description":"The ID of specific access token being requested for more information","required":true,"schema":{"type":"string"},"example":"b4d44030-d0af-11e3-9c1a-0800200c9a66"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccessToken"}},"example":{"application":"crafterengine","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"*"}],"expiresOn":1704067200000,"id":"b4d44030-d0af-11e3-9c1a-0800200c9a66"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/access_token/all":{"get":{"security":[],"tags":["access_token"],"summary":"Get All Access Tokens","operationId":"getAllAccessToken","description":"Get all existing access tokens.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":[{"application":"adminconsole","master":true,"tenantPermissions":[{"allowedActions":["*"],"tenant":"*"}],"expiresOn":1704067200000,"id":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"application":"crafterengine","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"*"}],"expiresOn":1704067200000,"id":"b4d44030-d0af-11e3-9c1a-0800200c9a66"},{"application":"craftersocial","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"*"}],"expiresOn":1704067200000,"id":"2ba3ac10-c43e-11e3-9c1a-0800200c9a66"}]}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/access_token/{id}/delete":{"post":{"security":[],"tags":["access_token"],"summary":"Delete Access Token","operationId":"deleteAccessToken","description":"Deletes an access token","parameters":[{"name":"id","in":"path","description":"The ID to be deleted","required":true,"schema":{"type":"string"},"example":"a3f1a69c-3a7d-4b28-a944-61a7dc6877b8"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The access token","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"},"example":{"application":"sample-app","master":false,"tenantPermissions":[{"allowedActions":["MANAGE_TICKETS","READ_TENANT","MANAGE_PROFILES"],"tenant":"sample-tenant"}],"expiresOn":1704067200000}}}},"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/create":{"post":{"security":[],"tags":["tenant"],"summary":"Create Tenant","operationId":"createTenant","description":"Creates the given tenant","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The tenant to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}":{"get":{"security":[],"tags":["tenant"],"summary":"Get Tenant","operationId":"getTenant","description":"Returns a tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/update":{"post":{"security":[],"tags":["tenant"],"summary":"Update Tenant","operationId":"updateTenant","description":"Updates the given tenant","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The updates to tenant","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"ssoEnable":true,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"ssoEnabled":true,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/delete":{"post":{"security":[],"tags":["tenant"],"summary":"Delete Tenant","operationId":"deleteTenant","description":"Deletes a tenant","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/count":{"get":{"security":[],"tags":["tenant"],"summary":"Count Tenants","operationId":"countTenants","description":"Returns the total number of tenants.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer"},"example":1}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/all":{"get":{"security":[],"tags":["tenant"],"summary":"Get All Tenants","operationId":"getAllTenants","description":"Returns a list with all the tenants.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":[{"name":"default","verifyNewProfiles":false,"availableRoles":["SOCIAL_SUPERADMIN","PROFILE_ADMIN","PROFILE_SUPERADMIN","PROFILE_TENANT_ADMIN"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"displayName","metadata":[{"label":"Display Name","type":"TEXT","displayOrder":2}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"socialContexts","metadata":[{"label":"Social Contexts","type":"COMPLEX","displayOrder":5}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926f6c524d9aaad9804a401"},{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/verify_new_profiles":{"post":{"security":[],"tags":["tenant"],"summary":"Verify New Profiles","operationId":"verifyNewProfiles","description":"Sets if new profiles for the specified tenant should be verified or not.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"verify","in":"query","description":"True to verify new profiles through email, false otherwise","required":true,"schema":{"type":"string"},"example":"true"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/roles/add":{"post":{"security":[],"tags":["tenant"],"summary":"Add Roles","operationId":"addRoles","description":"Adds the given roles to the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"role","in":"query","description":"The roles to add","required":true,"schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER","APP_TEST","APP_REPORT"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/roles/remove":{"post":{"security":[],"tags":["tenant"],"summary":"Remove Roles","operationId":"removeRoles","description":"Removes the given roles to the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"role","in":"query","description":"The roles to add","required":true,"schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/attribute_definitions/add":{"post":{"security":[],"tags":["tenant"],"summary":"Add Attributes","operationId":"addAttributes","description":"Adds the given attribute definitions to the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The attribute(s) to be added","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenantAttribute"}},"example":{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/attribute_definitions/update":{"post":{"security":[],"tags":["tenant"],"summary":"Update Attributes","operationId":"updateAttributes","description":"Updates the given attribute definitions of the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"}],"requestBody":{"description":"The attribute(s) to be updated","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenantAttribute"}},"example":{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":10}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","items":{"$ref":"#/components/schemas/ProfileTenant"}},"example":{"name":"sample-tenant","verifyNewProfiles":true,"availableRoles":["APP_ADMIN","APP_USER"],"ssoEnabled":false,"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null},{"name":"Nickname","metadata":[{"label":"Nickname","type":"TEXT","displayOrder":10}],"permissions":[{"application":"*","allowedActions":["*"]}],"defaultValue":null}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/tenant/{name}/attribute_definitions/remove":{"post":{"security":[],"tags":["tenant"],"summary":"Remove Attributes","operationId":"removeAttributes","description":"Removes the given attribute definitions from the specified tenant.","parameters":[{"name":"name","in":"path","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"attributeName","in":"query","description":"The name of the attributes whose definitions should be removed (the parameter can be repeated)","required":true,"schema":{"type":"string"},"example":"nickname"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileTenant"},"example":{"name":"sample-tenant","verifyNewProfiles":false,"availableRoles":["APP_ADMIN","APP_USER"],"attributeDefinitions":[{"name":"firstName","metadata":[{"label":"First Name","type":"TEXT","displayOrder":0}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"lastName","metadata":[{"label":"Last Name","type":"TEXT","displayOrder":1}],"permissions":[{"application":"*","allowedActions":["*"]}]},{"name":"avatarLink","metadata":[{"label":"Avatar Link","type":"TEXT","displayOrder":3}],"permissions":[{"application":"*","allowedActions":["*"]}]}],"id":"5926ee77d4c6ad51e5e44f45"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/create":{"post":{"security":[],"tags":["profile"],"summary":"Create Profile","operationId":"createProfile","description":"Creates a new profile for a specific tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The name of the tenant to add the profile to.","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"username","in":"query","description":"The profile’s username.","required":true,"schema":{"type":"string"},"example":"john.doe"},{"name":"password","in":"query","description":"The profile’s password.","schema":{"type":"string"},"example":"passw0rd"},{"name":"email","in":"query","description":"The profile’s email.","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"},{"name":"enabled","in":"query","description":"If the profile should be enabled or not.","required":true,"schema":{"type":"string"},"example":false},{"name":"role","in":"query","description":"The profile’s roles.","schema":{"type":"string"},"example":false},{"name":"attributes","in":"query","description":"The additional attributes to add to the profile (specify a JSON string)","schema":{"type":"string"},"example":{"firstName":"John","lastName":"Doe"}},{"name":"verificationUrl","in":"query","description":"The URL (sans token) the user needs to go in case it needs to verify the created profile (verification depends on tenant)","schema":{"type":"string"},"example":"verificationUrl"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592715d4d4c650e226b03b62"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/update":{"post":{"security":[],"tags":["profile"],"summary":"Update Profile","operationId":"updateProfile","description":"Updates the profile’s info.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"query","description":"The profile's id.","schema":{"type":"string"},"example":"592887d7d4c650213cc2f400"},{"name":"username","in":"query","description":"The new username for the profile.","required":true,"schema":{"type":"string"},"example":"john.doe"},{"name":"password","in":"query","description":"The new password for the profile.","schema":{"type":"string"},"example":"passw0rd"},{"name":"email","in":"query","description":"The new email for the profile.","required":true,"schema":{"type":"string"},"example":"john.doe@example.com"},{"name":"enabled","in":"query","description":"If the profile should be enabled or not.","required":true,"schema":{"type":"string"},"example":false},{"name":"role","in":"query","description":"The new roles for the profile.","schema":{"type":"string"},"example":false},{"name":"attributes","in":"query","description":"The attributes to update (specify a JSON string)","schema":{"type":"string"},"example":{"firstName":"John","lastName":"Doe"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe"},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/verify":{"post":{"security":[],"tags":["profile"],"summary":"Verify Profile","operationId":"verifyProfile","description":"Sets the profile as verified if the verification token is valid.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"verificationTokenId","in":"query","description":"The verification token ID.","schema":{"type":"string"},"example":"055d58c4-fabb-44da-96eb-261e24e1d0c9"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/enable":{"post":{"security":[],"tags":["profile"],"summary":"Enable Profile","operationId":"enableProfile","description":"Enables a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/disable":{"post":{"security":[],"tags":["profile"],"summary":"Disable Profile","operationId":"disableProfile","description":"Disables a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/roles/add":{"post":{"security":[],"tags":["profile"],"summary":"Add Roles","operationId":"addRoles","description":"Assign roles to a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"roles","in":"query","description":"The roles to assign","schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"592715d4d4c650e226b03b62"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/roles/remove":{"post":{"security":[],"tags":["profile"],"summary":"Remove Roles","operationId":"removeRoles","description":"Remove assigned roles from a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"roles","in":"query","description":"The roles to remove","schema":{"type":"string"},"example":"APP_TEST,APP_REPORT"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592715d4d4c650e226b03b62"}}}},"400":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attributes":{"get":{"security":[],"tags":["profile"],"summary":"Get Attributes","operationId":"getAttributes","description":"Returns the attributes of a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"firstName":"John","lastName":"Doe"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attributes/update":{"post":{"security":[],"tags":["profile"],"summary":"Update Attributes","operationId":"updateAttributes","description":"Updates the attributes of a profile. <br><br> <i>NOTE:</i> <i>The specified attributes will be merged with existing attributes.</i>","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"requestBody":{"description":"The attribute(s) to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"avatarLink":"/static-assets/images/avatar.png"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe","avatarLink":"/static-assets/images/avatar.png"},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attributes/remove":{"post":{"security":[],"tags":["profile"],"summary":"Remove Attributes","operationId":"removeAttributes","description":"Removes a list of attributes of a profile","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesName","in":"query","description":"The name of the attributes to remove","schema":{"type":"string"},"example":"avatarLink"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"requestBody":{"description":"The attribute(s) to be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"avatarLink":"/static-assets/images/avatar.png"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe"},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/delete":{"post":{"security":[],"tags":["profile"],"summary":"Delete Profile","operationId":"deleteProfile","description":"Deletes a profile","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/one_by_query":{"post":{"security":[],"tags":["profile"],"summary":"Get Profile By Query","operationId":"getProfileByQuery","description":"Returns the single profile that matches the specified query","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"query","in":"query","description":"The Mongo query used to search for the profiles <br><br> <b><i>Warning:</i></b> The query must not contain the <i>$where</i> operator, the tenant's name (already specified) or any non-readable attribute by the application","schema":{"type":"string"},"example":"%7B%20%22username%22%3A%20%22john.doe%22%20%7D"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile","operationId":"getProfile","description":"Returns the profile for a specified ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile’s ID","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"},"example":"firstName,lastName"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_username":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile By Username","operationId":"getProfileByUsername","description":"Returns the user for the specified tenant and username.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"username","in":"query","description":"The profile's username","required":true,"schema":{"type":"string"},"example":"john.doe"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_ticket":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile By Ticket","operationId":"getProfileByTicket","description":"Returns the profile for the specified ticket.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"ticketId","in":"query","description":"The ID ticket of the authenticated profile","required":true,"schema":{"type":"string"},"example":"592887d7d4c650213cc2f400"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttributes"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"592887d7d4c650213cc2f400"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/count":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Count","operationId":"getProfileCount","description":"Returns the number of profiles for the specified tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"},"example":1}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/count_by_query":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Count By Query","operationId":"getProfileCountByQuery","description":"Returns the number of profiles that match the query for the specified tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"query","in":"query","description":"The Mongo query used to search for the profiles. <br><br> <b><i>Warning:</i></b> The query must not contain the <i>$where</i> operator, the tenant's name (already specified) or any non-readable attribute by the application","schema":{"type":"string"},"example":"%7B%20%22username%22%3A%20%22john.doe%22%20%7D"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"number"},"example":1}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_query":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Query","operationId":"getProfilesByQuery","description":"Returns the profiles that match the specified query.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"query","in":"query","description":"The Mongo query used to search for the profiles. <br><br> <b><i>Warning:</i></b> The query must not contain the <i>$where</i> operator, the tenant's name (already specified) or any non-readable attribute by the application","schema":{"type":"string"},"example":"%7B%20%22username%22%3A%20%22john.doe%22%20%7D"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"start","in":"query","description":"From the entire list of results, the position where the actual results should start (useful for pagination)","schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of profiles to return","schema":{"type":"string"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_ids":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Ids","operationId":"getProfilesByIds","description":"Returns a list of profiles for the specified IDs.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"query","description":"The IDs of the profiles to look for","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc,59284659d4c650213cc2f3ff"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/range":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Range","operationId":"getProfilesByRange","description":"Returns a range of profiles for the specified tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"start","in":"query","description":"From the entire list of results, the position where the actual results should start (useful for pagination)","schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of profiles to return","schema":{"type":"string"}},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":[],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_role":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Role","operationId":"getProfilesByRole","description":"Returns a list of profiles for a specific role and tenant.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"role","in":"query","description":"The role's name","required":true,"schema":{"type":"string"},"example":"APP_TEST"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/by_existing_attribute":{"get":{"security":[],"tags":["profile"],"summary":"Get Profiles By Attribute Value","operationId":"getProfilesByAttributeValue","description":"Returns the list of profiles that have the given attribute with the given value.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"sample-tenant"},{"name":"sortBy","in":"query","description":"Profile attribute to sort the list by","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sort order (either ASC or DESC)","schema":{"type":"string"}},{"name":"attributeName","in":"query","description":"The name of the attribute the profiles must have","required":true,"schema":{"type":"string"},"example":"lastName"},{"name":"attributeValue","in":"query","description":"The value of the attribute the profiles must have","required":true,"schema":{"type":"string"},"example":"Doe"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttributes"}},"example":[{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495748091232,"lastModified":1495748091232,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{"firstName":"John","lastName":"Doe"},"id":"59274dfbd4c650e226b03b65"}]}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/reset_password":{"post":{"security":[],"tags":["profile"],"summary":"Reset Password","operationId":"resetPassword","description":"Sends an email to the profile’s user to indicate that the password needs to be reset.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"},{"name":"resetPasswordUrl","in":"query","description":"The base URL to use to build the final URL the profile will use to reset their password","required":true,"schema":{"type":"string"},"example":"http://example.com"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"59284659d4c650213cc2f3fc"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/change_password":{"post":{"security":[],"tags":["profile"],"summary":"Change Password","operationId":"changePassword","description":"Resets a profile’s password.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"resetTokenId","in":"query","description":"The reset token ID","required":true,"schema":{"type":"string"},"example":"a2be0e86-7c71-4edf-aed9-6b00c0c60c33"},{"name":"newPassword","in":"query","description":"The new password","required":true,"schema":{"type":"string"},"example":"test123"},{"name":"attributesToReturn","in":"query","description":"The name of the attributes to return (don't specify to return all)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":1495733716728,"lastModified":1495733716728,"tenant":"sample-tenant","roles":["APP_TEST","APP_REPORT"],"attributes":{},"id":"59284659d4c650213cc2f3fc"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/verification_token/create":{"post":{"security":[],"tags":["profile"],"summary":"Create Verification Token","operationId":"createVerificationToken","description":"Creates a token that can be sent to the user in an email as a link.<br><br><i>Note:</i><br>After the user clicks the link, the token then can be passed to <b><i>/verify</i></b> or <b><i>/change_password</i></b> to verify user requesting the token.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile ID of the user","required":true,"schema":{"type":"string"},"example":"592715d4d4c650e226b03b62"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tenant":{"type":"string"},"profileId":{"type":"string"},"timestamp":{"type":"string"},"id":{"type":"string"}}},"example":{"tenant":"sample-tenant","profileId":"592715d4d4c650e226b03b62","timestamp":1495746285875,"id":"055d58c4-fabb-44da-96eb-261e24e1d0c9"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/verification_token/{id}":{"get":{"security":[],"tags":["profile"],"summary":"Get Verification Token","operationId":"getVerificationToken","description":"Returns the verification token that corresponds to the given ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The token ID","required":true,"schema":{"type":"string"},"example":"de60f56d-3a4b-4dec-b798-fb22b2964c14"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"tenant":{"type":"string"},"profileId":{"type":"string"},"timestamp":{"type":"string"},"id":{"type":"string"}}},"example":{"tenant":"sample-tenant","profileId":"592715d4d4c650e226b03b62","timestamp":1495746285875,"id":"de60f56d-3a4b-4dec-b798-fb22b2964c14"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/verification_token/{id}/delete":{"post":{"security":[],"tags":["profile"],"summary":"Delete Verification Token","operationId":"deleteVerificationToken","description":"Deletes a verification token when it’s not needed anymore.<br><br><i>Note:</i><br>Not necessary to call if <b><i>/verify</i></b> or <b><i>/change_password</i></b> were called, since they already delete the token.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The token ID","required":true,"schema":{"type":"string"},"example":"de60f56d-3a4b-4dec-b798-fb22b2964c14"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/uploadAttachment":{"post":{"security":[],"tags":["profile"],"summary":"Upload Profile Attachment","operationId":"uploadProfileAttachment","description":"Upload a attachment to the specified profile.<br><br><i>Note:</i><br>If the mime type of the attachment is not on the valid list will fail.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"description":"File to be uploaded.","type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttachment"},"example":{"md5":"498a1e16be56873ef53a1a61295d1781","contentType":"image/jpeg","fileSize":"22.6 KB","fileName":"picture1","fileSizeBytes":23193,"id":"59285cd3d4c650213cc2f3fd"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attachment/{attachmentName}":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Attachment","operationId":"getProfileAttachment","description":"Gets the requested attachment of the given profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"},{"name":"attachmentName","in":"path","description":"Name of the attachment to get","required":true,"schema":{"type":"string"},"example":"picture1"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"example":"image/jpeg;charset=UTF-8"},"Content-Length":{"schema":{"type":"integer","format":"int32"},"example":23193}},"content":{"image/*":{"schema":{"type":"string","format":"binary"}},"text/*":{"schema":{"type":"string","format":"binary"}},"application/*":{"schema":{"type":"string","format":"binary"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attachments":{"get":{"security":[],"tags":["profile"],"summary":"Get All Profile Attachments","operationId":"getAllProfileAttachments","description":"Gets all attachments for the given profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ProfileAttachment"},"example":[{"md5":"498a1e16be56873ef53a1a61295d1781","contentType":"image/jpeg","fileSize":"22.6 KB","fileName":"picture1","fileSizeBytes":23193,"id":"59285cd3d4c650213cc2f3fd"}]}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/profile/{id}/attachment/{attachmentName}/details":{"get":{"security":[],"tags":["profile"],"summary":"Get Profile Attachment Details","operationId":"getProfileAttachmentDetails","description":"Returns the details for a given attachment in a profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The profile's ID","required":true,"schema":{"type":"string"},"example":"59284659d4c650213cc2f3fc"},{"name":"attachmentName","in":"path","description":"Name of the attachment to get","required":true,"schema":{"type":"string"},"example":"picture1"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileAttachment"},"example":{"md5":"498a1e16be56873ef53a1a61295d1781","contentType":"image/jpeg","fileSize":"22.6 KB","fileName":"picture1","fileSizeBytes":23193,"id":"59285cd3d4c650213cc2f3fd"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/authenticate":{"post":{"security":[],"tags":["authentication"],"summary":"Authenticate","operationId":"authenticate","description":"Authenticates the user, and returns a ticket identifying the authentication.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"tenantName","in":"query","description":"The tenant's name","required":true,"schema":{"type":"string"},"example":"default"},{"name":"username","in":"query","description":"The username","required":true,"schema":{"type":"string"},"example":"admin"},{"name":"password","in":"query","description":"The password","required":true,"schema":{"type":"string"},"example":"admin"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"59284659d4c650213cc2f3fc"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/ticket/create":{"post":{"security":[],"tags":["authentication"],"summary":"Create Ticket","operationId":"createTicket","description":"Creates a new ticket for the specified profile.<br><br><i>Note:</i><br>This method should only be used when actual authentication is done through other means (like when authenticating through Facebook or Twitter) different than profile.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"profileId","in":"query","description":"The ID of the profile","required":true,"schema":{"type":"string"},"example":"5925a68def86951f895cf497"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"7f036af3-1ab9-4791-b615-ecaece3f0010"}}}},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/ticket/{ticketId}":{"get":{"security":[],"tags":["authentication"],"summary":"Get Ticket","operationId":"getTicket","description":"Returns the ticket info for the given ticket ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"ticketId","in":"path","description":"The ID of the ticket","required":true,"schema":{"type":"string"},"example":"b4d44030-d0af-11e3-9c1a-0800200c9a66"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"2e911e0b-ac47-423e-9174-4e8896f1b387"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/ticket/{ticketId}/invalidate":{"get":{"security":[],"tags":["authentication"],"summary":"Invalidate Ticket","operationId":"invalidateTicket","description":"Invalidates the given ticket.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"ticketId","in":"path","description":"The ID of the ticket","required":true,"schema":{"type":"string"},"example":"b4d44030-d0af-11e3-9c1a-0800200c9a66"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","lastRequestedTime":1495733716728,"id":"2e911e0b-ac47-423e-9174-4e8896f1b387"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/create":{"post":{"security":[],"tags":["authentication"],"summary":"Create Persistent Login","operationId":"createPersistentLogin","description":"Creates a persistent login, used for remember me functionality.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"profileId","in":"query","description":"The ID of the profile","required":true,"schema":{"type":"string"},"example":"5925a68def86951f895cf497"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","timestamp":1495733716728,"id":"2e911e0b-ac47-423e-9174-4e8896f1b387","token":"adf88dca-4960-474c-be63-c8c5e3bedaa7"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/{id}":{"get":{"security":[],"tags":["authentication"],"summary":"Get Persistent Login","operationId":"getPersistentLogin","description":"Returns the persistent login info for the given ID.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The ID of the persistent login","required":true,"schema":{"type":"string"},"example":"b68c0013-d7b2-4004-8463-d7ba03e15d94"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","timestamp":1495733716728,"id":"b68c0013-d7b2-4004-8463-d7ba03e15d94","token":"adf88dca-4960-474c-be63-c8c5e3bedaa7"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/{id}/refresh_token":{"post":{"security":[],"tags":["authentication"],"summary":"Refresh Persistent Login","operationId":"refreshPersistentLogin","description":"Refreshes the token of the specified persistent login.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The ID of the persistent login","required":true,"schema":{"type":"string"},"example":"b68c0013-d7b2-4004-8463-d7ba03e15d94"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationTicket"},"example":{"tenant":"default","profileId":"5925a68def86951f895cf497","timestamp":1495733716728,"id":"b68c0013-d7b2-4004-8463-d7ba03e15d94","token":"f390e222-c844-44a2-ad38-afa471527101"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/authentication/persistent_login/{id}/delete":{"post":{"security":[],"tags":["authentication"],"summary":"Delete Persistent Login","operationId":"deletePersistentLogin","description":"Deletes a persistent login.","parameters":[{"name":"accessTokenId","in":"query","description":"The access token ID of the application making the call","required":true,"schema":{"type":"string"},"example":"e8f5170c-877b-416f-b70f-4b09772f8e2d"},{"name":"id","in":"path","description":"The ID of the persistent login","required":true,"schema":{"type":"string"},"example":"b68c0013-d7b2-4004-8463-d7ba03e15d94"}],"responses":{"200":{"description":"OK"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/memory":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Memory Stats","operationId":"getMemoryStats","description":"Returns the Crafter Profile JVM memory details.","parameters":[{"name":"token","in":"query","description":"The authorization token.","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringJVMMemoryStats"},"example":{"totalJvmMemory":2017984512,"freeJvmMemory":1113921056,"maxJvmMemory":3817865216,"totalOsMemory":17179869184,"freeOsMemory":2669301760,"totalSwapMemory":2147483648,"freeSwapMemory":1026555904}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/status":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Status","operationId":"getStatus","description":"Returns the Crafter Profile JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token.","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatus"},"example":{"uptime":4801,"startup":"2019-03-07T21:29:11.049Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/monitoring/version":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Version","operationId":"getVersion","description":"Returns the Crafter Profile JVM version details.","parameters":[{"name":"token","in":"query","description":"The authorization token.","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatus"},"example":{"packageName":"Crafter Profile","packageVersion":"3.1.0-SNAPSHOT","packageBuild":"a68f1ff7ad84d5ecbeaa008f392e4cef0ca02f41","packageBuildDate":"2019-03-07T21:03:05.422Z","osName":"Mac OS X","osVersion":"10.13.6","osArch":"x86_64","javaVersion":"1.8","javaVendor":"Oracle Corporation","javaVm":"Java HotSpot(TM) 64-Bit Server VM"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"AccessToken":{"type":"object","properties":{"application":{"type":"string"},"master":{"type":"boolean"},"tenantPermissions":{"type":"array","items":{"type":"object","properties":{"allowedActions":{"type":"array"},"tenant":{"type":"string"}}}},"expiresOn":{"type":"integer"},"id":{"type":"string"}}},"ProfileTenantAttribute":{"type":"object","properties":{"name":{"type":"string"},"metadata":{"type":"object","properties":{"label":{"type":"string"},"type":{"type":"string"},"displayOrder":{"type":"number","format":"float"}}},"permissions":{"type":"array","items":{"type":"object","properties":{"application":{"type":"string"},"allowedActions":{"type":"array","items":{"type":"string"}}}}},"defaultValue":{"type":"object"}}},"ProfileTenant":{"type":"object","properties":{"name":{"type":"string"},"verifyNewProfiles":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"availableRoles":{"type":"array","items":{"type":"string"}},"attributeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTenantAttribute"}},"id":{"type":"string"}}},"Profile":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string"},"verified":{"type":"boolean"},"enabled":{"type":"boolean"},"createdOn":{"type":"number"},"lastModified":{"type":"number"},"tenant":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"$ref":"#/components/schemas/ProfileAttributes"},"id":{"type":"string"}}},"UserProfile":{"type":"object","properties":{"age":{"type":"integer"},"username":{"type":"string"},"lastname":{"type":"string"}}},"ProfileAttributes":{"type":"object","description":"Object containing attributes for the profile","additionalProperties":{"type":"string"}},"ProfileAttachment":{"type":"object","properties":{"md5":{"type":"string"},"contentType":{"type":"string"},"fileSize":{"type":"string"},"fileName":{"type":"string"},"fileSizeBytes":{"type":"integer","format":"int32"},"id":{"type":"string"}}},"AuthenticationTicket":{"type":"object","properties":{"tenant":{"type":"string"},"profileId":{"type":"string"},"lastRequestTime":{"type":"string"},"id":{"type":"string"},"token":{"type":"string"},"timestamp":{"type":"string"}}},"MonitoringJVMMemoryStats":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","format":"int64"},"freeJvmMemory":{"type":"integer","format":"int64"},"maxJvmMemory":{"type":"integer","format":"int64"},"totalOSMemory":{"type":"integer","format":"int64"},"freeOSMemory":{"type":"integer","format":"int64"},"totalSwapMemory":{"type":"integer","format":"int64"},"freeSwapMemory":{"type":"integer","format":"int64"}}},"MonitoringStatus":{"type":"object","properties":{"uptime":{"type":"integer","format":"int32"},"startup":{"type":"string","format":"date-time"}}},"MonitoringJVMVersion":{"type":"object","properties":{"packageName":{"type":"string"},"packageVersion":{"type":"string"},"packageBuild":{"type":"string"},"packageBuildDate":{"type":"string","format":"date-time"},"osName":{"type":"string"},"osVersion":{"type":"string"},"osArch":{"type":"string"},"javaVersion":{"type":"string"},"javaVendor":{"type":"string"},"javaVm":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"access_token":{"value":{"errorCode":"ACTION_DENIED","message":"Current subject does not have permission to execute global action \"CREATE_TOKEN\""}},"tenant":{"value":{"errorCode":"TENANT_EXISTS","message":"The tenant \"sample-tenant\" already exists"}},"profile":{"value":{"errorCode":"PROFILE_EXISTS","message":"A profile with name \"john.doe\" already exists"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"tenant":{"value":{"errorCode":"NO_SUCH_TENANT","message":"No tenant with name ‘sample-tenant’ found"}},"monitoring":{"value":{"errorCode":"OTHER","message":"”Required String parameter ‘token’ is not present”"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"authentication":{"value":{"errorCode":"BAD_CREDENTIALS","message":"Invalid username and/or password"}},"monitoring":{"value":{"errorCode":"ACCESS_DENIED","message":"”Management authorization failed, invalid token.”"}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"accessToken":{"value":{"errorCode":"ACTION_DENIED","message":"Current subject does not have permission to execute global action \\\"CREATE_TOKEN\\\""}},"profile":{"value":{"errorCode":"DISABLED_PROFILE","message":"Profile \\\"59284659d4c650213cc2f3fc\\\" of tenant \\\"sample-tenant\\\" is disabled"}},"authentication":{"value":{"errorCode":"NO_SUCH_ACCESS_TOKEN_ID","message":"No access token found for ID \\\"e8f5170c-877b-416f-b70f-4b09772f8e2d\\\""}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}}},"examples":{"userProfileExample":{"value":{"age":30,"username":"john","lastname":"doe"}}}}}},"searchIndex":{"store":["tag/access_token","tag/access_token/operation/createAccessToken","tag/access_token/operation/getAccessToken","tag/access_token/operation/getAllAccessToken","tag/access_token/operation/deleteAccessToken","tag/tenant","tag/tenant/operation/createTenant","tag/tenant/operation/getTenant","tag/tenant/operation/updateTenant","tag/tenant/operation/deleteTenant","tag/tenant/operation/countTenants","tag/tenant/operation/getAllTenants","tag/tenant/operation/verifyNewProfiles","tag/tenant/operation/addRoles","tag/tenant/operation/removeRoles","tag/tenant/operation/addAttributes","tag/tenant/operation/updateAttributes","tag/tenant/operation/removeAttributes","tag/profile","tag/profile/operation/createProfile","tag/profile/operation/updateProfile","tag/profile/operation/verifyProfile","tag/profile/operation/enableProfile","tag/profile/operation/disableProfile","tag/profile/operation/addRoles","tag/profile/operation/removeRoles","tag/profile/operation/getAttributes","tag/profile/operation/updateAttributes","tag/profile/operation/removeAttributes","tag/profile/operation/deleteProfile","tag/profile/operation/getProfileByQuery","tag/profile/operation/getProfile","tag/profile/operation/getProfileByUsername","tag/profile/operation/getProfileByTicket","tag/profile/operation/getProfileCount","tag/profile/operation/getProfileCountByQuery","tag/profile/operation/getProfilesByQuery","tag/profile/operation/getProfilesByIds","tag/profile/operation/getProfilesByRange","tag/profile/operation/getProfilesByRole","tag/profile/operation/getProfilesByAttributeValue","tag/profile/operation/resetPassword","tag/profile/operation/changePassword","tag/profile/operation/createVerificationToken","tag/profile/operation/getVerificationToken","tag/profile/operation/deleteVerificationToken","tag/profile/operation/uploadProfileAttachment","tag/profile/operation/getProfileAttachment","tag/profile/operation/getAllProfileAttachments","tag/profile/operation/getProfileAttachmentDetails","tag/authentication","tag/authentication/operation/authenticate","tag/authentication/operation/createTicket","tag/authentication/operation/getTicket","tag/authentication/operation/invalidateTicket","tag/authentication/operation/createPersistentLogin","tag/authentication/operation/getPersistentLogin","tag/authentication/operation/refreshPersistentLogin","tag/authentication/operation/deletePersistentLogin","tag/monitoring","tag/monitoring/operation/getMemoryStats","tag/monitoring/operation/getStatus","tag/monitoring/operation/getVersion"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.709]],["description/0",[1,2.401,2,1.632,3,3.658]],["title/1",[1,1.577,2,1.072,4,1.35]],["description/1",[1,2.051,2,1.394,4,1.756,5,2.639,6,4.036]],["title/2",[1,1.901,2,1.292]],["description/2",[1,2.051,2,1.394,7,4.036,8,3.125,9,4.036]],["title/3",[1,1.901,2,1.292]],["description/3",[1,2.212,2,1.504,10,3.761,11,4.353]],["title/4",[1,1.577,2,1.072,12,1.494]],["description/4",[1,2.212,2,1.504,12,2.096,13,4.353]],["title/5",[14,1.106]],["description/5",[3,4,14,1.214]],["title/6",[4,1.628,14,0.879]],["description/6",[4,1.894,14,1.023,15,1.645,16,4.353]],["title/7",[14,1.106]],["description/7",[14,1.11,17,1.261,18,4.725]],["title/8",[14,0.879,19,2.012]],["description/8",[14,1.023,15,1.645,19,2.341,20,4.353]],["title/9",[12,1.802,14,0.879]],["description/9",[12,2.275,14,1.11,21,4.725]],["title/10",[14,0.879,22,2.897]],["description/10",[14,0.948,17,1.077,23,4.036,24,3.125,25,4.036]],["title/11",[14,1.106]],["description/11",[14,1.023,17,1.162,26,2.653,27,4.353]],["title/12",[5,2.029,28,2.029,29,0.164]],["description/12",[5,2.303,14,0.827,28,2.303,29,0.186,30,3.043,31,1.115,32,3.522]],["title/13",[33,2.446,34,1.802]],["description/13",[14,0.884,15,1.421,31,1.191,33,2.459,34,1.811,35,3.762]],["title/14",[34,1.802,36,2.012]],["description/14",[14,0.884,15,1.421,31,1.191,34,1.811,36,2.023,37,3.762]],["title/15",[33,2.446,38,1.48]],["description/15",[14,0.827,15,1.331,31,1.115,33,2.303,38,1.393,39,2.727,40,3.522]],["title/16",[19,2.012,38,1.48]],["description/16",[14,0.827,15,1.331,19,1.894,31,1.115,38,1.393,39,2.727,41,3.522]],["title/17",[36,2.012,38,1.48]],["description/17",[14,0.827,15,1.331,31,1.115,36,1.894,38,1.393,39,2.727,42,3.522]],["title/18",[29,0.248]],["description/18",[3,4,29,0.273]],["title/19",[4,1.628,29,0.197]],["description/19",[4,1.637,5,2.459,8,2.912,14,0.884,29,0.198,43,3.762]],["title/20",[19,2.012,29,0.197]],["description/20",[19,2.341,44,3.371,45,3.371,46,4.353]],["title/21",[28,2.446,29,0.197]],["description/21",[2,1.217,28,2.303,29,0.186,30,3.043,47,2.146,48,3.043,49,3.522]],["title/22",[29,0.197,50,3.232]],["description/22",[29,0.249,50,4.082,51,4.725]],["title/23",[29,0.197,52,3.232]],["description/23",[29,0.249,52,4.082,53,4.725]],["title/24",[33,2.446,34,1.802]],["description/24",[29,0.23,34,2.096,54,3.761,55,4.353]],["title/25",[34,1.802,36,2.012]],["description/25",[29,0.213,34,1.944,36,2.171,54,3.487,56,4.036]],["title/26",[38,1.863]],["description/26",[17,1.162,29,0.23,38,1.722,57,4.353]],["title/27",[19,2.012,38,1.48]],["description/27",[10,2.308,19,1.437,29,0.141,31,0.846,38,1.597,58,2.672,59,2.672,60,2.672,61,2.672,62,2.672,63,2.672]],["title/28",[36,2.012,38,1.48]],["description/28",[26,2.459,29,0.213,36,2.171,38,1.596,64,4.036]],["title/29",[12,1.802,29,0.197]],["description/29",[12,2.275,29,0.249,65,4.725]],["title/30",[29,0.197,66,2.28]],["description/30",[17,0.94,29,0.186,31,1.115,66,2.146,67,3.522,68,2.727,69,3.522]],["title/31",[29,0.248]],["description/31",[17,1.077,29,0.213,31,1.278,70,2.459,71,4.036]],["title/32",[29,0.197,72,3.232]],["description/32",[14,0.884,17,1.004,31,1.191,72,3.25,73,2.661,74,3.762]],["title/33",[29,0.197,75,1.901]],["description/33",[17,1.077,29,0.213,31,1.278,75,2.051,76,4.036]],["title/34",[22,2.897,29,0.197]],["description/34",[14,0.884,17,1.004,24,2.912,29,0.198,31,1.191,77,3.762]],["title/35",[22,2.403,29,0.164,66,1.891]],["description/35",[14,0.778,17,0.884,24,2.564,29,0.175,31,1.049,66,2.018,68,2.564,78,3.311]],["title/36",[29,0.197,66,2.28]],["description/36",[17,1.004,29,0.198,31,1.191,66,2.292,68,2.912,79,3.762]],["title/37",[29,0.197,70,2.28]],["description/37",[17,1.004,26,2.292,29,0.198,31,1.191,70,2.292,80,3.762]],["title/38",[29,0.197,81,3.232]],["description/38",[14,0.884,17,1.004,29,0.198,31,1.191,81,3.25,82,3.762]],["title/39",[29,0.197,34,1.802]],["description/39",[8,2.727,14,0.827,17,0.94,26,2.146,29,0.186,34,1.696,83,3.522]],["title/40",[29,0.164,38,1.228,84,2.681]],["description/40",[15,1.786,17,0.884,26,2.018,29,0.175,38,1.31,84,2.861,85,3.311]],["title/41",[86,2.897,87,2.646]],["description/41",[44,2.419,73,2.21,86,2.419,87,2.21,88,3.124,89,2.699,90,3.124,91,2.699,92,3.124]],["title/42",[87,2.646,93,3.741]],["description/42",[44,3.371,86,3.371,87,3.079,94,4.353]],["title/43",[2,1.072,4,1.35,47,1.891]],["description/43",[2,1.43,4,0.901,28,1.355,73,2.927,89,1.79,95,2.072,96,2.072,97,2.072,98,2.072,99,2.072,100,1.79,101,1.79,102,1.79,103,2.072]],["title/44",[2,1.292,47,2.28]],["description/44",[2,1.217,15,1.331,17,0.94,47,2.146,70,2.146,104,3.522,105,3.522]],["title/45",[2,1.072,12,1.494,47,1.891]],["description/45",[2,1.257,12,1.752,47,1.422,91,2.016,100,2.016,101,2.016,106,2.334,107,2.334,108,2.334,109,3.639,110,2.334,111,2.334]],["title/46",[29,0.164,112,2.681,113,1.669]],["description/46",[26,1.711,31,0.889,48,2.425,112,2.425,113,2.254,114,2.807,115,2.807,116,2.807,117,2.807,118,2.807]],["title/47",[29,0.197,113,2.012]],["description/47",[15,1.421,29,0.198,102,3.25,113,2.023,119,3.25,120,3.762]],["title/48",[29,0.197,113,2.012]],["description/48",[15,1.525,29,0.213,113,2.171,119,3.487,121,4.036]],["title/49",[29,0.164,113,1.669,122,2.029]],["description/49",[15,1.421,17,1.004,29,0.198,113,2.023,122,2.459,123,3.762]],["title/50",[124,3.079]],["description/50",[124,3.726]],["title/51",[124,3.079]],["description/51",[17,0.94,73,2.491,75,1.79,124,3.229,125,3.522,126,3.522]],["title/52",[4,1.628,75,1.901]],["description/52",[4,0.869,5,1.306,29,0.105,31,0.632,75,1.015,124,2.103,127,1.997,128,1.997,129,1.725,130,1.997,131,1.997,132,3.216,133,1.997,134,1.997,135,1.997,136,1.997,137,1.997]],["title/53",[75,2.393]],["description/53",[15,1.331,17,0.94,45,2.727,70,2.146,75,2.51,138,3.522]],["title/54",[75,1.901,139,3.232]],["description/54",[15,1.645,75,2.212,139,3.761,140,4.353]],["title/55",[4,1.35,141,1.669,142,1.669]],["description/55",[4,1.533,129,3.043,141,1.894,142,1.894,143,3.522,144,3.522,145,3.522]],["title/56",[141,2.012,142,2.012]],["description/56",[15,1.331,17,0.94,45,2.727,70,2.146,141,1.894,142,1.894,146,3.522]],["title/57",[141,1.669,142,1.669,147,2.681]],["description/57",[2,1.299,31,1.191,141,2.023,142,2.023,147,3.25,148,3.762]],["title/58",[12,1.494,141,1.669,142,1.669]],["description/58",[12,2.096,141,2.341,142,2.341,149,4.353]],["title/59",[150,4.068]],["description/59",[150,4.463,151,5.166]],["title/60",[152,3.232,153,3.741]],["description/60",[17,0.94,29,0.186,122,2.303,152,3.043,154,2.727,155,2.727,156,3.522]],["title/61",[157,4.068]],["description/61",[17,0.94,29,0.186,122,2.303,154,2.727,155,2.727,157,3.043,158,3.522]],["title/62",[159,4.068]],["description/62",[17,0.94,29,0.186,122,2.303,154,2.727,155,2.727,159,3.043,160,3.522]]],"invertedIndex":[["access",{"_index":1,"title":{"1":{},"2":{},"3":{},"4":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{}}}],["access_token",{"_index":0,"title":{"0":{}},"description":{}}],["actual",{"_index":130,"title":{},"description":{"52":{}}}],["add",{"_index":33,"title":{"13":{},"15":{},"24":{}},"description":{"13":{},"15":{}}}],["alreadi",{"_index":110,"title":{},"description":{"45":{}}}],["anymore.<br><br><i>note:</i><br>not",{"_index":107,"title":{},"description":{"45":{}}}],["api/1/access_token/al",{"_index":11,"title":{},"description":{"3":{}}}],["api/1/access_token/cr",{"_index":6,"title":{},"description":{"1":{}}}],["api/1/access_token/{id",{"_index":9,"title":{},"description":{"2":{}}}],["api/1/access_token/{id}/delet",{"_index":13,"title":{},"description":{"4":{}}}],["api/1/authentication/authent",{"_index":126,"title":{},"description":{"51":{}}}],["api/1/authentication/persistent_login/cr",{"_index":145,"title":{},"description":{"55":{}}}],["api/1/authentication/persistent_login/{id",{"_index":146,"title":{},"description":{"56":{}}}],["api/1/authentication/persistent_login/{id}/delet",{"_index":149,"title":{},"description":{"58":{}}}],["api/1/authentication/persistent_login/{id}/refresh_token",{"_index":148,"title":{},"description":{"57":{}}}],["api/1/authentication/ticket/cr",{"_index":137,"title":{},"description":{"52":{}}}],["api/1/authentication/ticket/{ticketid",{"_index":138,"title":{},"description":{"53":{}}}],["api/1/authentication/ticket/{ticketid}/invalid",{"_index":140,"title":{},"description":{"54":{}}}],["api/1/monitoring/memori",{"_index":156,"title":{},"description":{"60":{}}}],["api/1/monitoring/statu",{"_index":158,"title":{},"description":{"61":{}}}],["api/1/monitoring/vers",{"_index":160,"title":{},"description":{"62":{}}}],["api/1/profile/by_existing_attribut",{"_index":85,"title":{},"description":{"40":{}}}],["api/1/profile/by_id",{"_index":80,"title":{},"description":{"37":{}}}],["api/1/profile/by_queri",{"_index":79,"title":{},"description":{"36":{}}}],["api/1/profile/by_rol",{"_index":83,"title":{},"description":{"39":{}}}],["api/1/profile/by_ticket",{"_index":76,"title":{},"description":{"33":{}}}],["api/1/profile/by_usernam",{"_index":74,"title":{},"description":{"32":{}}}],["api/1/profile/change_password",{"_index":94,"title":{},"description":{"42":{}}}],["api/1/profile/count",{"_index":77,"title":{},"description":{"34":{}}}],["api/1/profile/count_by_queri",{"_index":78,"title":{},"description":{"35":{}}}],["api/1/profile/cr",{"_index":43,"title":{},"description":{"19":{}}}],["api/1/profile/one_by_queri",{"_index":69,"title":{},"description":{"30":{}}}],["api/1/profile/rang",{"_index":82,"title":{},"description":{"38":{}}}],["api/1/profile/upd",{"_index":46,"title":{},"description":{"20":{}}}],["api/1/profile/verifi",{"_index":49,"title":{},"description":{"21":{}}}],["api/1/profile/verification_token/{id",{"_index":105,"title":{},"description":{"44":{}}}],["api/1/profile/verification_token/{id}/delet",{"_index":111,"title":{},"description":{"45":{}}}],["api/1/profile/{id",{"_index":71,"title":{},"description":{"31":{}}}],["api/1/profile/{id}/attach",{"_index":121,"title":{},"description":{"48":{}}}],["api/1/profile/{id}/attachment/{attachmentnam",{"_index":120,"title":{},"description":{"47":{}}}],["api/1/profile/{id}/attachment/{attachmentname}/detail",{"_index":123,"title":{},"description":{"49":{}}}],["api/1/profile/{id}/attribut",{"_index":57,"title":{},"description":{"26":{}}}],["api/1/profile/{id}/attributes/remov",{"_index":64,"title":{},"description":{"28":{}}}],["api/1/profile/{id}/attributes/upd",{"_index":63,"title":{},"description":{"27":{}}}],["api/1/profile/{id}/delet",{"_index":65,"title":{},"description":{"29":{}}}],["api/1/profile/{id}/dis",{"_index":53,"title":{},"description":{"23":{}}}],["api/1/profile/{id}/en",{"_index":51,"title":{},"description":{"22":{}}}],["api/1/profile/{id}/reset_password",{"_index":92,"title":{},"description":{"41":{}}}],["api/1/profile/{id}/roles/add",{"_index":55,"title":{},"description":{"24":{}}}],["api/1/profile/{id}/roles/remov",{"_index":56,"title":{},"description":{"25":{}}}],["api/1/profile/{id}/uploadattach",{"_index":118,"title":{},"description":{"46":{}}}],["api/1/profile/{id}/verification_token/cr",{"_index":103,"title":{},"description":{"43":{}}}],["api/1/tenant/al",{"_index":27,"title":{},"description":{"11":{}}}],["api/1/tenant/count",{"_index":25,"title":{},"description":{"10":{}}}],["api/1/tenant/cr",{"_index":16,"title":{},"description":{"6":{}}}],["api/1/tenant/upd",{"_index":20,"title":{},"description":{"8":{}}}],["api/1/tenant/{nam",{"_index":18,"title":{},"description":{"7":{}}}],["api/1/tenant/{name}/attribute_definitions/add",{"_index":40,"title":{},"description":{"15":{}}}],["api/1/tenant/{name}/attribute_definitions/remov",{"_index":42,"title":{},"description":{"17":{}}}],["api/1/tenant/{name}/attribute_definitions/upd",{"_index":41,"title":{},"description":{"16":{}}}],["api/1/tenant/{name}/delet",{"_index":21,"title":{},"description":{"9":{}}}],["api/1/tenant/{name}/roles/add",{"_index":35,"title":{},"description":{"13":{}}}],["api/1/tenant/{name}/roles/remov",{"_index":37,"title":{},"description":{"14":{}}}],["api/1/tenant/{name}/verify_new_profil",{"_index":32,"title":{},"description":{"12":{}}}],["assign",{"_index":54,"title":{},"description":{"24":{},"25":{}}}],["attach",{"_index":113,"title":{"46":{},"47":{},"48":{},"49":{}},"description":{"46":{},"47":{},"48":{},"49":{}}}],["attribut",{"_index":38,"title":{"15":{},"16":{},"17":{},"26":{},"27":{},"28":{},"40":{}},"description":{"15":{},"16":{},"17":{},"26":{},"27":{},"28":{},"40":{}}}],["attributes.</i",{"_index":62,"title":{},"description":{"27":{}}}],["authent",{"_index":124,"title":{"50":{},"51":{}},"description":{"50":{},"51":{},"52":{}}}],["b><i>/change_password</i></b",{"_index":101,"title":{},"description":{"43":{},"45":{}}}],["b><i>/verify</i></b",{"_index":100,"title":{},"description":{"43":{},"45":{}}}],["br><br",{"_index":58,"title":{},"description":{"27":{}}}],["call",{"_index":109,"title":{},"description":{"45":{}}}],["chang",{"_index":93,"title":{"42":{}},"description":{}}],["click",{"_index":97,"title":{},"description":{"43":{}}}],["correspond",{"_index":104,"title":{},"description":{"44":{}}}],["count",{"_index":22,"title":{"10":{},"34":{},"35":{}},"description":{}}],["crafter",{"_index":154,"title":{},"description":{"60":{},"61":{},"62":{}}}],["creat",{"_index":4,"title":{"1":{},"6":{},"19":{},"43":{},"52":{},"55":{}},"description":{"1":{},"6":{},"19":{},"43":{},"52":{},"55":{}}}],["definit",{"_index":39,"title":{},"description":{"15":{},"16":{},"17":{}}}],["delet",{"_index":12,"title":{"4":{},"9":{},"29":{},"45":{},"58":{}},"description":{"4":{},"9":{},"29":{},"45":{},"58":{}}}],["detail",{"_index":122,"title":{"49":{}},"description":{"49":{},"60":{},"61":{},"62":{}}}],["differ",{"_index":136,"title":{},"description":{"52":{}}}],["disabl",{"_index":52,"title":{"23":{}},"description":{"23":{}}}],["done",{"_index":131,"title":{},"description":{"52":{}}}],["email",{"_index":89,"title":{},"description":{"41":{},"43":{}}}],["enabl",{"_index":50,"title":{"22":{}},"description":{"22":{}}}],["exist",{"_index":10,"title":{},"description":{"3":{},"27":{}}}],["facebook",{"_index":134,"title":{},"description":{"52":{}}}],["fail",{"_index":117,"title":{},"description":{"46":{}}}],["function",{"_index":144,"title":{},"description":{"55":{}}}],["get",{"_index":119,"title":{},"description":{"47":{},"48":{}}}],["given",{"_index":15,"title":{},"description":{"6":{},"8":{},"13":{},"14":{},"15":{},"16":{},"17":{},"40":{},"44":{},"47":{},"48":{},"49":{},"53":{},"54":{},"56":{}}}],["i>note:</i",{"_index":59,"title":{},"description":{"27":{}}}],["i>th",{"_index":60,"title":{},"description":{"27":{}}}],["id",{"_index":70,"title":{"37":{}},"description":{"31":{},"37":{},"44":{},"53":{},"56":{}}}],["identifi",{"_index":125,"title":{},"description":{"51":{}}}],["indic",{"_index":90,"title":{},"description":{"41":{}}}],["info",{"_index":45,"title":{},"description":{"20":{},"53":{},"56":{}}}],["inform",{"_index":7,"title":{},"description":{"2":{}}}],["invalid",{"_index":139,"title":{"54":{}},"description":{"54":{}}}],["it’",{"_index":106,"title":{},"description":{"45":{}}}],["jvm",{"_index":155,"title":{},"description":{"60":{},"61":{},"62":{}}}],["link",{"_index":98,"title":{},"description":{"43":{}}}],["link.<br><br><i>note:</i><br>aft",{"_index":96,"title":{},"description":{"43":{}}}],["list",{"_index":26,"title":{},"description":{"11":{},"28":{},"37":{},"39":{},"40":{},"46":{}}}],["login",{"_index":142,"title":{"55":{},"56":{},"57":{},"58":{}},"description":{"55":{},"56":{},"57":{},"58":{}}}],["manag",{"_index":3,"title":{},"description":{"0":{},"5":{},"18":{}}}],["match",{"_index":68,"title":{},"description":{"30":{},"35":{},"36":{}}}],["mean",{"_index":133,"title":{},"description":{"52":{}}}],["memori",{"_index":152,"title":{"60":{}},"description":{"60":{}}}],["merg",{"_index":61,"title":{},"description":{"27":{}}}],["method",{"_index":128,"title":{},"description":{"52":{}}}],["mime",{"_index":115,"title":{},"description":{"46":{}}}],["monitor",{"_index":150,"title":{"59":{}},"description":{"59":{}}}],["necessari",{"_index":108,"title":{},"description":{"45":{}}}],["need",{"_index":91,"title":{},"description":{"41":{},"45":{}}}],["new",{"_index":5,"title":{"12":{}},"description":{"1":{},"12":{},"19":{},"52":{}}}],["number",{"_index":24,"title":{},"description":{"10":{},"34":{},"35":{}}}],["oper",{"_index":151,"title":{},"description":{"59":{}}}],["pass",{"_index":99,"title":{},"description":{"43":{}}}],["password",{"_index":87,"title":{"41":{},"42":{}},"description":{"41":{},"42":{}}}],["persist",{"_index":141,"title":{"55":{},"56":{},"57":{},"58":{}},"description":{"55":{},"56":{},"57":{},"58":{}}}],["profil",{"_index":29,"title":{"12":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"46":{},"47":{},"48":{},"49":{}},"description":{"12":{},"18":{},"19":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"47":{},"48":{},"49":{},"52":{},"60":{},"61":{},"62":{}}}],["profile.<br><br><i>note:</i><br>if",{"_index":114,"title":{},"description":{"46":{}}}],["profile.<br><br><i>note:</i><br>thi",{"_index":127,"title":{},"description":{"52":{}}}],["profile’",{"_index":44,"title":{},"description":{"20":{},"41":{},"42":{}}}],["queri",{"_index":66,"title":{"30":{},"35":{},"36":{}},"description":{"30":{},"35":{},"36":{}}}],["rang",{"_index":81,"title":{"38":{}},"description":{"38":{}}}],["refresh",{"_index":147,"title":{"57":{}},"description":{"57":{}}}],["rememb",{"_index":143,"title":{},"description":{"55":{}}}],["remov",{"_index":36,"title":{"14":{},"17":{},"25":{},"28":{}},"description":{"14":{},"17":{},"25":{},"28":{}}}],["request",{"_index":102,"title":{},"description":{"43":{},"47":{}}}],["reset",{"_index":86,"title":{"41":{}},"description":{"41":{},"42":{}}}],["return",{"_index":17,"title":{},"description":{"7":{},"10":{},"11":{},"26":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{},"44":{},"49":{},"51":{},"53":{},"56":{},"60":{},"61":{},"62":{}}}],["role",{"_index":34,"title":{"13":{},"14":{},"24":{},"25":{},"39":{}},"description":{"13":{},"14":{},"24":{},"25":{},"39":{}}}],["send",{"_index":88,"title":{},"description":{"41":{}}}],["sent",{"_index":95,"title":{},"description":{"43":{}}}],["set",{"_index":30,"title":{},"description":{"12":{},"21":{}}}],["singl",{"_index":67,"title":{},"description":{"30":{}}}],["specif",{"_index":8,"title":{},"description":{"2":{},"19":{},"39":{}}}],["specifi",{"_index":31,"title":{},"description":{"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"27":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"46":{},"52":{},"57":{}}}],["stat",{"_index":153,"title":{"60":{}},"description":{}}],["statu",{"_index":157,"title":{"61":{}},"description":{"61":{}}}],["tenant",{"_index":14,"title":{"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{}},"description":{"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"19":{},"32":{},"34":{},"35":{},"38":{},"39":{}}}],["through",{"_index":132,"title":{},"description":{"52":{}}}],["ticket",{"_index":75,"title":{"33":{},"52":{},"53":{},"54":{}},"description":{"33":{},"51":{},"52":{},"53":{},"54":{}}}],["token",{"_index":2,"title":{"1":{},"2":{},"3":{},"4":{},"43":{},"44":{},"45":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"21":{},"43":{},"44":{},"45":{},"57":{}}}],["total",{"_index":23,"title":{},"description":{"10":{}}}],["twitter",{"_index":135,"title":{},"description":{"52":{}}}],["type",{"_index":116,"title":{},"description":{"46":{}}}],["updat",{"_index":19,"title":{"8":{},"16":{},"20":{},"27":{}},"description":{"8":{},"16":{},"20":{},"27":{}}}],["upload",{"_index":112,"title":{"46":{}},"description":{"46":{}}}],["us",{"_index":129,"title":{},"description":{"52":{},"55":{}}}],["user",{"_index":73,"title":{},"description":{"32":{},"41":{},"43":{},"51":{}}}],["usernam",{"_index":72,"title":{"32":{}},"description":{"32":{}}}],["valid",{"_index":48,"title":{},"description":{"21":{},"46":{}}}],["valu",{"_index":84,"title":{"40":{}},"description":{"40":{}}}],["verif",{"_index":47,"title":{"43":{},"44":{},"45":{}},"description":{"21":{},"44":{},"45":{}}}],["verifi",{"_index":28,"title":{"12":{},"21":{}},"description":{"12":{},"21":{},"43":{}}}],["version",{"_index":159,"title":{"62":{}},"description":{"62":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/source/_static/api/social.html b/source/_static/api/social.html
index 7f31e4106..4e546f8b7 100644
--- a/source/_static/api/social.html
+++ b/source/_static/api/social.html
@@ -407,7 +407,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Social<!-- --> <span>(<!-- -->4.4.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Social API&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Social<!-- --> <span>(<!-- -->4.5.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Social API&lt;/p&gt;
 &lt;p&gt;All request in this API require the user to be authenticated with the following steps:&lt;/p&gt;
 &lt;ol&gt;
 &lt;li&gt;&lt;p&gt;Send a &lt;strong&gt;POST&lt;/strong&gt; request to the &lt;strong&gt;/crafter-social/crafter-security-login&lt;/strong&gt; endpoint with the &lt;strong&gt;&lt;em&gt;username&lt;/em&gt;&lt;/strong&gt; and &lt;strong&gt;&lt;em&gt;password&lt;/em&gt;&lt;/strong&gt; parameters&lt;/p&gt;
@@ -1501,7 +1501,7 @@
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Internal server error</p>
 </div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/api/3/monitoring/version</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:8080/crafter-social</span>/api/3/monitoring/version</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R177ka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R177ka»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R177ka»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ka»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R177ka»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ka»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R177ka»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R177ka»3" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R177ka»0" aria-labelledby="tab«R177ka»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"packageName"</span>: <span class="token string">&quot;Crafter Social&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packageVersion"</span>: <span class="token string">&quot;3.2.0-SNAPSHOT&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packageBuild"</span>: <span class="token string">&quot;a68f1ff7ad84d5ecbeaa008f392e4cef0ca02f41&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"packageBuildDate"</span>: <span class="token string">&quot;2020-03-07T21:03:05.422Z&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"osName"</span>: <span class="token string">&quot;Mac OS X&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"osVersion"</span>: <span class="token string">&quot;10.15.6&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"osArch"</span>: <span class="token string">&quot;x86_64&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"javaVersion"</span>: <span class="token string">&quot;11&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"javaVendor"</span>: <span class="token string">&quot;Oracle Corporation&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"javaVm"</span>: <span class="token string">&quot;OpenJDK 64-Bit Server VM&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177ka»1" aria-labelledby="tab«R177ka»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177ka»2" aria-labelledby="tab«R177ka»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177ka»3" aria-labelledby="tab«R177ka»3"></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080/crafter-social"}],"info":{"description":"Crafter Social API\n\nAll request in this API require the user to be authenticated with the following steps:\n\n1. Send a **POST** request to the **/crafter-social/crafter-security-login** endpoint with the **_username_** and **_password_** parameters\n\n2. Include the cookies set in the response of the login in later requests\n\nBesides setting the authentication cookies the login response also provides the user’s information:\n\n```\n{\n    \"ticket\":\"0489ca78-cd96-46c2-bc96-c1ea1fa4db6f\",\n    \"profile\":{\n        \"username\":\"admin\",\n        \"password\":null,\n        \"email\":\"admin@example.com\",\n        \"verified\":false,\n        \"enabled\":true,\n        \"createdOn\":1554832283831,\n        \"lastModified\":1554834126479,\n        \"tenant\":\"default\",\n        \"roles\":[\n            \"SOCIAL_SUPERADMIN\",\n            \"PROFILE_SUPERADMIN\"\n        ],\n        \"attributes\":{\n            \"socialContexts\":[\n                {\n                    \"name\":\"Default\",\n                    \"id\":\"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9\",\n                    \"roles\":[\n                        \"SOCIAL_ADMIN\",\n                        \"SOCIAL_MODERATOR\",\n                        \"SOCIAL_USER\"\n                    ]\n                }\n            ]\n        },\n        \"failedLoginAttempts\":0,\n        \"lastFailedLogin\":null,\n        \"id\":\"5cacdb9b386f920d482a5ad4\"\n    },\n    \"remembered\":false\n}\n```","version":"4.4.4","title":"Crafter Social","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Social","url":"https://craftercms.com/docs/current/reference/modules/social.html"},"tags":[{"name":"actions","description":"Security Actions"},{"name":"context","description":"Social contexts management"},{"name":"profile","description":"Profile management"},{"name":"comments","description":"User generated content comments management"},{"name":"attachments","description":"User generated content attachments management"},{"name":"votes","description":"User generated content votes management"},{"name":"threads","description":"User generated content threads management"},{"name":"monitoring","description":"Monitoring operations"}],"paths":{"/api/3/system/actions":{"get":{"security":[],"tags":["actions"],"summary":"Get Current Actions","operationId":"getCurrentActions","description":"Gets all Security Actions for current context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"example":[{"actionName":"ugc.update","roles":["SOCIAL_SUPERADMIN","OWNER","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358b"},{"actionName":"ugc.moderate","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358c"},{"actionName":"ugc.unflag","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358d"},{"actionName":"ugc.flag","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358e"},{"actionName":"ugc.create","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358f"},{"actionName":"ugc.delete","roles":["SOCIAL_SUPERADMIN","OWNER","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353590"},{"actionName":"ugc.read","roles":["ANONYMOUS","SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353591"},{"actionName":"system.securityActions.read","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353592"},{"actionName":"system.securityActions.update","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353593"},{"actionName":"system.socialctx.all","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353594"},{"actionName":"system.socialctx.create","roles":["SOCIAL_SUPERADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353595"},{"actionName":"system.socialctx.addProfile","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353596"},{"actionName":"system.socialctx.removeProfile","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353597"},{"actionName":"system.notification.changeTemplate","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be3535ab"},{"actionName":"ugc.voting","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be3535ca"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"security":[],"tags":["actions"],"summary":"Update Actions","operationId":"updateActions","description":"Updates the given action name with the Roles.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"actionName","in":"query","description":"The name of the action to update","required":true,"schema":{"type":"string"},"example":"ugc.moderate"},{"name":"roles","in":"query","description":"List of roles to assign to the action","required":true,"schema":{"type":"string"},"example":"CUSTOM_MODERATOR,SOCIAL_SUPERADMIN,SOCIAL_ADMIN,SOCIAL_MODERATOR"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"},"example":{"actionName":"ugc.moderate","roles":["SOCIAL_SUPERADMIN","CUSTOM_MODERATOR","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358c"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/all":{"get":{"security":[],"tags":["context"],"summary":"Get All Social Contexts","operationId":"getAllSocialContexts","description":"Returns a list of all Social Contexts.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Context"}},"example":[{"contextName":"Default","_id":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}]}}},"400":{"$ref":"#/components/responses/Unauthorized"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/":{"post":{"security":[],"tags":["context"],"summary":"Create Social Context","operationId":"createSocialContext","description":"Creates a new Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contextName":{"type":"string","description":"The name of the new Social Context","example":"site1"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Context"},"example":{"contextName":"site1","_id":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/{id}/{profileId}":{"post":{"security":[],"tags":["context"],"summary":"Add Profile To Social Context","operationId":"addProfileToSocialContext","description":"Updates the socialContext attribute in the given profile to include the Social Context ID and the list of roles assigned for that context.","parameters":[{"name":"id","in":"path","description":"The ID of the Social Context to add","required":true,"schema":{"type":"string"},"example":"e41e7273-b504-4d50-9edd-3b215eff6464"},{"name":"profileId","in":"path","description":"The ID of the profile to update","required":true,"schema":{"type":"string"},"example":"596683c030047dc279c21d27"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"roles":{"type":"string","description":"The list of roles to assign","example":"SOCIAL_USER"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextProfile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":"2017-07-12T14:17Z","lastModified":"2017-07-12T14:37Z","tenant":"sample-tenant","roles":[],"attributes":{"firstName":"John","lastName":"Doe","socialContexts":[{"roles":["SOCIAL_USER"],"name":"site1","id":"e41e7273-b504-4d50-9edd-3b215eff6464"}]},"id":"596683c030047dc279c21d27"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/{id}/{profileId}/delete":{"post":{"security":[],"tags":["context"],"summary":"Remove Profile from Social Context","operationId":"removeProfileFromSocialContext","description":"Updates the socialContext attribute in the given profile to remove the Social Context ID and the list of roles assigned for that context.","parameters":[{"name":"id","in":"path","description":"The ID of the Social Context to remove","required":true,"schema":{"type":"string"},"example":"e41e7273-b504-4d50-9edd-3b215eff6464"},{"name":"profileId","in":"path","description":"The ID of the profile to update","required":true,"schema":{"type":"string"},"example":"596683c030047dc279c21d27"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextProfile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":"2024-07-12T14:17Z","lastModified":"2024-07-12T14:37Z","tenant":"sample-tenant","roles":[],"attributes":{"firstName":"John","lastName":"Doe","socialContexts":[]},"id":"596683c030047dc279c21d27"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/preferences/email/config":{"post":{"security":[],"tags":["context"],"summary":"Update Email Configuration","operationId":"updateEmailConfiguration","description":"Updates the email configuration for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"encoding":{"type":"string","description":"Character encoding for the email body","example":"UTF-8"},"host":{"type":"string","description":"The hostname of the email server","example":"mail.example.com"},"port":{"type":"string","description":"The port of the email server","example":25},"auth":{"type":"boolean","description":"Enable if the email server requires authentication","example":true},"username":{"type":"string","description":"The username for the email server","example":"user"},"password":{"type":"string","description":"The password for the email server","example":"passw0rd"},"tls":{"type":"boolean","description":"Enable if the email server requires a secure connection","example":true},"replyTo":{"type":"string","description":"Email address used for replies","example":"reply@example.com"},"from":{"type":"string","description":"Email address used to send notifications","example":"site1@example.com"},"priority":{"type":"integer","description":"The priority for the emails","example":3},"subject":{"type":"string","description":"The subject for the emails","example":"Site1 Updates"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextEmailConfiguration"},"example":{"password":"passw0rd","port":25,"auth":true,"subject":"Site1 Updates","host":"mail.example.com","replyTo":"reply@example.com","tls":true,"from":"site1@example.com","encoding":"UTF-8","priority":3,"username":"user"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["context"],"summary":"Get Email Configuration","operationId":"getEmailConfiguration","description":"Returns an email configuration for a given Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextEmailConfiguration"},"example":{"host":"localhost","encoding":"UTF-8","port":25,"auth":false,"username":"","password":"","tls":false,"replyTo":"social@example.com","from":"social@example.com","priority":5,"subject":"Latest change on your subscribed threads for Social"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/preferences/email":{"post":{"security":[],"tags":["context"],"summary":"Update Email Template","operationId":"updateEmailTemplate","description":"Updates an email template for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"template":{"type":"string","description":"The body of the email template","example":"Sample template for email"},"type":{"type":"string","description":"The type of the email template<br>\nThe possible values for the type parameter are:\n<ul>\n<li>DAILY</li>\n<li>WEEKLY</li>\n<li>INSTANT</li>\n<li>APPROVEREMAIL</li>\n<li>APPROVER_RESULT_TEMPLATE</li>\n</ul>","example":"INSTANT"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["context"],"summary":"Get Email Template","operationId":"getEmailTemplate","description":"Returns an email template for a given Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"The type of the email template<br>\nThe possible values for the type parameter are:\n<ul>\n<li>DAILY</li>\n<li>WEEKLY</li>\n<li>INSTANT</li>\n<li>APPROVEREMAIL</li>\n<li>APPROVER_RESULT_TEMPLATE</li>\n</ul>"},"example":"INSTANT"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":"string"}}},"example":{"template":"Hi ${profile.username} this are changes that happen on your subscribe Threads<#list digest as change><h1> ${change[\"_id\"]} </h1><dl><#list change.ugcList as ugc><dt>Subject</dt><dd> ${ugc.subject!\"\"} </dd><dt>Body</dt>  <dd>${ugc.body!\"\"} </dd><dt>Changed by<dt><dd>${ugc.lastModifiedBy.username}<dd></#list></dl></#list>"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/preferences":{"get":{"security":[],"tags":["context"],"summary":"Get Context Preferences","operationId":"getContextPreferences","description":"Returns the preferences for a given Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextPreferences"},"example":{"preferences":{"hiddenUgcStatus":"SPAM,TRASH","moderateByMailEnable":"false","moderateByMailRole":"SOCIAL_APPROVER","moderateByMailSubject":"A new Comment needs to be approved","timezone":"EST","baseUrl":"http://example.com","setupAutoWatch":false,"defaultFrequency":"INSTANT"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/updatePreferences":{"post":{"security":[],"tags":["context"],"summary":"Update Context Preferences","operationId":"updateContextPreferences","description":"Updates the preferences for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"additionalProperties":{"description":"Preferences that will be updated","example":{"moderateByMailEnable":true}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/deletePreferences":{"post":{"security":[],"tags":["context"],"summary":"Delete Context Preferences","operationId":"deleteContextPreferences","description":"Deletes the preferences for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"moderateByMailEnable":{"type":"boolean"},"moderateByMailRole":{"type":"string"},"moderateByMailSubject":{"type":"string"},"timezone":{"type":"string"},"baseUrl":{"type":"string"},"setupAutoWatch":{"type":"boolean"},"defaultFrequency":{"type":"string"},"hiddenUgcStatus":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/profile/clear":{"get":{"security":[],"tags":["profile"],"summary":"Clear Cache","operationId":"clearCache","description":"Clears the Profile Aggregator Cache.","parameters":[{"name":"profileIds","in":"query","description":"List of IDs to be removed from the Cache. <br><br>\nIf the <b>profileIds</b> parameter is empty or not included in the request, all profiles in the cache will be cleared.","required":true,"schema":{"type":"string"},"example":""}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments":{"post":{"security":[],"tags":["comments"],"summary":"Create Comment","operationId":"createComment","description":"Creates a new comment and creates a new thread if needed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"thread":{"type":"string","description":"Id of the thread to attach this comment"},"parent":{"type":"string","description":"Id of the parent for the new comment"},"anonymous":{"type":"boolean","description":"Should the comment be posted as anonymous"},"subject":{"type":"string","description":"Subject of the comment to be created"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"},"attachment":{"type":"string","format":"binary","description":"Binary file to include in the comment"}},"required":["context","body","thread"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}":{"put":{"security":[],"tags":["comments"],"summary":"Update Comment","operationId":"updateCommentPut","description":"Replace the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to replace","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["comments"],"summary":"Get Comment","operationId":"getComment","description":"Returns the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Comment","operationId":"deleteCommentD","description":"Delete the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to delete","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"boolean","example":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/delete":{"post":{"security":[],"tags":["comments"],"summary":"Delete Comment","operationId":"deleteCommentP","description":"Deletes the given comment and all its children.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to delete","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/update":{"post":{"security":[],"tags":["comments"],"summary":"Update Comment","operationId":"updateComment","description":"Updates the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/search":{"post":{"security":[],"tags":["comments"],"summary":"Search Comments","operationId":"searchComment","description":"Returns all comments that match the search parameter.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the social context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"search":{"type":"string","description":"MongoDB query (except $where)","example":{"targetId":"Welcome"}},"sortBy":{"type":"string","description":"MongoDB sort string","example":{"lastModifiedDate":1}},"start":{"type":"integer","description":"Starting position for pagination","example":0},"limit":{"type":"integer","description":"Final position for pagination","example":5}},"required":["context","search","sortBy","start","limit"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialComment"}},"example":[{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attributes":{"post":{"security":[],"tags":["comments"],"summary":"Update Comment Attributes","operationId":"updateCommentAttributesPost","description":"Updates the attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"All additional parameters included in the request will be added as custom attributes in the comment."}},"example":{"customProperty":true,"anotherCustomProperty":1}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"security":[],"tags":["comments"],"summary":"Update Comment Attributes","operationId":"updateCommentAttributesPut","description":"Updates the attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"All additional parameters included in the request will be added as custom attributes in the comment."}},"example":{"customProperty":true,"anotherCustomProperty":1}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Comment Attributes","operationId":"deleteCommentAttributes","description":"Deletes attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"description":"List of attribute names to delete","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attributes/delete":{"post":{"security":[],"tags":["comments"],"summary":"Delete Comment Attributes","operationId":"deleteCommentAttributesP","description":"Updates the attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"All additional parameters included in the request will be added as custom attributes in the comment."}},"example":{"customProperty":true,"anotherCustomProperty":1}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/flags":{"post":{"security":[],"tags":["comments"],"summary":"Update Comment Flags","operationId":"updateCommentFlags","description":"Adds a flag to the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"description":"Reason why the comment is flagged","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[{"reason":"Contains offensive language","userId":"59667e8abd4787992596ba6b","_id":"5967e35f300426156e21df58"}],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["comments"],"summary":"Get Comment Flags","operationId":"getCommentFlags","description":"Returns all the flags for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsFlags"}},"example":[{"reason":"Contains offensive language","userId":"59667e8abd4787992596ba6b","_id":"5967e35f300426156e21df58"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/flags/{flagId}":{"post":{"security":[],"tags":["comments"],"summary":"Delete Comment Flags","operationId":"deleteCommentFlagsP","description":"Deletes a flag for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"flagId","in":"path","description":"The ID of the flag","required":true,"schema":{"type":"string"},"example":"5967e35f300426156e21df58"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Comment Flags","operationId":"deleteCommentFlagsD","description":"Deletes a flag for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"flagId","in":"path","description":"The ID of the flag","required":true,"schema":{"type":"string"},"example":"5967e35f300426156e21df58"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/moderate":{"post":{"security":[],"tags":["comments"],"summary":"Moderate Comment","operationId":"moderateCommentPost","description":"Changes the moderation status of the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"The new moderation status","type":"string","example":"APPROVED"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"security":[],"tags":["comments"],"summary":"Moderate Comment","operationId":"moderateCommentPut","description":"Changes the moderation status of the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"The new moderation status","type":"string","example":"APPROVED"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/moderation/{status}":{"get":{"security":[],"tags":["comments"],"summary":"Get Comments By Moderation Status","operationId":"getCommentsByModerationStatus","description":"Returns all the comments with a given moderation status.","parameters":[{"name":"status","in":"path","description":"The moderation status to search","required":true,"schema":{"type":"string"},"example":"APPROVED"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"thread","in":"query","description":"The ID of the thread to search","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/moderation/{status}/count":{"get":{"security":[],"tags":["comments"],"summary":"Count Comments By Moderation Status","operationId":"countCommentsByModerationStatus","description":"Returns the number of comments with a given moderation status.","parameters":[{"name":"status","in":"path","description":"The moderation status to search","required":true,"schema":{"type":"string"},"example":"APPROVED"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"thread","in":"query","description":"The ID of the thread to search","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer"},"example":1}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/flagged":{"get":{"security":[],"tags":["comments"],"summary":"Get Flagged Comments","operationId":"getFlaggedComments","description":"Returns all the comments with at least one flag.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":[{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/flagged/count":{"get":{"security":[],"tags":["comments"],"summary":"Count Flagged Comments","operationId":"countFlaggedComments","description":"Returns the number of comments with at least one flag.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer"},"example":1}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments":{"get":{"security":[],"tags":["attachments"],"summary":"Get Attachments","operationId":"getAttachments","description":"Returns all the attachments for a given comment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsAttachments"}},"example":[{"md5":"1300018473cc0038187aaa0e2604fa27","fileId":"5967ac48300426156e21df51","contentType":"image/png","fileSize":"1.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/image1.png","fileName":"image1.png","savedDate":"2017-07-13T11:22Z","fileSizeBytes":1497,"attributes":{"owner":"59678d3f300426156e21df50"}}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"security":[],"tags":["comments"],"summary":"Create Attachment","operationId":"createAttachment","description":"Creates an attachment in a given comment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"string","format":"binary","description":"Binary file to add as attachment","example":"Binary content"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsAttachments"}},"example":{"md5":"1300018473cc0038187aaa0e2604fa27","fileId":"5967ac48300426156e21df51","contentType":"image/png","fileSize":"1.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/image1.png","fileName":"image1.png","savedDate":"2017-07-13T11:22Z","fileSizeBytes":1497,"attributes":{"owner":"59678d3f300426156e21df50"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments/{attachmentId}":{"get":{"security":[],"tags":["attachments"],"summary":"Get Attachment Content","operationId":"getAttachmentContent","description":"Returns the content of a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"the content of the attachment"},"example":"Binary content"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Attachment","operationId":"deleteAttachmentD","description":"Deletes a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments/{attachmentId}/delete":{"post":{"security":[],"tags":["attachments"],"summary":"Delete Attachment","operationId":"deleteAttachmentP","description":"Deletes a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments/{attachmentId}/update":{"post":{"security":[],"tags":["attachments"],"summary":"Update Attachment Content","operationId":"deleteAttachmentP","description":"Deletes a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The content of the attachment","example":"Binary content"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/votes/up":{"post":{"security":[],"tags":["votes"],"summary":"Vote Up","operationId":"voteUp","description":"Toggles a vote up in the given comment from the currently logged user.","parameters":[{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":["59667e8abd4787992596ba6b"],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/votes/down":{"post":{"security":[],"tags":["votes"],"summary":"Vote Down","operationId":"voteDown","description":"Toggles a vote down in the given comment from the currently logged user.","parameters":[{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":[],"votesDown":["59667e8abd4787992596ba6b"],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/votes/neutral":{"post":{"security":[],"tags":["votes"],"summary":"Remove Votes","operationId":"removeVotes","description":"Clears both up and down votes in the given comment for the currently logged user.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/comments":{"get":{"security":[],"tags":["threads"],"summary":"Get Thread Comments","operationId":"getThreadComments","description":"Returns all comments from the given thread.","parameters":[{"name":"id","in":"path","description":"The ID of the thread","required":true,"schema":{"type":"string"},"example":"Welcome"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"recursive","in":"query","description":"Levels of comments to return","schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"childrenCount","in":"query","description":"Amount of children to return","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialCommentsThread"},"example":{"total":1,"pageSize":666,"pageNumber":0,"watched":false,"comments":[{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T11:06Z","anonymousFlag":false,"attributes":{},"children":[],"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/comments/{commentId}/children":{"get":{"security":[],"tags":["threads"],"summary":"Get Comment Children","operationId":"getCommentChildren","description":"Returns all children for a given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the thread","required":true,"schema":{"type":"string"},"example":"Welcome"},{"name":"commentId","in":"path","description":"The ID of the comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"recursive","in":"query","description":"Levels of comments to return","schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"childrenCount","in":"query","description":"Amount of children to return","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialCommentsThread"},"example":{"total":1,"pageSize":666,"pageNumber":0,"watched":false,"comments":[{"ancestors":["59678d3f300426156e21df50"],"targetId":"Welcome","subject":"","body":"This is a response.","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T11:06Z","anonymousFlag":false,"attributes":{},"children":[],"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/subscribe":{"post":{"security":[],"tags":["threads"],"summary":"Subscribe","operationId":"subscribePost","description":"Subscribes the current user to a given thread","parameters":[{"name":"id","in":"path","description":"The ID of the thread to subscribe to","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"frequency":{"type":"string","description":"Type of notifications to receive.\nThe possible values are:\n- weekly\n- daily\n- instant"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"security":[],"tags":["threads"],"summary":"Subscribe","operationId":"subscribePut","description":"Subscribes the current user to a given thread","parameters":[{"name":"id","in":"path","description":"The ID of the thread to subscribe to","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"frequency":{"type":"string","description":"Type of notifications to receive.\nThe possible values are:\n- weekly\n- daily\n- instant"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/subscribe/update":{"post":{"security":[],"tags":["threads"],"summary":"Update Subscription","operationId":"updateSubscription","description":"Updates subscription of the current user","parameters":[{"name":"id","in":"path","description":"The ID of the thread to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"frequency":{"type":"string","example":"daily","description":"Type of notifications to receive.\nThe possible values are:\n- weekly\n- daily\n- instant"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/unsubscribe":{"post":{"security":[],"tags":["threads"],"summary":"Unsubscribe","operationId":"unsubscribeP","description":"Unsubscribes the current user to a given thread.","parameters":[{"name":"id","in":"path","description":"The ID of the thread to unsubscribe","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["threads"],"summary":"Unsubscribe","operationId":"unsubscribeD","description":"Unsubscribes the current user to a given thread.","parameters":[{"name":"id","in":"path","description":"The ID of the thread to unsubscribe.","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/monitoring/memory":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Memory Stats","operationId":"getMemoryStats","description":"Returns the Crafter Social JVM memory details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringJVMMemoryStats"},"example":{"totalJvmMemory":2017984512,"freeJvmMemory":1113921056,"maxJvmMemory":3817865216,"totalOsMemory":17179869184,"freeOsMemory":2669301760,"totalSwapMemory":2147483648,"freeSwapMemory":1026555904}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/monitoring/status":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Status","operationId":"getStatus","description":"Returns the Crafter Social JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatus"},"example":{"uptime":4801,"startup":"2019-03-07T21:29:11.049Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/monitoring/version":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Version","operationId":"getVersion","description":"Returns the Crafter Social JVM version details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringJVMVersion"},"example":{"packageName":"Crafter Social","packageVersion":"3.2.0-SNAPSHOT","packageBuild":"a68f1ff7ad84d5ecbeaa008f392e4cef0ca02f41","packageBuildDate":"2020-03-07T21:03:05.422Z","osName":"Mac OS X","osVersion":"10.15.6","osArch":"x86_64","javaVersion":"11","javaVendor":"Oracle Corporation","javaVm":"OpenJDK 64-Bit Server VM"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"Action":{"type":"object","properties":{"actionName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"contextId":{"type":"string"},"_id":{"type":"string"}}},"SocialContextProfile":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string"},"verified":{"type":"boolean"},"enabled":{"type":"boolean"},"createdOn":{"type":"number"},"lastModified":{"type":"number"},"tenant":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"$ref":"#/components/schemas/ProfileAttributes"},"id":{"type":"string"}}},"Context":{"type":"object","description":"Object containing social context for given ID","properties":{"contextName":{"type":"string"},"_id":{"type":"string"}}},"SocialContext":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"id":{"type":"string"}}},"ProfileAttributes":{"type":"object","description":"Object containing attributes for the profile","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"socialContexts":{"type":"array","items":{"$ref":"#/components/schemas/SocialContext"}}}},"SocialContextEmailConfiguration":{"type":"object","properties":{"password":{"type":"string"},"port":{"type":"integer"},"auth":{"type":"boolean"},"subject":{"type":"string"},"host":{"type":"string"},"replyTo":{"type":"string"},"tls":{"type":"boolean"},"from":{"type":"string"},"encoding":{"type":"string"},"priority":{"type":"integer"},"username":{"type":"string"}}},"SocialContextPreferences":{"type":"object","properties":{"moderateByMailEnable":{"type":"boolean"},"moderateByMailRole":{"type":"string"},"moderateByMailSubject":{"type":"string"},"timezone":{"type":"string"},"baseUrl":{"type":"string"},"setupAutoWatch":{"type":"boolean"},"defaultFrequency":{"type":"string"},"hiddenUgcStatus":{"type":"string"}}},"SocialCommentsAttachments":{"type":"object","properties":{"md5":{"type":"string"},"fileId":{"type":"string"},"contentType":{"type":"string"},"fileSize":{"type":"string"},"storeName":{"type":"string"},"fileName":{"type":"string"},"savedDate":{"type":"string","format":"date-time"},"fileSizeBytes":{"type":"integer"},"additionalProperties":{"type":"string"}}},"SocialCommentsFlags":{"type":"object","properties":{"reason":{"type":"string"},"userId":{"type":"string"},"_id":{"type":"string"}}},"SocialComment":{"type":"object","properties":{"ancestors":{"type":"array"},"targetId":{"type":"string"},"subject":{"type":"string"},"body":{"type":"string"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"anonymousFlag":{"type":"boolean"},"attributes":{"type":"object"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsAttachments"}},"moderationStatus":{"type":"string"},"votesUp":{"type":"array"},"votesDown":{"type":"array"},"flags":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsFlags"}},"_id":{"type":"string"}}},"SocialCommentsThread":{"type":"object","properties":{"total":{"type":"integer"},"pageSize":{"type":"integer"},"pageNumber":{"type":"integer"},"watched":{"type":"boolean"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/SocialComment"}}}},"MonitoringJVMMemoryStats":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","format":"int64"},"freeJvmMemory":{"type":"integer","format":"int64"},"maxJvmMemory":{"type":"integer","format":"int64"},"totalOSMemory":{"type":"integer","format":"int64"},"freeOSMemory":{"type":"integer","format":"int64"},"totalSwapMemory":{"type":"integer","format":"int64"},"freeSwapMemory":{"type":"integer","format":"int64"}}},"MonitoringStatus":{"type":"object","properties":{"uptime":{"type":"integer","format":"int32"},"startup":{"type":"string","format":"date-time"}}},"MonitoringJVMVersion":{"type":"object","properties":{"packageName":{"type":"string"},"packageVersion":{"type":"string"},"packageBuild":{"type":"string"},"packageBuildDate":{"type":"string","format":"date-time"},"osName":{"type":"string"},"osVersion":{"type":"string"},"osArch":{"type":"string"},"javaVersion":{"type":"string"},"javaVendor":{"type":"string"},"javaVm":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"access_token":{"value":{"errorCode":"ACTION_DENIED","message":"Current subject does not have permission to execute global action \"CREATE_TOKEN\""}},"tenant":{"value":{"errorCode":"TENANT_EXISTS","message":"The tenant \"sample-tenant\" already exists"}},"profile":{"value":{"errorCode":"PROFILE_EXISTS","message":"A profile with name \"john.doe\" already exists"}},"comments":{"value":{"message":"Unable to find ugc with id ..."}},"commentsAttachments":{"value":{"message":"Given Attachment id is not valid"}},"commentsAttachmentSize":{"value":{"message":"Maximum upload size of ... bytes exceeded"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"context":{"value":{"message":"SOCIAL_SUPERADMIN is not a valid role"}},"monitoring":{"value":{"message":"”Required String parameter ‘token’ is not present”"}},"comments":{"value":{"message":"UGC with given Id does not exist"}},"attachment":{"value":{"message":"Given Attachment id is not valid"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"authentication":{"value":{"message":"User must be logged in"}},"monitoring":{"value":{"message":"”Management authorization failed, invalid token.”"}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"accessToken":{"value":{"message":"Current subject does not have permission to execute global action ...\""}},"profile":{"value":{"message":"Profile \\\"59284659d4c650213cc2f3fc\\\" of tenant \\\"sample-tenant\\\" is disabled"}},"authentication":{"value":{"message":"No access token found for ID \\\"e8f5170c-877b-416f-b70f-4b09772f8e2d\\\""}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}}}}}},"searchIndex":{"store":["tag/actions","tag/actions/operation/getCurrentActions","tag/actions/operation/updateActions","tag/context","tag/context/operation/getAllSocialContexts","tag/context/operation/createSocialContext","tag/context/operation/addProfileToSocialContext","tag/context/operation/removeProfileFromSocialContext","tag/context/operation/updateEmailConfiguration","tag/context/operation/getEmailConfiguration","tag/context/operation/updateEmailTemplate","tag/context/operation/getEmailTemplate","tag/context/operation/getContextPreferences","tag/context/operation/updateContextPreferences","tag/context/operation/deleteContextPreferences","tag/profile","tag/profile/operation/clearCache","tag/comments","tag/comments/operation/createComment","tag/comments/operation/updateCommentPut","tag/comments/operation/getComment","tag/comments/operation/deleteCommentD","tag/comments/operation/deleteCommentP","tag/comments/operation/updateComment","tag/comments/operation/searchComment","tag/comments/operation/updateCommentAttributesPost","tag/comments/operation/updateCommentAttributesPut","tag/comments/operation/deleteCommentAttributes","tag/comments/operation/deleteCommentAttributesP","tag/comments/operation/updateCommentFlags","tag/comments/operation/getCommentFlags","tag/comments/operation/deleteCommentFlagsP","tag/comments/operation/deleteCommentFlagsD","tag/comments/operation/moderateCommentPost","tag/comments/operation/moderateCommentPut","tag/comments/operation/getCommentsByModerationStatus","tag/comments/operation/countCommentsByModerationStatus","tag/comments/operation/getFlaggedComments","tag/comments/operation/countFlaggedComments","tag/comments/operation/createAttachment","tag/comments/operation/deleteAttachmentD","tag/attachments","tag/attachments/operation/getAttachments","tag/attachments/operation/getAttachmentContent","tag/attachments/operation/deleteAttachmentP","tag/attachments/operation/deleteAttachmentP","tag/votes","tag/votes/operation/voteUp","tag/votes/operation/voteDown","tag/votes/operation/removeVotes","tag/threads","tag/threads/operation/getThreadComments","tag/threads/operation/getCommentChildren","tag/threads/operation/subscribePost","tag/threads/operation/subscribePut","tag/threads/operation/updateSubscription","tag/threads/operation/unsubscribeP","tag/threads/operation/unsubscribeD","tag/monitoring","tag/monitoring/operation/getMemoryStats","tag/monitoring/operation/getStatus","tag/monitoring/operation/getVersion"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.884]],["description/0",[0,3.099,1,4.402]],["title/1",[0,2.308,2,1.821]],["description/1",[0,2.233,1,3.172,2,1.761,3,3.675,4,1.057,5,3.172]],["title/2",[0,2.308,6,1.046]],["description/2",[0,2.233,5,3.172,6,1.012,7,0.387,8,3.675,9,2.842]],["title/3",[4,1.365]],["description/3",[4,1.337,10,1.459,11,2.825]],["title/4",[4,1.092,10,1.192]],["description/4",[4,1.136,10,1.239,12,1.295,13,3.055,14,3.95]],["title/5",[4,0.91,10,0.993,15,1.924]],["description/5",[4,1.136,10,1.239,15,2.401,16,3.411,17,3.95]],["title/6",[4,0.781,10,0.851,18,2.343,19,1.545]],["description/6",[4,1.054,6,0.649,7,0.248,9,1.823,10,0.74,13,1.823,19,1.342,20,2.035,21,1.13,22,2.357,23,2.035,24,2.035,25,2.357]],["title/7",[4,0.781,10,0.851,19,1.545,26,2.098]],["description/7",[4,1.054,6,0.649,7,0.248,9,1.823,10,0.74,13,1.823,19,1.342,20,2.035,21,1.13,23,2.035,24,2.035,26,1.823,27,2.357]],["title/8",[6,0.872,28,1.696,29,2.235]],["description/8",[4,0.988,6,0.946,7,0.362,10,1.078,28,1.841,29,2.425,30,2.965]],["title/9",[28,2.035,29,2.682]],["description/9",[4,0.988,7,0.362,10,1.078,12,1.126,28,1.841,29,2.425,30,2.965]],["title/10",[6,0.872,28,1.696,31,2.235]],["description/10",[4,0.988,6,0.946,7,0.362,10,1.078,28,1.841,31,2.425,32,2.965]],["title/11",[28,2.035,31,2.682]],["description/11",[4,0.988,7,0.362,10,1.078,12,1.126,28,1.841,31,2.425,32,2.965]],["title/12",[4,1.092,33,2.308]],["description/12",[4,1.057,7,0.387,10,1.153,12,1.205,33,2.233,34,3.675]],["title/13",[4,0.91,6,0.872,33,1.924]],["description/13",[4,1.057,6,1.012,7,0.387,10,1.153,33,2.233,35,3.675]],["title/14",[4,0.91,33,1.924,36,1.038]],["description/14",[4,1.057,7,0.387,10,1.153,33,2.233,36,1.205,37,3.675]],["title/15",[19,2.702]],["description/15",[11,3.099,19,2.903]],["title/16",[38,2.937,39,3.279]],["description/16",[19,2.249,38,3.055,39,3.411,40,3.95,41,3.95]],["title/17",[42,0.208]],["description/17",[11,2.401,42,0.173,43,1.709,44,2.789,45,2.249]],["title/18",[15,2.308,42,0.166]],["description/18",[15,2.815,16,3.999,42,0.141,46,1.632,47,3.224,48,3.224]],["title/19",[6,1.046,42,0.166]],["description/19",[7,0.45,42,0.187,49,4.271,50,3.303]],["title/20",[42,0.208]],["description/20",[7,0.45,12,1.4,42,0.187,50,3.303]],["title/21",[36,1.245,42,0.166]],["description/21",[7,0.45,36,1.4,42,0.187,50,3.303]],["title/22",[36,1.245,42,0.166]],["description/22",[7,0.416,36,1.295,42,0.173,51,3.055,52,3.95]],["title/23",[6,1.046,42,0.166]],["description/23",[6,1.177,7,0.45,42,0.187,53,4.271]],["title/24",[42,0.166,54,3.279]],["description/24",[12,1.205,42,0.161,54,3.172,55,3.675,56,3.675,57,3.675]],["title/25",[6,0.872,21,1.517,42,0.138]],["description/25",[6,1.088,7,0.416,21,1.894,42,0.173,58,3.055]],["title/26",[6,0.872,21,1.517,42,0.138]],["description/26",[6,1.088,7,0.416,21,1.894,42,0.173,58,3.055]],["title/27",[21,1.517,36,1.038,42,0.138]],["description/27",[7,0.416,21,1.894,36,1.295,42,0.173,58,3.055]],["title/28",[21,1.517,36,1.038,42,0.138]],["description/28",[6,1.088,7,0.416,21,1.894,42,0.173,59,3.95]],["title/29",[6,0.872,42,0.138,60,1.37]],["description/29",[7,0.416,18,3.411,42,0.173,60,1.709,61,3.411]],["title/30",[42,0.166,60,1.643]],["description/30",[7,0.416,12,1.295,42,0.173,60,1.709,61,3.411]],["title/31",[36,1.038,42,0.138,60,1.37]],["description/31",[7,0.416,36,1.295,42,0.173,60,1.709,62,3.411]],["title/32",[36,1.038,42,0.138,60,1.37]],["description/32",[7,0.416,36,1.295,42,0.173,60,1.709,62,3.411]],["title/33",[42,0.166,63,2.035]],["description/33",[7,0.387,42,0.161,63,1.969,64,3.172,65,1.969,66,3.172]],["title/34",[42,0.166,63,2.035]],["description/34",[7,0.387,42,0.161,63,1.969,64,3.172,65,1.969,66,3.172]],["title/35",[42,0.138,63,1.696,65,1.696]],["description/35",[7,0.387,12,1.205,42,0.161,63,1.969,65,1.969,67,3.675]],["title/36",[42,0.119,63,1.454,65,1.454,68,2.343]],["description/36",[7,0.362,12,1.126,42,0.15,63,1.841,65,1.841,69,2.965,70,3.435]],["title/37",[42,0.166,60,1.643]],["description/37",[12,1.295,42,0.173,60,1.709,71,3.411,72,3.95]],["title/38",[42,0.138,60,1.37,68,2.733]],["description/38",[12,1.205,42,0.161,60,1.59,69,3.172,71,3.172,73,3.675]],["title/39",[15,2.308,74,1.493]],["description/39",[7,0.416,15,2.401,42,0.173,74,1.553,75,3.411]],["title/40",[36,1.245,74,1.493]],["description/40",[7,0.45,36,1.4,74,1.679,76,3.687]],["title/41",[74,1.865]],["description/41",[11,2.401,43,1.709,44,2.789,45,2.249,74,1.553]],["title/42",[74,1.865]],["description/42",[7,0.416,12,1.295,42,0.173,74,1.553,75,3.411]],["title/43",[45,2.163,74,1.493]],["description/43",[7,0.416,12,1.295,45,2.249,74,1.553,76,3.411]],["title/44",[36,1.245,74,1.493]],["description/44",[7,0.45,36,1.4,74,1.679,77,4.271]],["title/45",[6,0.872,45,1.802,74,1.244]],["description/45",[7,0.45,36,1.4,74,1.679,78,4.271]],["title/46",[79,2.543]],["description/46",[11,2.401,43,1.709,44,2.789,45,2.249,79,2.117]],["title/47",[79,2.035,80,2.937]],["description/47",[2,1.456,7,0.32,42,0.133,43,1.315,79,1.628,80,2.349,81,2.623,82,2.349,83,3.038]],["title/48",[79,2.035,84,2.937]],["description/48",[2,1.456,7,0.32,42,0.133,43,1.315,79,1.628,81,2.623,82,2.349,84,2.349,85,3.038]],["title/49",[26,2.937,79,2.035]],["description/49",[2,1.306,7,0.287,38,2.106,42,0.119,43,1.179,79,1.46,80,2.106,82,2.106,84,2.106,86,2.723,87,2.723]],["title/50",[46,2.402]],["description/50",[11,2.401,43,1.709,44,2.789,45,2.249,46,2]],["title/51",[42,0.166,46,1.922]],["description/51",[7,0.416,12,1.295,42,0.173,46,2,88,3.95]],["title/52",[42,0.166,51,2.937]],["description/52",[7,0.416,12,1.295,42,0.173,51,3.055,89,3.95]],["title/53",[90,3.351]],["description/53",[2,1.761,7,0.387,43,1.59,46,1.86,90,2.594,91,3.172]],["title/54",[90,3.351]],["description/54",[2,1.761,7,0.387,43,1.59,46,1.86,90,2.594,91,3.172]],["title/55",[6,1.046,92,3.279]],["description/55",[2,1.894,6,1.088,43,1.709,92,3.411,93,3.95]],["title/56",[94,3.351]],["description/56",[2,1.761,7,0.387,43,1.59,46,1.86,94,2.594,95,3.172]],["title/57",[94,3.351]],["description/57",[2,1.761,7,0.387,43,1.59,46,1.86,94,2.594,95,3.172]],["title/58",[96,4.097]],["description/58",[96,4.402,97,5.099]],["title/59",[98,3.279,99,3.798]],["description/59",[10,1.078,12,1.126,98,2.965,100,2.656,101,2.656,102,2.656,103,3.435]],["title/60",[65,2.543]],["description/60",[10,1.078,12,1.126,65,1.841,100,2.656,101,2.656,102,2.656,104,3.435]],["title/61",[105,4.097]],["description/61",[10,1.078,12,1.126,100,2.656,101,2.656,102,2.656,105,2.965,106,3.435]]],"invertedIndex":[["action",{"_index":0,"title":{"0":{},"1":{},"2":{}},"description":{"0":{},"1":{},"2":{}}}],["add",{"_index":18,"title":{"6":{}},"description":{"29":{}}}],["aggreg",{"_index":40,"title":{},"description":{"16":{}}}],["api/3/com",{"_index":48,"title":{},"description":{"18":{}}}],["api/3/comments/flag",{"_index":72,"title":{},"description":{"37":{}}}],["api/3/comments/flagged/count",{"_index":73,"title":{},"description":{"38":{}}}],["api/3/comments/moderation/{statu",{"_index":67,"title":{},"description":{"35":{}}}],["api/3/comments/moderation/{status}/count",{"_index":70,"title":{},"description":{"36":{}}}],["api/3/comments/search",{"_index":57,"title":{},"description":{"24":{}}}],["api/3/comments/{id",{"_index":50,"title":{},"description":{"19":{},"20":{},"21":{}}}],["api/3/comments/{id}/attach",{"_index":75,"title":{},"description":{"39":{},"42":{}}}],["api/3/comments/{id}/attachments/{attachmentid",{"_index":76,"title":{},"description":{"40":{},"43":{}}}],["api/3/comments/{id}/attachments/{attachmentid}/delet",{"_index":77,"title":{},"description":{"44":{}}}],["api/3/comments/{id}/attachments/{attachmentid}/upd",{"_index":78,"title":{},"description":{"45":{}}}],["api/3/comments/{id}/attribut",{"_index":58,"title":{},"description":{"25":{},"26":{},"27":{}}}],["api/3/comments/{id}/attributes/delet",{"_index":59,"title":{},"description":{"28":{}}}],["api/3/comments/{id}/delet",{"_index":52,"title":{},"description":{"22":{}}}],["api/3/comments/{id}/flag",{"_index":61,"title":{},"description":{"29":{},"30":{}}}],["api/3/comments/{id}/flags/{flagid",{"_index":62,"title":{},"description":{"31":{},"32":{}}}],["api/3/comments/{id}/moder",{"_index":66,"title":{},"description":{"33":{},"34":{}}}],["api/3/comments/{id}/upd",{"_index":53,"title":{},"description":{"23":{}}}],["api/3/comments/{id}/votes/down",{"_index":85,"title":{},"description":{"48":{}}}],["api/3/comments/{id}/votes/neutr",{"_index":87,"title":{},"description":{"49":{}}}],["api/3/comments/{id}/votes/up",{"_index":83,"title":{},"description":{"47":{}}}],["api/3/monitoring/memori",{"_index":103,"title":{},"description":{"59":{}}}],["api/3/monitoring/statu",{"_index":104,"title":{},"description":{"60":{}}}],["api/3/monitoring/vers",{"_index":106,"title":{},"description":{"61":{}}}],["api/3/system/act",{"_index":5,"title":{},"description":{"1":{},"2":{}}}],["api/3/system/context",{"_index":17,"title":{},"description":{"5":{}}}],["api/3/system/context/al",{"_index":14,"title":{},"description":{"4":{}}}],["api/3/system/context/deleteprefer",{"_index":37,"title":{},"description":{"14":{}}}],["api/3/system/context/prefer",{"_index":34,"title":{},"description":{"12":{}}}],["api/3/system/context/preferences/email",{"_index":32,"title":{},"description":{"10":{},"11":{}}}],["api/3/system/context/preferences/email/config",{"_index":30,"title":{},"description":{"8":{},"9":{}}}],["api/3/system/context/updateprefer",{"_index":35,"title":{},"description":{"13":{}}}],["api/3/system/context/{id}/{profileid",{"_index":25,"title":{},"description":{"6":{}}}],["api/3/system/context/{id}/{profileid}/delet",{"_index":27,"title":{},"description":{"7":{}}}],["api/3/system/profile/clear",{"_index":41,"title":{},"description":{"16":{}}}],["api/3/threads/{id}/com",{"_index":88,"title":{},"description":{"51":{}}}],["api/3/threads/{id}/comments/{commentid}/children",{"_index":89,"title":{},"description":{"52":{}}}],["api/3/threads/{id}/subscrib",{"_index":91,"title":{},"description":{"53":{},"54":{}}}],["api/3/threads/{id}/subscribe/upd",{"_index":93,"title":{},"description":{"55":{}}}],["api/3/threads/{id}/unsubscrib",{"_index":95,"title":{},"description":{"56":{},"57":{}}}],["assign",{"_index":24,"title":{},"description":{"6":{},"7":{}}}],["attach",{"_index":74,"title":{"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{}},"description":{"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{}}}],["attribut",{"_index":21,"title":{"25":{},"26":{},"27":{},"28":{}},"description":{"6":{},"7":{},"25":{},"26":{},"27":{},"28":{}}}],["both",{"_index":86,"title":{},"description":{"49":{}}}],["cach",{"_index":39,"title":{"16":{}},"description":{"16":{}}}],["chang",{"_index":64,"title":{},"description":{"33":{},"34":{}}}],["children",{"_index":51,"title":{"52":{}},"description":{"22":{},"52":{}}}],["clear",{"_index":38,"title":{"16":{}},"description":{"16":{},"49":{}}}],["comment",{"_index":42,"title":{"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"51":{},"52":{}},"description":{"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"42":{},"47":{},"48":{},"49":{},"51":{},"52":{}}}],["configur",{"_index":29,"title":{"8":{},"9":{}},"description":{"8":{},"9":{}}}],["content",{"_index":45,"title":{"43":{},"45":{}},"description":{"17":{},"41":{},"43":{},"46":{},"50":{}}}],["context",{"_index":4,"title":{"3":{},"4":{},"5":{},"6":{},"7":{},"12":{},"13":{},"14":{}},"description":{"1":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{}}}],["count",{"_index":68,"title":{"36":{},"38":{}},"description":{}}],["crafter",{"_index":100,"title":{},"description":{"59":{},"60":{},"61":{}}}],["creat",{"_index":15,"title":{"5":{},"18":{},"39":{}},"description":{"5":{},"18":{},"39":{}}}],["current",{"_index":2,"title":{"1":{}},"description":{"1":{},"47":{},"48":{},"49":{},"53":{},"54":{},"55":{},"56":{},"57":{}}}],["delet",{"_index":36,"title":{"14":{},"21":{},"22":{},"27":{},"28":{},"31":{},"32":{},"40":{},"44":{}},"description":{"14":{},"21":{},"22":{},"27":{},"31":{},"32":{},"40":{},"44":{},"45":{}}}],["detail",{"_index":102,"title":{},"description":{"59":{},"60":{},"61":{}}}],["down",{"_index":84,"title":{"48":{}},"description":{"48":{},"49":{}}}],["email",{"_index":28,"title":{"8":{},"9":{},"10":{},"11":{}},"description":{"8":{},"9":{},"10":{},"11":{}}}],["flag",{"_index":60,"title":{"29":{},"30":{},"31":{},"32":{},"37":{},"38":{}},"description":{"29":{},"30":{},"31":{},"32":{},"37":{},"38":{}}}],["gener",{"_index":44,"title":{},"description":{"17":{},"41":{},"46":{},"50":{}}}],["get",{"_index":3,"title":{},"description":{"1":{}}}],["given",{"_index":7,"title":{},"description":{"2":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"19":{},"20":{},"21":{},"22":{},"23":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"39":{},"40":{},"42":{},"43":{},"44":{},"45":{},"47":{},"48":{},"49":{},"51":{},"52":{},"53":{},"54":{},"56":{},"57":{}}}],["id",{"_index":23,"title":{},"description":{"6":{},"7":{}}}],["includ",{"_index":22,"title":{},"description":{"6":{}}}],["jvm",{"_index":101,"title":{},"description":{"59":{},"60":{},"61":{}}}],["list",{"_index":13,"title":{},"description":{"4":{},"6":{},"7":{}}}],["log",{"_index":82,"title":{},"description":{"47":{},"48":{},"49":{}}}],["manag",{"_index":11,"title":{},"description":{"3":{},"15":{},"17":{},"41":{},"46":{},"50":{}}}],["match",{"_index":55,"title":{},"description":{"24":{}}}],["memori",{"_index":98,"title":{"59":{}},"description":{"59":{}}}],["moder",{"_index":63,"title":{"33":{},"34":{},"35":{},"36":{}},"description":{"33":{},"34":{},"35":{},"36":{}}}],["monitor",{"_index":96,"title":{"58":{}},"description":{"58":{}}}],["name",{"_index":8,"title":{},"description":{"2":{}}}],["need",{"_index":47,"title":{},"description":{"18":{}}}],["new",{"_index":16,"title":{},"description":{"5":{},"18":{}}}],["number",{"_index":69,"title":{},"description":{"36":{},"38":{}}}],["on",{"_index":71,"title":{},"description":{"37":{},"38":{}}}],["oper",{"_index":97,"title":{},"description":{"58":{}}}],["paramet",{"_index":56,"title":{},"description":{"24":{}}}],["prefer",{"_index":33,"title":{"12":{},"13":{},"14":{}},"description":{"12":{},"13":{},"14":{}}}],["profil",{"_index":19,"title":{"6":{},"7":{},"15":{}},"description":{"6":{},"7":{},"15":{},"16":{}}}],["remov",{"_index":26,"title":{"7":{},"49":{}},"description":{"7":{}}}],["replac",{"_index":49,"title":{},"description":{"19":{}}}],["return",{"_index":12,"title":{},"description":{"4":{},"9":{},"11":{},"12":{},"20":{},"24":{},"30":{},"35":{},"36":{},"37":{},"38":{},"42":{},"43":{},"51":{},"52":{},"59":{},"60":{},"61":{}}}],["role",{"_index":9,"title":{},"description":{"2":{},"6":{},"7":{}}}],["search",{"_index":54,"title":{"24":{}},"description":{"24":{}}}],["secur",{"_index":1,"title":{},"description":{"0":{},"1":{}}}],["social",{"_index":10,"title":{"4":{},"5":{},"6":{},"7":{}},"description":{"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"59":{},"60":{},"61":{}}}],["socialcontext",{"_index":20,"title":{},"description":{"6":{},"7":{}}}],["stat",{"_index":99,"title":{"59":{}},"description":{}}],["statu",{"_index":65,"title":{"35":{},"36":{},"60":{}},"description":{"33":{},"34":{},"35":{},"36":{},"60":{}}}],["subscrib",{"_index":90,"title":{"53":{},"54":{}},"description":{"53":{},"54":{}}}],["subscript",{"_index":92,"title":{"55":{}},"description":{"55":{}}}],["templat",{"_index":31,"title":{"10":{},"11":{}},"description":{"10":{},"11":{}}}],["thread",{"_index":46,"title":{"50":{},"51":{}},"description":{"18":{},"50":{},"51":{},"53":{},"54":{},"56":{},"57":{}}}],["toggl",{"_index":81,"title":{},"description":{"47":{},"48":{}}}],["unsubscrib",{"_index":94,"title":{"56":{},"57":{}},"description":{"56":{},"57":{}}}],["up",{"_index":80,"title":{"47":{}},"description":{"47":{},"49":{}}}],["updat",{"_index":6,"title":{"2":{},"8":{},"10":{},"13":{},"19":{},"23":{},"25":{},"26":{},"29":{},"45":{},"55":{}},"description":{"2":{},"6":{},"7":{},"8":{},"10":{},"13":{},"23":{},"25":{},"26":{},"28":{},"55":{}}}],["user",{"_index":43,"title":{},"description":{"17":{},"41":{},"46":{},"47":{},"48":{},"49":{},"50":{},"53":{},"54":{},"55":{},"56":{},"57":{}}}],["version",{"_index":105,"title":{"61":{}},"description":{"61":{}}}],["vote",{"_index":79,"title":{"46":{},"47":{},"48":{},"49":{}},"description":{"46":{},"47":{},"48":{},"49":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080/crafter-social"}],"info":{"description":"Crafter Social API\n\nAll request in this API require the user to be authenticated with the following steps:\n\n1. Send a **POST** request to the **/crafter-social/crafter-security-login** endpoint with the **_username_** and **_password_** parameters\n\n2. Include the cookies set in the response of the login in later requests\n\nBesides setting the authentication cookies the login response also provides the user’s information:\n\n```\n{\n    \"ticket\":\"0489ca78-cd96-46c2-bc96-c1ea1fa4db6f\",\n    \"profile\":{\n        \"username\":\"admin\",\n        \"password\":null,\n        \"email\":\"admin@example.com\",\n        \"verified\":false,\n        \"enabled\":true,\n        \"createdOn\":1554832283831,\n        \"lastModified\":1554834126479,\n        \"tenant\":\"default\",\n        \"roles\":[\n            \"SOCIAL_SUPERADMIN\",\n            \"PROFILE_SUPERADMIN\"\n        ],\n        \"attributes\":{\n            \"socialContexts\":[\n                {\n                    \"name\":\"Default\",\n                    \"id\":\"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9\",\n                    \"roles\":[\n                        \"SOCIAL_ADMIN\",\n                        \"SOCIAL_MODERATOR\",\n                        \"SOCIAL_USER\"\n                    ]\n                }\n            ]\n        },\n        \"failedLoginAttempts\":0,\n        \"lastFailedLogin\":null,\n        \"id\":\"5cacdb9b386f920d482a5ad4\"\n    },\n    \"remembered\":false\n}\n```","version":"4.5.0","title":"Crafter Social","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Social","url":"https://craftercms.com/docs/current/reference/modules/social.html"},"tags":[{"name":"actions","description":"Security Actions"},{"name":"context","description":"Social contexts management"},{"name":"profile","description":"Profile management"},{"name":"comments","description":"User generated content comments management"},{"name":"attachments","description":"User generated content attachments management"},{"name":"votes","description":"User generated content votes management"},{"name":"threads","description":"User generated content threads management"},{"name":"monitoring","description":"Monitoring operations"}],"paths":{"/api/3/system/actions":{"get":{"security":[],"tags":["actions"],"summary":"Get Current Actions","operationId":"getCurrentActions","description":"Gets all Security Actions for current context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"example":[{"actionName":"ugc.update","roles":["SOCIAL_SUPERADMIN","OWNER","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358b"},{"actionName":"ugc.moderate","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358c"},{"actionName":"ugc.unflag","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358d"},{"actionName":"ugc.flag","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358e"},{"actionName":"ugc.create","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358f"},{"actionName":"ugc.delete","roles":["SOCIAL_SUPERADMIN","OWNER","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353590"},{"actionName":"ugc.read","roles":["ANONYMOUS","SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353591"},{"actionName":"system.securityActions.read","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353592"},{"actionName":"system.securityActions.update","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353593"},{"actionName":"system.socialctx.all","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353594"},{"actionName":"system.socialctx.create","roles":["SOCIAL_SUPERADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353595"},{"actionName":"system.socialctx.addProfile","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353596"},{"actionName":"system.socialctx.removeProfile","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be353597"},{"actionName":"system.notification.changeTemplate","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be3535ab"},{"actionName":"ugc.voting","roles":["SOCIAL_SUPERADMIN","SOCIAL_ADMIN","SOCIAL_MODERATOR","SOCIAL_USER"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be3535ca"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"security":[],"tags":["actions"],"summary":"Update Actions","operationId":"updateActions","description":"Updates the given action name with the Roles.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"actionName","in":"query","description":"The name of the action to update","required":true,"schema":{"type":"string"},"example":"ugc.moderate"},{"name":"roles","in":"query","description":"List of roles to assign to the action","required":true,"schema":{"type":"string"},"example":"CUSTOM_MODERATOR,SOCIAL_SUPERADMIN,SOCIAL_ADMIN,SOCIAL_MODERATOR"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"},"example":{"actionName":"ugc.moderate","roles":["SOCIAL_SUPERADMIN","CUSTOM_MODERATOR","SOCIAL_ADMIN","SOCIAL_MODERATOR"],"contextId":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9","_id":"59663b4be61296e1be35358c"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/all":{"get":{"security":[],"tags":["context"],"summary":"Get All Social Contexts","operationId":"getAllSocialContexts","description":"Returns a list of all Social Contexts.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Context"}},"example":[{"contextName":"Default","_id":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}]}}},"400":{"$ref":"#/components/responses/Unauthorized"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/":{"post":{"security":[],"tags":["context"],"summary":"Create Social Context","operationId":"createSocialContext","description":"Creates a new Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contextName":{"type":"string","description":"The name of the new Social Context","example":"site1"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Context"},"example":{"contextName":"site1","_id":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/{id}/{profileId}":{"post":{"security":[],"tags":["context"],"summary":"Add Profile To Social Context","operationId":"addProfileToSocialContext","description":"Updates the socialContext attribute in the given profile to include the Social Context ID and the list of roles assigned for that context.","parameters":[{"name":"id","in":"path","description":"The ID of the Social Context to add","required":true,"schema":{"type":"string"},"example":"e41e7273-b504-4d50-9edd-3b215eff6464"},{"name":"profileId","in":"path","description":"The ID of the profile to update","required":true,"schema":{"type":"string"},"example":"596683c030047dc279c21d27"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"roles":{"type":"string","description":"The list of roles to assign","example":"SOCIAL_USER"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextProfile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":"2017-07-12T14:17Z","lastModified":"2017-07-12T14:37Z","tenant":"sample-tenant","roles":[],"attributes":{"firstName":"John","lastName":"Doe","socialContexts":[{"roles":["SOCIAL_USER"],"name":"site1","id":"e41e7273-b504-4d50-9edd-3b215eff6464"}]},"id":"596683c030047dc279c21d27"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/{id}/{profileId}/delete":{"post":{"security":[],"tags":["context"],"summary":"Remove Profile from Social Context","operationId":"removeProfileFromSocialContext","description":"Updates the socialContext attribute in the given profile to remove the Social Context ID and the list of roles assigned for that context.","parameters":[{"name":"id","in":"path","description":"The ID of the Social Context to remove","required":true,"schema":{"type":"string"},"example":"e41e7273-b504-4d50-9edd-3b215eff6464"},{"name":"profileId","in":"path","description":"The ID of the profile to update","required":true,"schema":{"type":"string"},"example":"596683c030047dc279c21d27"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextProfile"},"example":{"username":"john.doe","email":"john.doe@example.com","verified":false,"enabled":false,"createdOn":"2024-07-12T14:17Z","lastModified":"2024-07-12T14:37Z","tenant":"sample-tenant","roles":[],"attributes":{"firstName":"John","lastName":"Doe","socialContexts":[]},"id":"596683c030047dc279c21d27"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/preferences/email/config":{"post":{"security":[],"tags":["context"],"summary":"Update Email Configuration","operationId":"updateEmailConfiguration","description":"Updates the email configuration for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"encoding":{"type":"string","description":"Character encoding for the email body","example":"UTF-8"},"host":{"type":"string","description":"The hostname of the email server","example":"mail.example.com"},"port":{"type":"string","description":"The port of the email server","example":25},"auth":{"type":"boolean","description":"Enable if the email server requires authentication","example":true},"username":{"type":"string","description":"The username for the email server","example":"user"},"password":{"type":"string","description":"The password for the email server","example":"passw0rd"},"tls":{"type":"boolean","description":"Enable if the email server requires a secure connection","example":true},"replyTo":{"type":"string","description":"Email address used for replies","example":"reply@example.com"},"from":{"type":"string","description":"Email address used to send notifications","example":"site1@example.com"},"priority":{"type":"integer","description":"The priority for the emails","example":3},"subject":{"type":"string","description":"The subject for the emails","example":"Site1 Updates"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextEmailConfiguration"},"example":{"password":"passw0rd","port":25,"auth":true,"subject":"Site1 Updates","host":"mail.example.com","replyTo":"reply@example.com","tls":true,"from":"site1@example.com","encoding":"UTF-8","priority":3,"username":"user"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["context"],"summary":"Get Email Configuration","operationId":"getEmailConfiguration","description":"Returns an email configuration for a given Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextEmailConfiguration"},"example":{"host":"localhost","encoding":"UTF-8","port":25,"auth":false,"username":"","password":"","tls":false,"replyTo":"social@example.com","from":"social@example.com","priority":5,"subject":"Latest change on your subscribed threads for Social"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/preferences/email":{"post":{"security":[],"tags":["context"],"summary":"Update Email Template","operationId":"updateEmailTemplate","description":"Updates an email template for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"template":{"type":"string","description":"The body of the email template","example":"Sample template for email"},"type":{"type":"string","description":"The type of the email template<br>\nThe possible values for the type parameter are:\n<ul>\n<li>DAILY</li>\n<li>WEEKLY</li>\n<li>INSTANT</li>\n<li>APPROVEREMAIL</li>\n<li>APPROVER_RESULT_TEMPLATE</li>\n</ul>","example":"INSTANT"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["context"],"summary":"Get Email Template","operationId":"getEmailTemplate","description":"Returns an email template for a given Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"The type of the email template<br>\nThe possible values for the type parameter are:\n<ul>\n<li>DAILY</li>\n<li>WEEKLY</li>\n<li>INSTANT</li>\n<li>APPROVEREMAIL</li>\n<li>APPROVER_RESULT_TEMPLATE</li>\n</ul>"},"example":"INSTANT"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":"string"}}},"example":{"template":"Hi ${profile.username} this are changes that happen on your subscribe Threads<#list digest as change><h1> ${change[\"_id\"]} </h1><dl><#list change.ugcList as ugc><dt>Subject</dt><dd> ${ugc.subject!\"\"} </dd><dt>Body</dt>  <dd>${ugc.body!\"\"} </dd><dt>Changed by<dt><dd>${ugc.lastModifiedBy.username}<dd></#list></dl></#list>"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/preferences":{"get":{"security":[],"tags":["context"],"summary":"Get Context Preferences","operationId":"getContextPreferences","description":"Returns the preferences for a given Social Context.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialContextPreferences"},"example":{"preferences":{"hiddenUgcStatus":"SPAM,TRASH","moderateByMailEnable":"false","moderateByMailRole":"SOCIAL_APPROVER","moderateByMailSubject":"A new Comment needs to be approved","timezone":"EST","baseUrl":"http://example.com","setupAutoWatch":false,"defaultFrequency":"INSTANT"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/updatePreferences":{"post":{"security":[],"tags":["context"],"summary":"Update Context Preferences","operationId":"updateContextPreferences","description":"Updates the preferences for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"additionalProperties":{"description":"Preferences that will be updated","example":{"moderateByMailEnable":true}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/context/deletePreferences":{"post":{"security":[],"tags":["context"],"summary":"Delete Context Preferences","operationId":"deleteContextPreferences","description":"Deletes the preferences for a given Social Context.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"moderateByMailEnable":{"type":"boolean"},"moderateByMailRole":{"type":"string"},"moderateByMailSubject":{"type":"string"},"timezone":{"type":"string"},"baseUrl":{"type":"string"},"setupAutoWatch":{"type":"boolean"},"defaultFrequency":{"type":"string"},"hiddenUgcStatus":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/system/profile/clear":{"get":{"security":[],"tags":["profile"],"summary":"Clear Cache","operationId":"clearCache","description":"Clears the Profile Aggregator Cache.","parameters":[{"name":"profileIds","in":"query","description":"List of IDs to be removed from the Cache. <br><br>\nIf the <b>profileIds</b> parameter is empty or not included in the request, all profiles in the cache will be cleared.","required":true,"schema":{"type":"string"},"example":""}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments":{"post":{"security":[],"tags":["comments"],"summary":"Create Comment","operationId":"createComment","description":"Creates a new comment and creates a new thread if needed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"thread":{"type":"string","description":"Id of the thread to attach this comment"},"parent":{"type":"string","description":"Id of the parent for the new comment"},"anonymous":{"type":"boolean","description":"Should the comment be posted as anonymous"},"subject":{"type":"string","description":"Subject of the comment to be created"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"},"attachment":{"type":"string","format":"binary","description":"Binary file to include in the comment"}},"required":["context","body","thread"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}":{"put":{"security":[],"tags":["comments"],"summary":"Update Comment","operationId":"updateCommentPut","description":"Replace the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to replace","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["comments"],"summary":"Get Comment","operationId":"getComment","description":"Returns the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Comment","operationId":"deleteCommentD","description":"Delete the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to delete","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"boolean","example":true}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/delete":{"post":{"security":[],"tags":["comments"],"summary":"Delete Comment","operationId":"deleteCommentP","description":"Deletes the given comment and all its children.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to delete","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/update":{"post":{"security":[],"tags":["comments"],"summary":"Update Comment","operationId":"updateComment","description":"Updates the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"The body of the new comment","example":"This is the first comment!"},"attributes":{"type":"string","description":"JSON string representing any extra attributes of the comment to create"}},"required":["body"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This is the first comment!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{"baseUrl":"http://localhost:8080/crafter-social"},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/search":{"post":{"security":[],"tags":["comments"],"summary":"Search Comments","operationId":"searchComment","description":"Returns all comments that match the search parameter.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the social context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"search":{"type":"string","description":"MongoDB query (except $where)","example":{"targetId":"Welcome"}},"sortBy":{"type":"string","description":"MongoDB sort string","example":{"lastModifiedDate":1}},"start":{"type":"integer","description":"Starting position for pagination","example":0},"limit":{"type":"integer","description":"Final position for pagination","example":5}},"required":["context","search","sortBy","start","limit"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialComment"}},"example":[{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T09:09Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attributes":{"post":{"security":[],"tags":["comments"],"summary":"Update Comment Attributes","operationId":"updateCommentAttributesPost","description":"Updates the attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"All additional parameters included in the request will be added as custom attributes in the comment."}},"example":{"customProperty":true,"anotherCustomProperty":1}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"security":[],"tags":["comments"],"summary":"Update Comment Attributes","operationId":"updateCommentAttributesPut","description":"Updates the attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"All additional parameters included in the request will be added as custom attributes in the comment."}},"example":{"customProperty":true,"anotherCustomProperty":1}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Comment Attributes","operationId":"deleteCommentAttributes","description":"Deletes attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"description":"List of attribute names to delete","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attributes/delete":{"post":{"security":[],"tags":["comments"],"summary":"Delete Comment Attributes","operationId":"deleteCommentAttributesP","description":"Updates the attributes for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"description":"All additional parameters included in the request will be added as custom attributes in the comment."}},"example":{"customProperty":true,"anotherCustomProperty":1}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/flags":{"post":{"security":[],"tags":["comments"],"summary":"Update Comment Flags","operationId":"updateCommentFlags","description":"Adds a flag to the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"description":"Reason why the comment is flagged","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[{"reason":"Contains offensive language","userId":"59667e8abd4787992596ba6b","_id":"5967e35f300426156e21df58"}],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"get":{"security":[],"tags":["comments"],"summary":"Get Comment Flags","operationId":"getCommentFlags","description":"Returns all the flags for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsFlags"}},"example":[{"reason":"Contains offensive language","userId":"59667e8abd4787992596ba6b","_id":"5967e35f300426156e21df58"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/flags/{flagId}":{"post":{"security":[],"tags":["comments"],"summary":"Delete Comment Flags","operationId":"deleteCommentFlagsP","description":"Deletes a flag for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"flagId","in":"path","description":"The ID of the flag","required":true,"schema":{"type":"string"},"example":"5967e35f300426156e21df58"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Comment Flags","operationId":"deleteCommentFlagsD","description":"Deletes a flag for the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"flagId","in":"path","description":"The ID of the flag","required":true,"schema":{"type":"string"},"example":"5967e35f300426156e21df58"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/moderate":{"post":{"security":[],"tags":["comments"],"summary":"Moderate Comment","operationId":"moderateCommentPost","description":"Changes the moderation status of the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"The new moderation status","type":"string","example":"APPROVED"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"security":[],"tags":["comments"],"summary":"Moderate Comment","operationId":"moderateCommentPut","description":"Changes the moderation status of the given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"}},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"The new moderation status","type":"string","example":"APPROVED"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/moderation/{status}":{"get":{"security":[],"tags":["comments"],"summary":"Get Comments By Moderation Status","operationId":"getCommentsByModerationStatus","description":"Returns all the comments with a given moderation status.","parameters":[{"name":"status","in":"path","description":"The moderation status to search","required":true,"schema":{"type":"string"},"example":"APPROVED"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"thread","in":"query","description":"The ID of the thread to search","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/moderation/{status}/count":{"get":{"security":[],"tags":["comments"],"summary":"Count Comments By Moderation Status","operationId":"countCommentsByModerationStatus","description":"Returns the number of comments with a given moderation status.","parameters":[{"name":"status","in":"path","description":"The moderation status to search","required":true,"schema":{"type":"string"},"example":"APPROVED"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"thread","in":"query","description":"The ID of the thread to search","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer"},"example":1}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/flagged":{"get":{"security":[],"tags":["comments"],"summary":"Get Flagged Comments","operationId":"getFlaggedComments","description":"Returns all the comments with at least one flag.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":[{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"APPROVED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/flagged/count":{"get":{"security":[],"tags":["comments"],"summary":"Count Flagged Comments","operationId":"countFlaggedComments","description":"Returns the number of comments with at least one flag.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer"},"example":1}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments":{"get":{"security":[],"tags":["attachments"],"summary":"Get Attachments","operationId":"getAttachments","description":"Returns all the attachments for a given comment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsAttachments"}},"example":[{"md5":"1300018473cc0038187aaa0e2604fa27","fileId":"5967ac48300426156e21df51","contentType":"image/png","fileSize":"1.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/image1.png","fileName":"image1.png","savedDate":"2017-07-13T11:22Z","fileSizeBytes":1497,"attributes":{"owner":"59678d3f300426156e21df50"}}]}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"security":[],"tags":["comments"],"summary":"Create Attachment","operationId":"createAttachment","description":"Creates an attachment in a given comment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"string","format":"binary","description":"Binary file to add as attachment","example":"Binary content"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsAttachments"}},"example":{"md5":"1300018473cc0038187aaa0e2604fa27","fileId":"5967ac48300426156e21df51","contentType":"image/png","fileSize":"1.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/image1.png","fileName":"image1.png","savedDate":"2017-07-13T11:22Z","fileSizeBytes":1497,"attributes":{"owner":"59678d3f300426156e21df50"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments/{attachmentId}":{"get":{"security":[],"tags":["attachments"],"summary":"Get Attachment Content","operationId":"getAttachmentContent","description":"Returns the content of a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"the content of the attachment"},"example":"Binary content"}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["comments"],"summary":"Delete Attachment","operationId":"deleteAttachmentD","description":"Deletes a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments/{attachmentId}/delete":{"post":{"security":[],"tags":["attachments"],"summary":"Delete Attachment","operationId":"deleteAttachmentP","description":"Deletes a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/attachments/{attachmentId}/update":{"post":{"security":[],"tags":["attachments"],"summary":"Update Attachment Content","operationId":"deleteAttachmentP","description":"Deletes a given attachment.","parameters":[{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"attachmentId","in":"path","description":"The ID of the attachment","required":true,"schema":{"type":"string"},"example":"5967ac48300426156e21df51"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The content of the attachment","example":"Binary content"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/votes/up":{"post":{"security":[],"tags":["votes"],"summary":"Vote Up","operationId":"voteUp","description":"Toggles a vote up in the given comment from the currently logged user.","parameters":[{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":["59667e8abd4787992596ba6b"],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/votes/down":{"post":{"security":[],"tags":["votes"],"summary":"Vote Down","operationId":"voteDown","description":"Toggles a vote down in the given comment from the currently logged user.","parameters":[{"name":"id","in":"path","description":"The ID of the Comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"APPROVED","votesUp":[],"votesDown":["59667e8abd4787992596ba6b"],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/comments/{id}/votes/neutral":{"post":{"security":[],"tags":["votes"],"summary":"Remove Votes","operationId":"removeVotes","description":"Clears both up and down votes in the given comment for the currently logged user.","parameters":[{"name":"id","in":"path","description":"The ID of the comment to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialComment"},"example":{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T15:17Z","anonymousFlag":false,"attributes":{},"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/comments":{"get":{"security":[],"tags":["threads"],"summary":"Get Thread Comments","operationId":"getThreadComments","description":"Returns all comments from the given thread.","parameters":[{"name":"id","in":"path","description":"The ID of the thread","required":true,"schema":{"type":"string"},"example":"Welcome"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"recursive","in":"query","description":"Levels of comments to return","schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"childrenCount","in":"query","description":"Amount of children to return","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialCommentsThread"},"example":{"total":1,"pageSize":666,"pageNumber":0,"watched":false,"comments":[{"ancestors":[],"targetId":"Welcome","subject":"","body":"This was the first comment in the site!","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T11:06Z","anonymousFlag":false,"attributes":{},"children":[],"attachments":[{"md5":"c86b6b1607621afff04b6a9b9048e87b","fileId":"5967c9dd300426156e21df53","contentType":"image/png","fileSize":"144.5 KB","storeName":"/f5b143c2-f1c0-4a10-b56e-f485f00d3fe9/59678d3f300426156e21df50/person1.png","fileName":"person1.png","savedDate":"2017-07-13T13:28Z","fileSizeBytes":147970,"attributes":{"owner":"59678d3f300426156e21df50"}}],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/comments/{commentId}/children":{"get":{"security":[],"tags":["threads"],"summary":"Get Comment Children","operationId":"getCommentChildren","description":"Returns all children for a given comment.","parameters":[{"name":"id","in":"path","description":"The ID of the thread","required":true,"schema":{"type":"string"},"example":"Welcome"},{"name":"commentId","in":"path","description":"The ID of the comment","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"},{"name":"context","in":"query","description":"The ID of the Social Context","required":true,"schema":{"type":"string"},"example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},{"name":"recursive","in":"query","description":"Levels of comments to return","schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number to return","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Comments per page","schema":{"type":"integer"}},{"name":"childrenCount","in":"query","description":"Amount of children to return","schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"List of fields to order by","schema":{"type":"array","items":{"type":"string"}},"example":"lastModifiedDate"},{"name":"sortOrder","in":"query","description":"List of sort orders for each field","schema":{"type":"array","items":{"type":"string"}},"example":"ASC"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialCommentsThread"},"example":{"total":1,"pageSize":666,"pageNumber":0,"watched":false,"comments":[{"ancestors":["59678d3f300426156e21df50"],"targetId":"Welcome","subject":"","body":"This is a response.","createdBy":"59667e8abd4787992596ba6b","lastModifiedBy":"59667e8abd4787992596ba6b","createdDate":"2017-07-13T09:09Z","lastModifiedDate":"2017-07-13T11:06Z","anonymousFlag":false,"attributes":{},"children":[],"attachments":[],"moderationStatus":"UNMODERATED","votesUp":[],"votesDown":[],"flags":[],"_id":"59678d3f300426156e21df50"}]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/subscribe":{"post":{"security":[],"tags":["threads"],"summary":"Subscribe","operationId":"subscribePost","description":"Subscribes the current user to a given thread","parameters":[{"name":"id","in":"path","description":"The ID of the thread to subscribe to","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"frequency":{"type":"string","description":"Type of notifications to receive.\nThe possible values are:\n- weekly\n- daily\n- instant"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"put":{"security":[],"tags":["threads"],"summary":"Subscribe","operationId":"subscribePut","description":"Subscribes the current user to a given thread","parameters":[{"name":"id","in":"path","description":"The ID of the thread to subscribe to","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"frequency":{"type":"string","description":"Type of notifications to receive.\nThe possible values are:\n- weekly\n- daily\n- instant"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/subscribe/update":{"post":{"security":[],"tags":["threads"],"summary":"Update Subscription","operationId":"updateSubscription","description":"Updates subscription of the current user","parameters":[{"name":"id","in":"path","description":"The ID of the thread to update","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"},"frequency":{"type":"string","example":"daily","description":"Type of notifications to receive.\nThe possible values are:\n- weekly\n- daily\n- instant"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/threads/{id}/unsubscribe":{"post":{"security":[],"tags":["threads"],"summary":"Unsubscribe","operationId":"unsubscribeP","description":"Unsubscribes the current user to a given thread.","parameters":[{"name":"id","in":"path","description":"The ID of the thread to unsubscribe","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"security":[],"tags":["threads"],"summary":"Unsubscribe","operationId":"unsubscribeD","description":"Unsubscribes the current user to a given thread.","parameters":[{"name":"id","in":"path","description":"The ID of the thread to unsubscribe.","required":true,"schema":{"type":"string"},"example":"59678d3f300426156e21df50"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"string","description":"The ID of the Social Context","example":"f5b143c2-f1c0-4a10-b56e-f485f00d3fe9"}},"required":["context"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"},"example":true}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/monitoring/memory":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Memory Stats","operationId":"getMemoryStats","description":"Returns the Crafter Social JVM memory details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringJVMMemoryStats"},"example":{"totalJvmMemory":2017984512,"freeJvmMemory":1113921056,"maxJvmMemory":3817865216,"totalOsMemory":17179869184,"freeOsMemory":2669301760,"totalSwapMemory":2147483648,"freeSwapMemory":1026555904}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/monitoring/status":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Status","operationId":"getStatus","description":"Returns the Crafter Social JVM status details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringStatus"},"example":{"uptime":4801,"startup":"2019-03-07T21:29:11.049Z"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/3/monitoring/version":{"get":{"security":[],"tags":["monitoring"],"summary":"Get Version","operationId":"getVersion","description":"Returns the Crafter Social JVM version details.","parameters":[{"name":"token","in":"query","description":"The authorization token","required":true,"schema":{"type":"string"},"example":"defaultManagementToken"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoringJVMVersion"},"example":{"packageName":"Crafter Social","packageVersion":"3.2.0-SNAPSHOT","packageBuild":"a68f1ff7ad84d5ecbeaa008f392e4cef0ca02f41","packageBuildDate":"2020-03-07T21:03:05.422Z","osName":"Mac OS X","osVersion":"10.15.6","osArch":"x86_64","javaVersion":"11","javaVendor":"Oracle Corporation","javaVm":"OpenJDK 64-Bit Server VM"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"Action":{"type":"object","properties":{"actionName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"contextId":{"type":"string"},"_id":{"type":"string"}}},"SocialContextProfile":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string"},"verified":{"type":"boolean"},"enabled":{"type":"boolean"},"createdOn":{"type":"number"},"lastModified":{"type":"number"},"tenant":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"attributes":{"$ref":"#/components/schemas/ProfileAttributes"},"id":{"type":"string"}}},"Context":{"type":"object","description":"Object containing social context for given ID","properties":{"contextName":{"type":"string"},"_id":{"type":"string"}}},"SocialContext":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"id":{"type":"string"}}},"ProfileAttributes":{"type":"object","description":"Object containing attributes for the profile","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"socialContexts":{"type":"array","items":{"$ref":"#/components/schemas/SocialContext"}}}},"SocialContextEmailConfiguration":{"type":"object","properties":{"password":{"type":"string"},"port":{"type":"integer"},"auth":{"type":"boolean"},"subject":{"type":"string"},"host":{"type":"string"},"replyTo":{"type":"string"},"tls":{"type":"boolean"},"from":{"type":"string"},"encoding":{"type":"string"},"priority":{"type":"integer"},"username":{"type":"string"}}},"SocialContextPreferences":{"type":"object","properties":{"moderateByMailEnable":{"type":"boolean"},"moderateByMailRole":{"type":"string"},"moderateByMailSubject":{"type":"string"},"timezone":{"type":"string"},"baseUrl":{"type":"string"},"setupAutoWatch":{"type":"boolean"},"defaultFrequency":{"type":"string"},"hiddenUgcStatus":{"type":"string"}}},"SocialCommentsAttachments":{"type":"object","properties":{"md5":{"type":"string"},"fileId":{"type":"string"},"contentType":{"type":"string"},"fileSize":{"type":"string"},"storeName":{"type":"string"},"fileName":{"type":"string"},"savedDate":{"type":"string","format":"date-time"},"fileSizeBytes":{"type":"integer"},"additionalProperties":{"type":"string"}}},"SocialCommentsFlags":{"type":"object","properties":{"reason":{"type":"string"},"userId":{"type":"string"},"_id":{"type":"string"}}},"SocialComment":{"type":"object","properties":{"ancestors":{"type":"array"},"targetId":{"type":"string"},"subject":{"type":"string"},"body":{"type":"string"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastModifiedDate":{"type":"string","format":"date-time"},"anonymousFlag":{"type":"boolean"},"attributes":{"type":"object"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsAttachments"}},"moderationStatus":{"type":"string"},"votesUp":{"type":"array"},"votesDown":{"type":"array"},"flags":{"type":"array","items":{"$ref":"#/components/schemas/SocialCommentsFlags"}},"_id":{"type":"string"}}},"SocialCommentsThread":{"type":"object","properties":{"total":{"type":"integer"},"pageSize":{"type":"integer"},"pageNumber":{"type":"integer"},"watched":{"type":"boolean"},"comments":{"type":"array","items":{"$ref":"#/components/schemas/SocialComment"}}}},"MonitoringJVMMemoryStats":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","format":"int64"},"freeJvmMemory":{"type":"integer","format":"int64"},"maxJvmMemory":{"type":"integer","format":"int64"},"totalOSMemory":{"type":"integer","format":"int64"},"freeOSMemory":{"type":"integer","format":"int64"},"totalSwapMemory":{"type":"integer","format":"int64"},"freeSwapMemory":{"type":"integer","format":"int64"}}},"MonitoringStatus":{"type":"object","properties":{"uptime":{"type":"integer","format":"int32"},"startup":{"type":"string","format":"date-time"}}},"MonitoringJVMVersion":{"type":"object","properties":{"packageName":{"type":"string"},"packageVersion":{"type":"string"},"packageBuild":{"type":"string"},"packageBuildDate":{"type":"string","format":"date-time"},"osName":{"type":"string"},"osVersion":{"type":"string"},"osArch":{"type":"string"},"javaVersion":{"type":"string"},"javaVendor":{"type":"string"},"javaVm":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"access_token":{"value":{"errorCode":"ACTION_DENIED","message":"Current subject does not have permission to execute global action \"CREATE_TOKEN\""}},"tenant":{"value":{"errorCode":"TENANT_EXISTS","message":"The tenant \"sample-tenant\" already exists"}},"profile":{"value":{"errorCode":"PROFILE_EXISTS","message":"A profile with name \"john.doe\" already exists"}},"comments":{"value":{"message":"Unable to find ugc with id ..."}},"commentsAttachments":{"value":{"message":"Given Attachment id is not valid"}},"commentsAttachmentSize":{"value":{"message":"Maximum upload size of ... bytes exceeded"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"context":{"value":{"message":"SOCIAL_SUPERADMIN is not a valid role"}},"monitoring":{"value":{"message":"”Required String parameter ‘token’ is not present”"}},"comments":{"value":{"message":"UGC with given Id does not exist"}},"attachment":{"value":{"message":"Given Attachment id is not valid"}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"authentication":{"value":{"message":"User must be logged in"}},"monitoring":{"value":{"message":"”Management authorization failed, invalid token.”"}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"accessToken":{"value":{"message":"Current subject does not have permission to execute global action ...\""}},"profile":{"value":{"message":"Profile \\\"59284659d4c650213cc2f3fc\\\" of tenant \\\"sample-tenant\\\" is disabled"}},"authentication":{"value":{"message":"No access token found for ID \\\"e8f5170c-877b-416f-b70f-4b09772f8e2d\\\""}}}}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal Server Error"}}}}}}}}}},"searchIndex":{"store":["tag/actions","tag/actions/operation/getCurrentActions","tag/actions/operation/updateActions","tag/context","tag/context/operation/getAllSocialContexts","tag/context/operation/createSocialContext","tag/context/operation/addProfileToSocialContext","tag/context/operation/removeProfileFromSocialContext","tag/context/operation/updateEmailConfiguration","tag/context/operation/getEmailConfiguration","tag/context/operation/updateEmailTemplate","tag/context/operation/getEmailTemplate","tag/context/operation/getContextPreferences","tag/context/operation/updateContextPreferences","tag/context/operation/deleteContextPreferences","tag/profile","tag/profile/operation/clearCache","tag/comments","tag/comments/operation/createComment","tag/comments/operation/updateCommentPut","tag/comments/operation/getComment","tag/comments/operation/deleteCommentD","tag/comments/operation/deleteCommentP","tag/comments/operation/updateComment","tag/comments/operation/searchComment","tag/comments/operation/updateCommentAttributesPost","tag/comments/operation/updateCommentAttributesPut","tag/comments/operation/deleteCommentAttributes","tag/comments/operation/deleteCommentAttributesP","tag/comments/operation/updateCommentFlags","tag/comments/operation/getCommentFlags","tag/comments/operation/deleteCommentFlagsP","tag/comments/operation/deleteCommentFlagsD","tag/comments/operation/moderateCommentPost","tag/comments/operation/moderateCommentPut","tag/comments/operation/getCommentsByModerationStatus","tag/comments/operation/countCommentsByModerationStatus","tag/comments/operation/getFlaggedComments","tag/comments/operation/countFlaggedComments","tag/comments/operation/createAttachment","tag/comments/operation/deleteAttachmentD","tag/attachments","tag/attachments/operation/getAttachments","tag/attachments/operation/getAttachmentContent","tag/attachments/operation/deleteAttachmentP","tag/attachments/operation/deleteAttachmentP","tag/votes","tag/votes/operation/voteUp","tag/votes/operation/voteDown","tag/votes/operation/removeVotes","tag/threads","tag/threads/operation/getThreadComments","tag/threads/operation/getCommentChildren","tag/threads/operation/subscribePost","tag/threads/operation/subscribePut","tag/threads/operation/updateSubscription","tag/threads/operation/unsubscribeP","tag/threads/operation/unsubscribeD","tag/monitoring","tag/monitoring/operation/getMemoryStats","tag/monitoring/operation/getStatus","tag/monitoring/operation/getVersion"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.884]],["description/0",[0,3.099,1,4.402]],["title/1",[0,2.308,2,1.821]],["description/1",[0,2.233,1,3.172,2,1.761,3,3.675,4,1.057,5,3.172]],["title/2",[0,2.308,6,1.046]],["description/2",[0,2.233,5,3.172,6,1.012,7,0.387,8,3.675,9,2.842]],["title/3",[4,1.365]],["description/3",[4,1.337,10,1.459,11,2.825]],["title/4",[4,1.092,10,1.192]],["description/4",[4,1.136,10,1.239,12,1.295,13,3.055,14,3.95]],["title/5",[4,0.91,10,0.993,15,1.924]],["description/5",[4,1.136,10,1.239,15,2.401,16,3.411,17,3.95]],["title/6",[4,0.781,10,0.851,18,2.343,19,1.545]],["description/6",[4,1.054,6,0.649,7,0.248,9,1.823,10,0.74,13,1.823,19,1.342,20,2.035,21,1.13,22,2.357,23,2.035,24,2.035,25,2.357]],["title/7",[4,0.781,10,0.851,19,1.545,26,2.098]],["description/7",[4,1.054,6,0.649,7,0.248,9,1.823,10,0.74,13,1.823,19,1.342,20,2.035,21,1.13,23,2.035,24,2.035,26,1.823,27,2.357]],["title/8",[6,0.872,28,1.696,29,2.235]],["description/8",[4,0.988,6,0.946,7,0.362,10,1.078,28,1.841,29,2.425,30,2.965]],["title/9",[28,2.035,29,2.682]],["description/9",[4,0.988,7,0.362,10,1.078,12,1.126,28,1.841,29,2.425,30,2.965]],["title/10",[6,0.872,28,1.696,31,2.235]],["description/10",[4,0.988,6,0.946,7,0.362,10,1.078,28,1.841,31,2.425,32,2.965]],["title/11",[28,2.035,31,2.682]],["description/11",[4,0.988,7,0.362,10,1.078,12,1.126,28,1.841,31,2.425,32,2.965]],["title/12",[4,1.092,33,2.308]],["description/12",[4,1.057,7,0.387,10,1.153,12,1.205,33,2.233,34,3.675]],["title/13",[4,0.91,6,0.872,33,1.924]],["description/13",[4,1.057,6,1.012,7,0.387,10,1.153,33,2.233,35,3.675]],["title/14",[4,0.91,33,1.924,36,1.038]],["description/14",[4,1.057,7,0.387,10,1.153,33,2.233,36,1.205,37,3.675]],["title/15",[19,2.702]],["description/15",[11,3.099,19,2.903]],["title/16",[38,2.937,39,3.279]],["description/16",[19,2.249,38,3.055,39,3.411,40,3.95,41,3.95]],["title/17",[42,0.208]],["description/17",[11,2.401,42,0.173,43,1.709,44,2.789,45,2.249]],["title/18",[15,2.308,42,0.166]],["description/18",[15,2.815,16,3.999,42,0.141,46,1.632,47,3.224,48,3.224]],["title/19",[6,1.046,42,0.166]],["description/19",[7,0.45,42,0.187,49,4.271,50,3.303]],["title/20",[42,0.208]],["description/20",[7,0.45,12,1.4,42,0.187,50,3.303]],["title/21",[36,1.245,42,0.166]],["description/21",[7,0.45,36,1.4,42,0.187,50,3.303]],["title/22",[36,1.245,42,0.166]],["description/22",[7,0.416,36,1.295,42,0.173,51,3.055,52,3.95]],["title/23",[6,1.046,42,0.166]],["description/23",[6,1.177,7,0.45,42,0.187,53,4.271]],["title/24",[42,0.166,54,3.279]],["description/24",[12,1.205,42,0.161,54,3.172,55,3.675,56,3.675,57,3.675]],["title/25",[6,0.872,21,1.517,42,0.138]],["description/25",[6,1.088,7,0.416,21,1.894,42,0.173,58,3.055]],["title/26",[6,0.872,21,1.517,42,0.138]],["description/26",[6,1.088,7,0.416,21,1.894,42,0.173,58,3.055]],["title/27",[21,1.517,36,1.038,42,0.138]],["description/27",[7,0.416,21,1.894,36,1.295,42,0.173,58,3.055]],["title/28",[21,1.517,36,1.038,42,0.138]],["description/28",[6,1.088,7,0.416,21,1.894,42,0.173,59,3.95]],["title/29",[6,0.872,42,0.138,60,1.37]],["description/29",[7,0.416,18,3.411,42,0.173,60,1.709,61,3.411]],["title/30",[42,0.166,60,1.643]],["description/30",[7,0.416,12,1.295,42,0.173,60,1.709,61,3.411]],["title/31",[36,1.038,42,0.138,60,1.37]],["description/31",[7,0.416,36,1.295,42,0.173,60,1.709,62,3.411]],["title/32",[36,1.038,42,0.138,60,1.37]],["description/32",[7,0.416,36,1.295,42,0.173,60,1.709,62,3.411]],["title/33",[42,0.166,63,2.035]],["description/33",[7,0.387,42,0.161,63,1.969,64,3.172,65,1.969,66,3.172]],["title/34",[42,0.166,63,2.035]],["description/34",[7,0.387,42,0.161,63,1.969,64,3.172,65,1.969,66,3.172]],["title/35",[42,0.138,63,1.696,65,1.696]],["description/35",[7,0.387,12,1.205,42,0.161,63,1.969,65,1.969,67,3.675]],["title/36",[42,0.119,63,1.454,65,1.454,68,2.343]],["description/36",[7,0.362,12,1.126,42,0.15,63,1.841,65,1.841,69,2.965,70,3.435]],["title/37",[42,0.166,60,1.643]],["description/37",[12,1.295,42,0.173,60,1.709,71,3.411,72,3.95]],["title/38",[42,0.138,60,1.37,68,2.733]],["description/38",[12,1.205,42,0.161,60,1.59,69,3.172,71,3.172,73,3.675]],["title/39",[15,2.308,74,1.493]],["description/39",[7,0.416,15,2.401,42,0.173,74,1.553,75,3.411]],["title/40",[36,1.245,74,1.493]],["description/40",[7,0.45,36,1.4,74,1.679,76,3.687]],["title/41",[74,1.865]],["description/41",[11,2.401,43,1.709,44,2.789,45,2.249,74,1.553]],["title/42",[74,1.865]],["description/42",[7,0.416,12,1.295,42,0.173,74,1.553,75,3.411]],["title/43",[45,2.163,74,1.493]],["description/43",[7,0.416,12,1.295,45,2.249,74,1.553,76,3.411]],["title/44",[36,1.245,74,1.493]],["description/44",[7,0.45,36,1.4,74,1.679,77,4.271]],["title/45",[6,0.872,45,1.802,74,1.244]],["description/45",[7,0.45,36,1.4,74,1.679,78,4.271]],["title/46",[79,2.543]],["description/46",[11,2.401,43,1.709,44,2.789,45,2.249,79,2.117]],["title/47",[79,2.035,80,2.937]],["description/47",[2,1.456,7,0.32,42,0.133,43,1.315,79,1.628,80,2.349,81,2.623,82,2.349,83,3.038]],["title/48",[79,2.035,84,2.937]],["description/48",[2,1.456,7,0.32,42,0.133,43,1.315,79,1.628,81,2.623,82,2.349,84,2.349,85,3.038]],["title/49",[26,2.937,79,2.035]],["description/49",[2,1.306,7,0.287,38,2.106,42,0.119,43,1.179,79,1.46,80,2.106,82,2.106,84,2.106,86,2.723,87,2.723]],["title/50",[46,2.402]],["description/50",[11,2.401,43,1.709,44,2.789,45,2.249,46,2]],["title/51",[42,0.166,46,1.922]],["description/51",[7,0.416,12,1.295,42,0.173,46,2,88,3.95]],["title/52",[42,0.166,51,2.937]],["description/52",[7,0.416,12,1.295,42,0.173,51,3.055,89,3.95]],["title/53",[90,3.351]],["description/53",[2,1.761,7,0.387,43,1.59,46,1.86,90,2.594,91,3.172]],["title/54",[90,3.351]],["description/54",[2,1.761,7,0.387,43,1.59,46,1.86,90,2.594,91,3.172]],["title/55",[6,1.046,92,3.279]],["description/55",[2,1.894,6,1.088,43,1.709,92,3.411,93,3.95]],["title/56",[94,3.351]],["description/56",[2,1.761,7,0.387,43,1.59,46,1.86,94,2.594,95,3.172]],["title/57",[94,3.351]],["description/57",[2,1.761,7,0.387,43,1.59,46,1.86,94,2.594,95,3.172]],["title/58",[96,4.097]],["description/58",[96,4.402,97,5.099]],["title/59",[98,3.279,99,3.798]],["description/59",[10,1.078,12,1.126,98,2.965,100,2.656,101,2.656,102,2.656,103,3.435]],["title/60",[65,2.543]],["description/60",[10,1.078,12,1.126,65,1.841,100,2.656,101,2.656,102,2.656,104,3.435]],["title/61",[105,4.097]],["description/61",[10,1.078,12,1.126,100,2.656,101,2.656,102,2.656,105,2.965,106,3.435]]],"invertedIndex":[["action",{"_index":0,"title":{"0":{},"1":{},"2":{}},"description":{"0":{},"1":{},"2":{}}}],["add",{"_index":18,"title":{"6":{}},"description":{"29":{}}}],["aggreg",{"_index":40,"title":{},"description":{"16":{}}}],["api/3/com",{"_index":48,"title":{},"description":{"18":{}}}],["api/3/comments/flag",{"_index":72,"title":{},"description":{"37":{}}}],["api/3/comments/flagged/count",{"_index":73,"title":{},"description":{"38":{}}}],["api/3/comments/moderation/{statu",{"_index":67,"title":{},"description":{"35":{}}}],["api/3/comments/moderation/{status}/count",{"_index":70,"title":{},"description":{"36":{}}}],["api/3/comments/search",{"_index":57,"title":{},"description":{"24":{}}}],["api/3/comments/{id",{"_index":50,"title":{},"description":{"19":{},"20":{},"21":{}}}],["api/3/comments/{id}/attach",{"_index":75,"title":{},"description":{"39":{},"42":{}}}],["api/3/comments/{id}/attachments/{attachmentid",{"_index":76,"title":{},"description":{"40":{},"43":{}}}],["api/3/comments/{id}/attachments/{attachmentid}/delet",{"_index":77,"title":{},"description":{"44":{}}}],["api/3/comments/{id}/attachments/{attachmentid}/upd",{"_index":78,"title":{},"description":{"45":{}}}],["api/3/comments/{id}/attribut",{"_index":58,"title":{},"description":{"25":{},"26":{},"27":{}}}],["api/3/comments/{id}/attributes/delet",{"_index":59,"title":{},"description":{"28":{}}}],["api/3/comments/{id}/delet",{"_index":52,"title":{},"description":{"22":{}}}],["api/3/comments/{id}/flag",{"_index":61,"title":{},"description":{"29":{},"30":{}}}],["api/3/comments/{id}/flags/{flagid",{"_index":62,"title":{},"description":{"31":{},"32":{}}}],["api/3/comments/{id}/moder",{"_index":66,"title":{},"description":{"33":{},"34":{}}}],["api/3/comments/{id}/upd",{"_index":53,"title":{},"description":{"23":{}}}],["api/3/comments/{id}/votes/down",{"_index":85,"title":{},"description":{"48":{}}}],["api/3/comments/{id}/votes/neutr",{"_index":87,"title":{},"description":{"49":{}}}],["api/3/comments/{id}/votes/up",{"_index":83,"title":{},"description":{"47":{}}}],["api/3/monitoring/memori",{"_index":103,"title":{},"description":{"59":{}}}],["api/3/monitoring/statu",{"_index":104,"title":{},"description":{"60":{}}}],["api/3/monitoring/vers",{"_index":106,"title":{},"description":{"61":{}}}],["api/3/system/act",{"_index":5,"title":{},"description":{"1":{},"2":{}}}],["api/3/system/context",{"_index":17,"title":{},"description":{"5":{}}}],["api/3/system/context/al",{"_index":14,"title":{},"description":{"4":{}}}],["api/3/system/context/deleteprefer",{"_index":37,"title":{},"description":{"14":{}}}],["api/3/system/context/prefer",{"_index":34,"title":{},"description":{"12":{}}}],["api/3/system/context/preferences/email",{"_index":32,"title":{},"description":{"10":{},"11":{}}}],["api/3/system/context/preferences/email/config",{"_index":30,"title":{},"description":{"8":{},"9":{}}}],["api/3/system/context/updateprefer",{"_index":35,"title":{},"description":{"13":{}}}],["api/3/system/context/{id}/{profileid",{"_index":25,"title":{},"description":{"6":{}}}],["api/3/system/context/{id}/{profileid}/delet",{"_index":27,"title":{},"description":{"7":{}}}],["api/3/system/profile/clear",{"_index":41,"title":{},"description":{"16":{}}}],["api/3/threads/{id}/com",{"_index":88,"title":{},"description":{"51":{}}}],["api/3/threads/{id}/comments/{commentid}/children",{"_index":89,"title":{},"description":{"52":{}}}],["api/3/threads/{id}/subscrib",{"_index":91,"title":{},"description":{"53":{},"54":{}}}],["api/3/threads/{id}/subscribe/upd",{"_index":93,"title":{},"description":{"55":{}}}],["api/3/threads/{id}/unsubscrib",{"_index":95,"title":{},"description":{"56":{},"57":{}}}],["assign",{"_index":24,"title":{},"description":{"6":{},"7":{}}}],["attach",{"_index":74,"title":{"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{}},"description":{"39":{},"40":{},"41":{},"42":{},"43":{},"44":{},"45":{}}}],["attribut",{"_index":21,"title":{"25":{},"26":{},"27":{},"28":{}},"description":{"6":{},"7":{},"25":{},"26":{},"27":{},"28":{}}}],["both",{"_index":86,"title":{},"description":{"49":{}}}],["cach",{"_index":39,"title":{"16":{}},"description":{"16":{}}}],["chang",{"_index":64,"title":{},"description":{"33":{},"34":{}}}],["children",{"_index":51,"title":{"52":{}},"description":{"22":{},"52":{}}}],["clear",{"_index":38,"title":{"16":{}},"description":{"16":{},"49":{}}}],["comment",{"_index":42,"title":{"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"51":{},"52":{}},"description":{"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"42":{},"47":{},"48":{},"49":{},"51":{},"52":{}}}],["configur",{"_index":29,"title":{"8":{},"9":{}},"description":{"8":{},"9":{}}}],["content",{"_index":45,"title":{"43":{},"45":{}},"description":{"17":{},"41":{},"43":{},"46":{},"50":{}}}],["context",{"_index":4,"title":{"3":{},"4":{},"5":{},"6":{},"7":{},"12":{},"13":{},"14":{}},"description":{"1":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{}}}],["count",{"_index":68,"title":{"36":{},"38":{}},"description":{}}],["crafter",{"_index":100,"title":{},"description":{"59":{},"60":{},"61":{}}}],["creat",{"_index":15,"title":{"5":{},"18":{},"39":{}},"description":{"5":{},"18":{},"39":{}}}],["current",{"_index":2,"title":{"1":{}},"description":{"1":{},"47":{},"48":{},"49":{},"53":{},"54":{},"55":{},"56":{},"57":{}}}],["delet",{"_index":36,"title":{"14":{},"21":{},"22":{},"27":{},"28":{},"31":{},"32":{},"40":{},"44":{}},"description":{"14":{},"21":{},"22":{},"27":{},"31":{},"32":{},"40":{},"44":{},"45":{}}}],["detail",{"_index":102,"title":{},"description":{"59":{},"60":{},"61":{}}}],["down",{"_index":84,"title":{"48":{}},"description":{"48":{},"49":{}}}],["email",{"_index":28,"title":{"8":{},"9":{},"10":{},"11":{}},"description":{"8":{},"9":{},"10":{},"11":{}}}],["flag",{"_index":60,"title":{"29":{},"30":{},"31":{},"32":{},"37":{},"38":{}},"description":{"29":{},"30":{},"31":{},"32":{},"37":{},"38":{}}}],["gener",{"_index":44,"title":{},"description":{"17":{},"41":{},"46":{},"50":{}}}],["get",{"_index":3,"title":{},"description":{"1":{}}}],["given",{"_index":7,"title":{},"description":{"2":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"19":{},"20":{},"21":{},"22":{},"23":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"39":{},"40":{},"42":{},"43":{},"44":{},"45":{},"47":{},"48":{},"49":{},"51":{},"52":{},"53":{},"54":{},"56":{},"57":{}}}],["id",{"_index":23,"title":{},"description":{"6":{},"7":{}}}],["includ",{"_index":22,"title":{},"description":{"6":{}}}],["jvm",{"_index":101,"title":{},"description":{"59":{},"60":{},"61":{}}}],["list",{"_index":13,"title":{},"description":{"4":{},"6":{},"7":{}}}],["log",{"_index":82,"title":{},"description":{"47":{},"48":{},"49":{}}}],["manag",{"_index":11,"title":{},"description":{"3":{},"15":{},"17":{},"41":{},"46":{},"50":{}}}],["match",{"_index":55,"title":{},"description":{"24":{}}}],["memori",{"_index":98,"title":{"59":{}},"description":{"59":{}}}],["moder",{"_index":63,"title":{"33":{},"34":{},"35":{},"36":{}},"description":{"33":{},"34":{},"35":{},"36":{}}}],["monitor",{"_index":96,"title":{"58":{}},"description":{"58":{}}}],["name",{"_index":8,"title":{},"description":{"2":{}}}],["need",{"_index":47,"title":{},"description":{"18":{}}}],["new",{"_index":16,"title":{},"description":{"5":{},"18":{}}}],["number",{"_index":69,"title":{},"description":{"36":{},"38":{}}}],["on",{"_index":71,"title":{},"description":{"37":{},"38":{}}}],["oper",{"_index":97,"title":{},"description":{"58":{}}}],["paramet",{"_index":56,"title":{},"description":{"24":{}}}],["prefer",{"_index":33,"title":{"12":{},"13":{},"14":{}},"description":{"12":{},"13":{},"14":{}}}],["profil",{"_index":19,"title":{"6":{},"7":{},"15":{}},"description":{"6":{},"7":{},"15":{},"16":{}}}],["remov",{"_index":26,"title":{"7":{},"49":{}},"description":{"7":{}}}],["replac",{"_index":49,"title":{},"description":{"19":{}}}],["return",{"_index":12,"title":{},"description":{"4":{},"9":{},"11":{},"12":{},"20":{},"24":{},"30":{},"35":{},"36":{},"37":{},"38":{},"42":{},"43":{},"51":{},"52":{},"59":{},"60":{},"61":{}}}],["role",{"_index":9,"title":{},"description":{"2":{},"6":{},"7":{}}}],["search",{"_index":54,"title":{"24":{}},"description":{"24":{}}}],["secur",{"_index":1,"title":{},"description":{"0":{},"1":{}}}],["social",{"_index":10,"title":{"4":{},"5":{},"6":{},"7":{}},"description":{"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"59":{},"60":{},"61":{}}}],["socialcontext",{"_index":20,"title":{},"description":{"6":{},"7":{}}}],["stat",{"_index":99,"title":{"59":{}},"description":{}}],["statu",{"_index":65,"title":{"35":{},"36":{},"60":{}},"description":{"33":{},"34":{},"35":{},"36":{},"60":{}}}],["subscrib",{"_index":90,"title":{"53":{},"54":{}},"description":{"53":{},"54":{}}}],["subscript",{"_index":92,"title":{"55":{}},"description":{"55":{}}}],["templat",{"_index":31,"title":{"10":{},"11":{}},"description":{"10":{},"11":{}}}],["thread",{"_index":46,"title":{"50":{},"51":{}},"description":{"18":{},"50":{},"51":{},"53":{},"54":{},"56":{},"57":{}}}],["toggl",{"_index":81,"title":{},"description":{"47":{},"48":{}}}],["unsubscrib",{"_index":94,"title":{"56":{},"57":{}},"description":{"56":{},"57":{}}}],["up",{"_index":80,"title":{"47":{}},"description":{"47":{},"49":{}}}],["updat",{"_index":6,"title":{"2":{},"8":{},"10":{},"13":{},"19":{},"23":{},"25":{},"26":{},"29":{},"45":{},"55":{}},"description":{"2":{},"6":{},"7":{},"8":{},"10":{},"13":{},"23":{},"25":{},"26":{},"28":{},"55":{}}}],["user",{"_index":43,"title":{},"description":{"17":{},"41":{},"46":{},"47":{},"48":{},"49":{},"50":{},"53":{},"54":{},"55":{},"56":{},"57":{}}}],["version",{"_index":105,"title":{"61":{}},"description":{"61":{}}}],["vote",{"_index":79,"title":{"46":{},"47":{},"48":{},"49":{}},"description":{"46":{},"47":{},"48":{},"49":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/source/_static/api/studio.html b/source/_static/api/studio.html
index e037e5f94..12bb4ba08 100644
--- a/source/_static/api/studio.html
+++ b/source/_static/api/studio.html
@@ -456,7 +456,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Studio<!-- --> <span>(<!-- -->4.4.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Studio API&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-fkYqBV buanwU api-content"><div class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU api-info"><h1 class="sc-hwkwBN sc-jCWzJg wYHiz hPcPCj">Crafter Studio<!-- --> <span>(<!-- -->4.5.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><div class="sc-erPUmh eAqtbt"><div class="sc-iRTMaw beOrEi"><span class="sc-jVxTAy hijBKj">E-mail<!-- -->:<!-- --> <a href="mailto:info@craftercms.org">info@craftercms.org</a></span> <!-- --> <span class="sc-jVxTAy hijBKj">License:<!-- --> <a href="https://www.gnu.org/licenses/gpl-3.0.en.html">GPL 3.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-eVqvcJ sc-fszimp kIppRw kbZred"></div><div data-role="redoc-description" html="&lt;p&gt;Crafter Studio API&lt;/p&gt;
 " class="sc-eVqvcJ sc-fszimp kIppRw kbZred"><p>Crafter Studio API</p>
 </div><div class="sc-ixcdjX gvxrGF"><a href="https://craftercms.com/docs/current/reference/modules/studio.html">CrafterCMS - Studio</a></div></div></div></div><div id="tag/groups" data-section-id="tag/groups" class="sc-dTvVRJ bPmFpz"><div class="sc-jJLAfE gkiSyE"><div class="sc-ggWZvA fqkwbU"><h2 class="sc-kNOymR iFSqkw"><a class="sc-kcLKEh fRdsOi" href="#tag/groups" aria-label="tag/groups"></a>groups</h2></div></div><div class="sc-ggWZvA dCzIPc"><div class="sc-eVqvcJ sc-fszimp kIppRw kbZred redoc-markdown " html="&lt;p&gt;Group management operations&lt;/p&gt;
 "><p>Group management operations</p>
@@ -3713,7 +3713,7 @@
 " class="sc-eVqvcJ sc-fszimp sc-etsjJW kIppRw jnwENr ljKHqG"><p>Internal system failure</p>
 </div></button></div></div></div><div class="sc-jwTyAe sc-hjsuWn bDYKKx FFPsr"><div class="sc-eZSpzM jjnszm"><button class="sc-buTqWO iPCVMX"><span type="get" class="sc-fQLpxn dynMBc http-verb get">get</span><span class="sc-jvKoal kZcHWP">/api/2/dependency/dependent_items</span><svg class="sc-dntSTA iuNpUs" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ecJghI ga-DQLq"><div class="sc-iyBeIh icOxsG"><div html="" class="sc-eVqvcJ sc-fszimp kIppRw drqpJr"></div><div tabindex="0" role="button"><div class="sc-xKhEK okJpy"><span>http://localhost:8080/studio</span>/api/2/dependency/dependent_items</div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Request samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R157da»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R157da»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R157da»0" aria-labelledby="tab«R157da»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"siteId"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"path"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-lgpSej drJHMo"> <!-- -->Response samples<!-- --> </h3><div class="sc-cOpnSz fyxuKi" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R177da»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R177da»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R177da»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R177da»1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab«R177da»2" aria-selected="false" aria-disabled="false" aria-controls="panel«R177da»2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab«R177da»3" aria-selected="false" aria-disabled="false" aria-controls="panel«R177da»3" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab«R177da»4" aria-selected="false" aria-disabled="false" aria-controls="panel«R177da»4" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R177da»0" aria-labelledby="tab«R177da»0"><div><div class="sc-bSFBcf iLdyBp"><span class="sc-gahYZc cXitJ">Content type</span><div class="sc-bAehkN iNRAJK">application/json</div></div><div class="sc-blIAwI eKKwxo"><div class="sc-dClGHI fdRrNy"><div class="sc-bbbBoY bBWkcI"><button><div class="sc-fYmhhH iNCOCX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-eVqvcJ kIppRw sc-fhfEft dFvLDb"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"response"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"code"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"message"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"remedialAction"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"documentationUrl"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"items"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"items"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"path"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177da»1" aria-labelledby="tab«R177da»1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177da»2" aria-labelledby="tab«R177da»2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177da»3" aria-labelledby="tab«R177da»3"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R177da»4" aria-labelledby="tab«R177da»4"></div></div></div></div></div></div></div><div class="sc-evkzZa iZqpqg"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080/studio"}],"info":{"description":"Crafter Studio API","version":"4.4.4","title":"Crafter Studio","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Studio","url":"https://craftercms.com/docs/current/reference/modules/studio.html"},"tags":[{"name":"groups","description":"Group management operations"},{"name":"users","description":"User management operations"},{"name":"ui","description":"UI support operations"},{"name":"aws","description":"AWS operations"},{"name":"cluster","description":"Cluster management operations"},{"name":"sites","description":"Site management operations"},{"name":"search","description":"Search operations"},{"name":"audit","description":"Audit log operations"},{"name":"monitoring","description":"Monitoring operations"},{"name":"repository","description":"Repository operations"},{"name":"content","description":"Content operations"},{"name":"configuration","description":"Configuration operations"},{"name":"plugin","description":"Plugin operations"},{"name":"dependency","description":"Dependencies operations"},{"name":"marketplace","description":"Marketplace operations"},{"name":"webdav","description":"WebDAV operations"},{"name":"publishing","description":"Publishing operations"},{"name":"security","description":"Security operations"},{"name":"dashboard","description":"Dashboard operations"},{"name":"workflow","description":"Workflow operations"},{"name":"loggers","description":"Logger configuration operations"},{"name":"server","description":"Server operations"}],"paths":{"/api/2/groups":{"get":{"tags":["groups"],"summary":"Get all groups","operationId":"getGroups","description":"Required Permission: \"READ_GROUPS\"","parameters":[{"name":"keyword","in":"query","description":"The keyword to filter groups","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first group in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of groups to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by\ncommas. Example: `column1 ASC, column2 DESC`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["groups"],"summary":"Create group","description":"Required Permission: \"CREATE_GROUPS\"","operationId":"createGroup","requestBody":{"description":"Group entity to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"group":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["groups"],"summary":"Update group","description":"Required Permission: \"UPDATE_GROUPS\"","operationId":"updateGroup","requestBody":{"description":"Group entity to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"group":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["groups"],"summary":"Delete group(s)","description":"Required Permission: \"DELETE_GROUPS\"","operationId":"deleteGroup","parameters":[{"name":"id","in":"query","description":"The group ID(s). Can be repeated for multiple deletes (id=1&id=2&id=3)","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/groups/{id}":{"get":{"tags":["groups"],"summary":"Get group by ID","description":"Required Permission: \"READ_GROUPS\"","operationId":"getGroup","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"group":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/groups/{id}/members":{"get":{"tags":["groups"],"summary":"Get all the members of the specified group","description":"Required Permission: \"READ_GROUPS\"","operationId":"getGroupMembers","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by\ncommas. Example: `column1 ASC, column2 DESC`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["groups"],"summary":"Add member(s) to the specified group","description":"Required Permission: \"UPDATE_GROUPS\"","operationId":"addGroupMembers","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"List of user IDs and/or usernames to add","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"usernames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["groups"],"summary":"Remove member(s) from the specified group","description":"Required Permission: \"DELETE_GROUPS\"","operationId":"removeGroupMembers","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"userId","in":"query","description":"The user ID(s) to remove. Can be repeated for multiple deletes (userId=1&userId=2&userId=3)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"query","description":"The username(s) to remove. Can be repeated for multiple deletes (username=john&username=mark)","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users":{"get":{"tags":["users"],"summary":"Get all users","description":"Required Permission: \"READ_USERS\"","operationId":"getUsers","parameters":[{"name":"site_id","in":"query","description":"The site ID to filter users for a particular site","required":false,"schema":{"type":"string"}},{"name":"keyword","in":"query","description":"The keyword to filter users","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by\ncommas. Example: `column1 ASC, column2 DESC`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["users"],"summary":"Create user","description":"Required Permission: \"CREATE_USERS\"","operationId":"createUser","requestBody":{"description":"User entity to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["users"],"summary":"Update user","description":"Required Permission: \"UPDATE_USERS\"","operationId":"updateUser","requestBody":{"description":"User entity to update. Supported update attributes are firstName, lastName, email and enabled.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["users"],"summary":"Delete user(s)","description":"Required Permission: \"DELETE_USERS\"","operationId":"deleteUser","parameters":[{"name":"id","in":"query","description":"The user ID(s). Can be repeated for multiple deletes (id=1&id=2&id=3)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"query","description":"The username(s). Can be repeated for multiple deletes (username=john&username=mark)","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}":{"get":{"tags":["users"],"summary":"Get user by user ID or username","description":"Required Permission: \"READ_USERS\"","operationId":"getUser","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/enable":{"patch":{"tags":["users"],"summary":"Enable user(s)","description":"Required Permission: \"UPDATE_USERS\"","operationId":"enableUser","requestBody":{"description":"List of user IDs and/or usernames to enable","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"usernames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/disable":{"patch":{"tags":["users"],"summary":"Disable user(s)","description":"Required Permission: \"UPDATE_USERS\"","operationId":"disableUser","requestBody":{"description":"List of user IDs and/or usernames to disable","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"usernames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}/sites":{"get":{"tags":["users"],"summary":"Get all the sites the specified user has access to","description":"Required Permission: \"READ_USERS\"","operationId":"getUserSites","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first site in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of sites to return","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}/sites/{site}/roles":{"get":{"tags":["users"],"summary":"Get the site roles for the specified user","description":"Required Permission: \"READ_USERS\"","operationId":"getUserSiteRoles","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}},{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"roles":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}/reset_password":{"post":{"tags":["users"],"summary":"Reset password for user","description":"Required Permission: \"UPDATE_USERS\"","operationId":"resetUserPassword","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"request body to reset password for user","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"new":{"type":"string","description":"new password"}},"required":["username","new"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/set_password":{"post":{"tags":["users"],"summary":"Change password for user","description":"Required Permission: \"ANONYMOUS\"","operationId":"setUserPassword","requestBody":{"description":"request body to change password","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"new":{"type":"string","description":"new password"}},"required":["token","new"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me":{"get":{"tags":["users"],"summary":"Get current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUser","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"authenticatedUser":{"$ref":"#/components/schemas/AuthenticatedUser"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites":{"get":{"tags":["users"],"summary":"Get all the sites the current authenticated user has access to","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserSites","parameters":[{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites/{site}/roles":{"get":{"tags":["users"],"summary":"Get the site roles for the current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserSiteRoles","parameters":[{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"roles":{"type":"array","items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites/{site}/permissions":{"get":{"tags":["users"],"summary":"Get the site permissions for the current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserSitePermissions","parameters":[{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"array","items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites/{site}/has_permissions":{"post":{"tags":["users"],"summary":"Check if the current authenticated user has given permissions","description":"Required Permission: \"LOGGED_IN\"","operationId":"hasCurrentUserSitePermissions","parameters":[{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"request body to check if current authenticated user has permissions","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"}}},"required":["permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"object","example":{"create":true,"update":true,"delete":false}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/global/permissions":{"get":{"tags":["users"],"summary":"Get the global for the current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserGlobalPermissions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"array","items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/global/has_permissions":{"post":{"tags":["users"],"summary":"Check if the current authenticated user has given global permissions","description":"Required Permission: \"LOGGED_IN\"","operationId":"hasCurrentUserGlobalPermissions","requestBody":{"description":"request body to check if current authenticated user has permissions","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"}}},"required":["permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"object","example":{"create":true,"update":true,"delete":false}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/logout/sso/url":{"get":{"tags":["users"],"summary":"Get the SSO Service Provide logout URL for the current authenticated user","description":"* Required Permission: \"LOGGED_IN\"\n* The system should redirect to this logout URL `AFTER` local logout. Response entity can be null if user is\nnot authenticated through SSO or if logout is disabled","operationId":"getCurrentUserSsoLogoutUrl","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"logoutUrl":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/change_password":{"post":{"tags":["users"],"summary":"Change password for current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"currentUserChangePassword","requestBody":{"description":"request body to change password","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"current":{"type":"string","description":"current password"},"new":{"type":"string","description":"new password"}},"required":["username","current","new"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/properties":{"get":{"tags":["users"],"summary":"Retrieve properties for the current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getUserProperties","parameters":[{"name":"siteId","schema":{"type":"string"},"in":"query","description":"The id of the site (defaults to global)"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"properties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"description":"The properties of the current user grouped by site"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["users"],"summary":"Update properties for the current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"updateUserProperties","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site (defaults to global)"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Properties to update or add"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The properties of the current user after the updates"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["users"],"summary":"Delete properties for the current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"deleteUserProperties","parameters":[{"name":"siteId","in":"query","schema":{"type":"string"},"description":"The id of the site (defaults to global)"},{"name":"properties","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}},"description":"List of keys to delete"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The properties of the current user after the updates"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/forgot_password":{"get":{"tags":["users"],"summary":"Forgot password","description":"Required Permission: \"ANONYMOUS\"","operationId":"forgotPassword","parameters":[{"name":"username","in":"query","description":"The username of user that forgot password","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/validate_token":{"get":{"tags":["users"],"summary":"Validate forgot password token","description":"Required Permission: \"ANONYMOUS\"","operationId":"validateToken","parameters":[{"name":"token","in":"query","description":"forgot password token to be validated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/ui/views/global_menu":{"get":{"tags":["ui"],"summary":"Get the global menu items available to the current user","operationId":"getGlobalMenu","description":"Required Permission: \"LOGGED_IN\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"menuItems":{"type":"array","items":{"$ref":"#/components/schemas/MenuItem"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/ui/system/active_environment":{"get":{"tags":["ui"],"summary":"Get the current active environment for the system","operationId":"getActiveEnv","description":"Required Permission: \"LOGGED_IN\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"environment":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/aws/s3/list":{"get":{"tags":["aws"],"summary":"Get a list of items from an S3 bucket","operationId":"listItems","description":"Required Permission: \"s3_read\"","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","description":"The profile ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"The path of the directory to list (defaults to the root)","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of items to list (defaults to all types)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/S3Item"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/aws/s3/upload":{"post":{"tags":["aws"],"summary":"Upload a file to an S3 bucket","operationId":"uploadItem","description":"Required Permission: \"s3_write\"","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The site ID"},"profileId":{"type":"string","description":"The profile ID"},"path":{"type":"string","description":"The path where the file will be uploaded (will be used as part of the key in S3)"},"filename":{"type":"string","description":"The name of the file (will be used as part of the item key in S3)"},"file":{"type":"string","format":"binary","description":"The content of the file to upload"}},"required":["siteId","profileId","filename","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/S3Item"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/aws/mediaconvert/upload":{"post":{"tags":["aws"],"summary":"Upload a file to an S3 bucket and trigger a MediaConvert job","operationId":"uploadVideo","description":"Required Permission: \"s3_write\"","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The site ID"},"inputProfileId":{"type":"string","description":"The MediaConvert profile ID"},"outputProfileId":{"type":"string","description":"The S3 profile ID for the generated URLs"},"file":{"type":"string","format":"binary","description":"The content of the file to upload"}},"required":["siteId","inputProfileId","outputProfileId","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/MediaConvertResult"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/webdav/list":{"get":{"tags":["webdav"],"summary":"Get a list of items from a WebDAV server","description":"Required Permission: \"webdav_read\"","operationId":"listItemsWebdav","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","description":"The profile ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"The path of the directory to list (defaults to the root)","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The MIME-type of items to list, defaults to all","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/WebDavItem"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/webdav/upload":{"post":{"tags":["webdav"],"summary":"Upload a file to a WebDAV server","description":"Required Permission: \"webdav_write\"","operationId":"uploadItemWebdav","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The site ID"},"profileId":{"type":"string","description":"The profile ID"},"path":{"type":"string","description":"The path where the file will be uploaded"},"file":{"type":"string","format":"binary","description":"The content of the file to upload"}},"required":["siteId","profileId","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/WebDavItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/cluster":{"get":{"tags":["cluster"],"summary":"Get all the members of the cluster","description":"Required Permission: \"read_cluster\"","operationId":"getClusterMembers","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"clusterMembers":{"type":"array","items":{"$ref":"#/components/schemas/ClusterMember"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/cluster/mode":{"get":{"tags":["cluster"],"summary":"Get the local Studio instance cluster mode","description":"Required Permission: \"read_cluster\"","operationId":"getClusterMode","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"mode":{"type":"string","enum":["PRIMARY","REPLICA","UNKNOWN"]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/available_blueprints":{"get":{"tags":["sites"],"summary":"Get all available blueprints","description":"Required Permission: \"LOGGED_IN\"","operationId":"availableBlueprints","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"blueprints":{"type":"array","items":{"$ref":"#/components/schemas/PluginDescriptor"}}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/create_site_from_marketplace":{"post":{"tags":["sites"],"summary":"Create a site from a Marketplace blueprint","operationId":"createSiteFromMarketplace","requestBody":{"description":"The site information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSiteFromMarketplace"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}":{"post":{"tags":["sites"],"summary":"Updates the name and description for a given site","description":"Required Permission: \"edit_site\"","operationId":"updateSite","parameters":[{"name":"siteId","in":"path","required":true,"description":"The site ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the site","type":"string"},"description":{"description":"The description of the site","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["sites"],"summary":"Deletes a site","description":"Required Permission: \"delete_site\"","operationId":"deleteSite","parameters":[{"name":"siteId","in":"path","required":true,"description":"The site ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}/unlock":{"post":{"tags":["sites"],"summary":"Unlock a site locked with state LOCKED","description":"Required Permission: \"edit_site\"","operationId":"unlockSite","parameters":[{"name":"siteId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/ContentValidationResult"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}/policy/validate":{"post":{"tags":["sites"],"summary":"Verifies if all indicated actions are compliant with the site policies","operationId":"validate","parameters":[{"name":"siteId","in":"path","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentValidationRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/ContentValidationResult"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}/duplicate":{"post":{"tags":["sites"],"summary":"Duplicates a site","operationId":"duplicateSite","parameters":[{"name":"siteId","in":"path","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Duplicate site request information","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateSiteRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/services/api/1/site/create.json":{"post":{"tags":["sites"],"summary":"Create a Crafter Studio project.","description":"Required Role: \"Admin\"","operationId":"createSite","requestBody":{"description":"Project/site details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"description":"Project/Site ID to use","type":"string","example":"my-editorial"},"name":{"type":"string","description":"Label to use for the project/site"},"sandbox_branch":{"type":"string","description":"Name for sandbox branch (default: master)"},"description":{"type":"string","description":"Project/Site description","example":"My very first site!"},"blueprint":{"type":"string","description":"Blueprint to use for bootstrapping the project/site \n\n <i>Required if</i> `use_remote` <i>is false</i>","example":"org.craftercms.blueprint.empty"},"use_remote":{"type":"boolean","description":"Use remote repository option if true, otherwise false","example":false},"remote_name":{"type":"string","description":"Remote repository name (default: origin)"},"remote_url":{"type":"string","description":"Remote repository URL \n\n <i>Required if</i> `use_remote` <i>is true</i>"},"remote_branch":{"type":"string","description":"Branch to clone repo from"},"single_branch":{"type":"string","description":"Clone single branch if true, otherwise clone all"},"authentication_type":{"type":"string","description":"Authentication type to use to access remote repository \n\n \t none: No authentication \n\n \t basic: username password authentication \n\n \t token: username token authentication \n\n \t key: key-based authentication \n\n <i>Required if</i> `authentication_type` <i>to be used is not</i> `none`"},"remote_username":{"type":"string","description":"Username to access remote repository \n\n <i>Required if</i> `authentication_type` <i>is set to</i> `basic`"},"remote_password":{"type":"string","description":"Password to access remote repository \n\n <i>Required if</i> `authentication_type` <i>is set to</i> `basic`"},"remote_token":{"type":"string","description":"Token to use to access remote repository \n\n <i>Required if</i> `authentication_type` <i>is set to</i> `token`"},"remote_private_key":{"type":"string","description":"Private key to access remote repository"},"create_option":{"type":"string","description":"Create options for remote repository: \n\n `clone`: clone from remote repository <i>Required if</i> `use_remote` <i>is true</i>"},"site_params":{"type":"object","description":"Object containing all parameters for the blueprint. It should include all required parameters from the descriptor"},"create_as_orphan":{"type":"boolean","description":"Create the project/site from a remote repository as orphan (no git history) - default is false"}},"required":["site_id","name"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"OK"}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"409":{"$ref":"#/components/responses/api1Conflict"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/delete-site.json":{"post":{"tags":["sites"],"summary":"Delete a Crafter Studio project.","description":"Required Role: \"Admin\"","operationId":"deleteSiteAPI1","requestBody":{"description":"Project/site to delete","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"description":"Project/Site ID to use","type":"string","example":"my-editorial"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean","example":true}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"409":{"$ref":"#/components/responses/api1Conflict"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/exists.json":{"get":{"tags":["sites"],"summary":"Check if Crafter Studio project/site exists.","description":"Required role: admin, member in the project/site","operationId":"projectExists","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/get-canned-message.json":{"get":{"tags":["sites"],"summary":"Get rejection reason.","description":"No required role","operationId":"getCannedMessage","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Locale of message","required":true,"schema":{"type":"string"},"example":"en"},{"name":"type","in":"query","description":"Message type","required":true,"schema":{"type":"string"},"example":"Typos"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"string","example":"This content has multiple spelling errors and/or grammatical errors. Please correct and re-submit."}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/get.json":{"get":{"tags":["sites"],"summary":"Get a Crafter Studio project/site","description":"No required role","operationId":"getSite","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"},"example":{"id":8,"siteUuid":"8d71254a-ceb3-409a-bb59-610505764a77","siteId":"third","name":"third","description":"null","deleted":0,"liveUrl":"null","lastCommitId":"5cb6fe1a1f2fa5aa38d372c757c8db8f0f17ecb3","publishingEnabled":1,"publishingStatus":"ready","lastVerifiedGitlogCommitId":"5cb6fe1a1f2fa5aa38d372c757c8db8f0f17ecb3","sandboxBranch":"master","publishedRepoCreated":0,"state":"READY","lastSyncedGitlogCommitId":"5cb6fe1a1f2fa5aa38d372c757c8db8f0f17ecb3","siteDeleted":false,"sitePublishedRepoCreated":false}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/monitor-content.json":{"get":{"tags":["sites"],"summary":"Get all projects/sites content monitors","description":"Required role: none","operationId":"monitorContent","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"site_id":{"type":"string"},"contentMonitoring":{"type":"object","properties":{"monitors":{"type":"array","items":{"type":"string"}}}}}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/publish/commits.json":{"post":{"tags":["publishing"],"summary":"Publish commits from sandbox repository by commit id.","description":"Required role: Admin, Site Admin or the permission 'publish_by_commits'","operationId":"publishCommits","requestBody":{"description":"Publish commits from sandbox repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site to use"},"environment":{"type":"string","description":"Environment to deploy content"},"commit_ids":{"type":"array","items":{"type":"string"},"description":"List of commit ids to publish"},"comment":{"type":"string","description":"Submission comment"}},"example":{"site_id":"my-editorial","environment":"live","commit_ids":["c89ee1cb2be4b41b0966d20c12d53b68ca70d74a","0664df1ad04a9627dccb55a51ebf3704e313e40b","93ae0e5e8d084fa9b7723cf3cf7ce526f47af0a9"],"comment":"My submission comment"},"required":["site_id","environment","commit_ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/publish/start.json":{"post":{"tags":["publishing"],"summary":"Start Crafter Studio’s publishing for a project/site.","description":"Required role: Admin, Site Admin","operationId":"publishStart","requestBody":{"description":"Start project/site publishing request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site ID to use"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/publish/stop.json":{"post":{"tags":["publishing"],"summary":"Stop Crafter Studio’s publishing for a project/site.","description":"Required role: Admin, Site Admin","operationId":"publishStop","requestBody":{"description":"Stop project/site publishing request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site ID to use"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/dependency/get-dependant.json":{"post":{"tags":["dependency"],"summary":"Get dependant content items.","description":"Required role: N/A","operationId":"getDependant","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/templates/web/pages/home.ftl"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/dependency/get-simple-dependencies.json":{"post":{"tags":["dependency"],"summary":"Get simple dependencies.","description":"Required role: N/A","operationId":"getSimpleDependencies","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/deployment/bulk-golive.json":{"post":{"tags":["deployment"],"summary":"Bulk go live.","description":"Required role: N/A","operationId":"bulkGoLive","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website"},{"name":"environment","in":"query","schema":{"type":"string"},"description":"Environment to deploy content","required":true,"example":"Live"},{"name":"comment","in":"query","schema":{"type":"string"},"description":"Submission comment"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/preview/sync-site.json":{"post":{"tags":["preview"],"summary":"Sync preview content with repository","description":"Required role: N/A","operationId":"syncSite","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/content/change-content-type.json":{"post":{"tags":["content"],"summary":"Change template for the content.","description":"Required role: N/A","operationId":"changeContentType","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"},{"name":"contentType","in":"query","schema":{"type":"string"},"description":"Content type to change to","required":true,"example":"/page/generic"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/content/create-folder.json":{"post":{"tags":["content"],"summary":"Create folder.","description":"Required role: N/A","operationId":"createFolder","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/"},{"name":"name","in":"query","schema":{"type":"string"},"description":"Name of the new folder","required":true,"example":"newFolder"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"boolean"}},"example":{"message":true}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/services/api/1/content/rename-folder.json":{"post":{"tags":["content"],"summary":"Rename folder.","description":"Required role: N/A","operationId":"renameFolder","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/"},{"name":"name","in":"query","schema":{"type":"string"},"description":"New name of the folder","required":true,"example":"newFolder"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"true"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/services/api/1/content/get-content.json":{"get":{"tags":["content"],"summary":"Get content stream.","description":"Required role: N/A","operationId":"getContent","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/health/index.xml"},{"name":"edit","in":"query","schema":{"type":"boolean"},"description":"True to make content locked","required":true,"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string"}}},"example":{"content":"<page>\n\t<content-type>/page/category-landing</content-type>\n\t<display-template>/templates/web/pages/category-landing.ftl</display-template>\n\t<no-template-required/>\n\t<merge-strategy>inherit-levels</merge-strategy>\n\t<objectGroupId>0557</objectGroupId>\n\t<objectId>05573d7a-3556-1ad0-6e34-9b085944fee2</objectId>\n\t<file-name>index.xml</file-name>\n\t<folder-name>health</folder-name>\n\t<placeInNav>true</placeInNav>\n\t<orderDefault_f>9000</orderDefault_f>\n\t<internal-name>Health</internal-name>\n\t<title_t>Health</title_t>\n\t<createdDate>2017-03-14T15:21:57.000Z</createdDate>\n\t<createdDate_dt>2017-03-14T15:21:57.000Z</createdDate_dt>\n\t<lastModifiedDate>2020-10-07T12:08:00.200Z</lastModifiedDate>\n\t<lastModifiedDate_dt>2020-10-07T12:08:00.200Z</lastModifiedDate_dt>\n\t<category_s>health</category_s>\n\t<max_articles_i>10</max_articles_i>\n\t<articles_title_t>Health</articles_title_t>\n\t<disabled>false</disabled>\n\t<header_o item-list=\"true\"/>\n\t<left_rail_o item-list=\"true\"/>\n</page>\n"}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"}}}},"/api/1/services/api/1/content/get-content-at-path.json":{"get":{"tags":["content"],"summary":"Get content stream at path.","description":"Required role: N/A","operationId":"getContentAtPath","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/health/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"contentStream":{"type":"object","properties":{"type":{"type":"integer"},"size":{"type":"integer"}}},"contentPath":{"type":"string"}}},"example":{"contentStream":{"type":3,"size":1699},"contentPath":"/site/website/health/index.xml"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-content-type.json":{"get":{"tags":["content"],"summary":"Get content type configuration.","description":"Required role: N/A","operationId":"getContentType","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"},"description":"Content type","required":true,"example":"/page/category-landing"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentType"},"example":{"name":"/page/category-landing","label":"Category Landing","form":"/page/category-landing","formPath":"simple","type":"page","contentAsFolder":true,"useRoundedFolder":false,"modelInstancePath":"NOT-USED-BY-SIMPLE-FORM-ENGINE","allowedRoles":[],"lastUpdated":"2023-11-10T18:00:05.882948Z","copyDependencyPattern":[],"imageThumbnail":"page-category-landing.png","noThumbnail":false,"pathIncludes":["^/site/website/(?!articles/)(.*)"],"pathExcludes":[],"nodeRef":"null","quickCreate":false,"quickCreatePath":"","deleteDependencyPattern":[],"previewable":true}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-content-types.json":{"get":{"tags":["content"],"summary":"Get content types allowed for given path.","description":"Required role: N/A","operationId":"getContentTypes","parameters":[{"name":"site","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path to get content types for","required":true,"example":"/site/website/"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentType"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-item.json":{"get":{"tags":["content"],"summary":"Get content item.","description":"Required role: N/A","operationId":"getItem","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentItemV1"}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"}}}},"/api/1/services/api/1/content/get-item-orders.json":{"get":{"tags":["content"],"summary":"Get item orders.","description":"Required role: N/A","operationId":"getItemOrders","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/style/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/ContentItemV1"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemOrder"}}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-item-versions.json":{"get":{"tags":["content"],"summary":"Get content item version history.","description":"Required role: N/A","operationId":"getItemVersions","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemVersions"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-items-tree.json":{"get":{"tags":["content"],"summary":"Get items tree.","description":"Required role: N/A","operationId":"getItemsTree","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"},{"name":"depth","in":"query","schema":{"type":"integer"},"description":"Depth of the tree to display","required":true,"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentItemV1"}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-next-item-order.json":{"get":{"tags":["content"],"summary":"Get next item order.","description":"Required role: N/A","operationId":"getNextItemOrder","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the parent item","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"nextValue":{"type":"number"}}},"example":1000}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-pages.json":{"get":{"tags":["content"],"summary":"Get pages. Gets tree of content items for given path.","description":"Required role: N/A","operationId":"getPages","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"},{"name":"depth","in":"query","schema":{"type":"integer"},"description":"Depth of the tree to display","required":true,"example":1},{"name":"order","in":"query","schema":{"type":"string"},"description":"Order of content items.","required":true,"example":"default"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemV1"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/reorder-items.json":{"get":{"tags":["content"],"summary":"Reorder content items.","description":"Required role: N/A","operationId":"reorderItems","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/health/index.xml"},{"name":"before","in":"query","schema":{"type":"string"},"description":"Item before the item with given path","required":true,"example":1},{"name":"after","in":"query","schema":{"type":"string"},"description":"Item after the item with given path","required":true,"example":"default"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orderValue":{"type":"number"}}},"example":10500}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/content/revert-content.json":{"get":{"tags":["content"],"summary":"Revert content item to a specific version.","description":"Required role: N/A","operationId":"revertContent","parameters":[{"name":"site","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/style/index.xml"},{"name":"version","in":"query","schema":{"type":"string"},"description":"Version to revert to","required":true,"example":"818e0f68bfccda9a9a1a788341b87ca3ba5ad3c6"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean","example":true}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/write-content.json":{"post":{"tags":["content"],"summary":"Write content.","description":"Required role: Author <br><br> Options:<br>WriteContentWebForm: Save content using Create/Edit web form.<br> WriteContentAssetForm: Save content using asset form (templates, javascript, css, groovy).<br> WriteContentFileUpload: File upload (multipart request)","operationId":"writeContent","parameters":[{"in":"query","name":"filter","required":true,"style":"form","explode":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/WriteContentWebForm","additionalProperties":false},{"$ref":"#/components/schemas/WriteContentAssetForm","additionalProperties":false},{"$ref":"#/components/schemas/WriteContentFileUpload","additionalProperties":false}]}}],"requestBody":{"description":"Write content request body <br> Use \"multipart/form-data\" when uploading a file (WriteContentFileUpload)","required":true,"content":{"text/plain":{"schema":{"type":"string"},"examples":{"writeContentWebForm":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?> <!-- ~ Copyright (C) 2007-2024 Crafter Software Corporation. All Rights Reserved. ~ ~ This program is free software: you can redistribute it and/or modify ~ it under the terms of the GNU General Public License version 3 as published by ~ the Free Software Foundation. ~ ~ This program is distributed in the hope that it will be useful, ~ but WITHOUT ANY WARRANTY; without even the implied warranty of ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the ~ GNU General Public License for more details. ~ ~ You should have received a copy of the GNU General Public License ~ along with this program.  If not, see <http://www.gnu.org/licenses/>. --><page> <content-type>/page/article</content-type> <display-template>/templates/web/pages/article.ftl</display-template> <merge-strategy>inherit-levels</merge-strategy> <objectGroupId>f1f9</objectGroupId> <objectId>f1f9c488-67e1-7ec0-d3ca-560b194e64d1</objectId> <sections_o> <item> <section_html><![CDATA[<p>Nulla sed enim ipsum. Sed ac neque a ligula malesuada volutpat. Donec et ligula rutrum, mattis mauris eget, vestibulum metus. Maecenas non vehicula neque. Nunc ac mauris id ipsum commodo tempus. Integer at dolor consequat, dignissim eros in, imperdiet dui. Aliquam condimentum turpis eget tellus ultrices tincidunt. Pellentesque id varius purus, ac tristique augue. Etiam ut pharetra purus. Vestibulum quis vehicula eros. Mauris laoreet purus nec felis ullamcorper convallis. test</p> <p>Quisque urna purus, posuere nec urna sed, ornare aliquet mauris. In faucibus vitae tellus id iaculis. Donec porttitor, elit eu elementum pulvinar, sapien ex cursus lacus, non ornare ex lectus ut elit. Donec eros ligula, suscipit eu tellus ut, tristique hendrerit tortor. Fusce sollicitudin mollis risus, ut rhoncus magna volutpat vel. Cras auctor, elit id pellentesque semper, neque nibh fermentum ante, sit amet malesuada felis magna nec enim. Vivamus sollicitudin placerat felis, vel blandit dolor sollicitudin a. Nunc vitae volutpat augue. Nunc tristique placerat tortor condimentum sagittis. Sed eu egestas ex, quis auctor neque. Nam eget tellus suscipit, vestibulum augue nec, consequat erat. Mauris malesuada nec ligula non posuere. Proin vitae posuere tortor. Phasellus vulputate quam ut dictum vulputate.</p> <p>Integer ac lectus metus. Ut aliquam ipsum ligula, quis molestie ex pretium sit amet. Morbi porttitor neque vel luctus laoreet. Mauris varius lacus a eros aliquam, in maximus nibh aliquam. Integer sodales consequat metus eget accumsan. Integer viverra mi erat, in hendrerit massa vestibulum placerat. Sed ut gravida nisl, ut cursus neque. Vestibulum tristique rutrum augue vel aliquet.</p> <p>Ut quis faucibus diam. Aliquam dolor metus, laoreet vitae lacinia a, aliquam a tellus. Vivamus sed commodo ipsum, in lacinia nisl. Sed metus diam, porta eget tortor et, vehicula hendrerit sapien. Vestibulum vehicula urna felis, id elementum libero pellentesque id. Vivamus in massa velit. Suspendisse vitae turpis fermentum lectus pellentesque laoreet. Curabitur viverra pretium turpis, eget feugiat mi blandit a. Quisque nisl urna, porta ut urna eget, mattis fringilla nisi. Ut lacus ligula, dapibus ac fermentum ac, rhoncus eget metus. Donec scelerisque, felis vitae viverra iaculis, diam sem gravida tellus, non sodales urna urna sit amet enim. Duis id justo vitae justo suscipit porta placerat vel ligula. Morbi justo nunc, rhoncus laoreet ipsum a, aliquet eleifend dui. In a quam tortor.</p> <p>Pellentesque eget eros ut dui tincidunt convallis. Pellentesque tincidunt rutrum tellus, non rhoncus dui finibus eu. Integer eu sem maximus, blandit neque eu, congue leo. Ut pretium efficitur turpis, id dapibus turpis bibendum vel. Suspendisse a nibh dictum, imperdiet est et, interdum odio. Morbi urna magna, eleifend vitae luctus ac, scelerisque sit amet nisi. Quisque maximus placerat ante et fermentum. Nulla eu aliquet arcu, vel maximus massa. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam posuere arcu ex, in sagittis orci rhoncus eu. Suspendisse potenti. Curabitur facilisis sapien et ligula tristique lacinia. Aliquam a mauris bibendum, placerat augue sit amet, hendrerit arcu. Nam in bibendum sapien. Pellentesque laoreet nisi vel metus dapibus dictum. Integer semper, velit laoreet ornare maximus, nulla orci maximus ante, a tincidunt eros risus blandit eros.</p>]]></section_html> </item> </sections_o> <file-name>index.xml</file-name> <folder-name>men-styles-for-winter</folder-name> <internal-name>Men Styles For Winter</internal-name> <title_t>Men Styles For Winter</title_t> <subject_t>Men Styles For Winter</subject_t> <author_s>John Doe</author_s> <categories_o> <item> <key>style</key> <value_smv>Style</value_smv> </item> </categories_o> <segments_o> <item> <key>guy</key> <value_smv>Guy</value_smv> </item> </segments_o> <date_dt>2021-01-05T05:00:00.000Z</date_dt> <createdDate>2017-03-3T20:57:7.000Z</createdDate> <createdDate_dt>2017-03-3T20:57:7.000Z</createdDate_dt> <lastModifiedDate>2017-03-13T20:33:5.000Z</lastModifiedDate> <lastModifiedDate_dt>2023-11-20T13:25:05.289Z</lastModifiedDate_dt> <featured_b>true</featured_b> <summary_t>Nulla sed enim ipsum. Sed ac neque a ligula malesuada volutpat. Donec et ligula rutrum, mattis mauris eget, vestibulum metus. Maecenas non vehicula neque. Nunc ac mauris id ipsum commodo tempus. Integer at dolor consequat, dignissim eros in, imperdiet dui.</summary_t> <image_s>/static-assets/images/winter-man-pic.jpg</image_s> </page>"},"writeContentAssetForm":{"value":"<#import \"/templates/system/common/cstudio-support.ftl\" as studio />\n<!DOCTYPE HTML> <!-- Editorial by HTML5 UP html5up.net | @ajlkn Free for personal and commercial use under the CCA 3.0 license (html5up.net/license) Test write-content --> <html> <head> <title>${contentModel.title_t}</title> <meta charset=\"utf-8\" /> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, user-scalable=no\" /> <!--[if lte IE 8]><script src=\"/static-assets/js/ie/html5shiv.js\"><\/script><![endif]--> <link rel=\"stylesheet\" href=\"/static-assets/css/main.css?v=${siteContext.siteName}\" /> <!--[if lte IE 9]><link rel=\"stylesheet\" href=\"/static-assets/css/ie9.css\" /><![endif]--> <!--[if lte IE 8]><link rel=\"stylesheet\" href=\"/static-assets/css/ie8.css\" /><![endif]--> <link rel=\"stylesheet\" href=\"/static-assets/css/jquery-ui.min.css\" /> </head> <body> <!-- Wrapper --> <div id=\"wrapper\">\n<!-- Main --> <div id=\"main\"> <div class=\"inner\">\n<!-- Header --> <@renderComponent component=contentModel.header_o.item />\n<!-- Banner --> <section id=\"banner\" <@studio.iceAttr iceGroup=\"hero\"/>> <div class=\"content\"> <header>${contentModel.hero_title_html}</header> ${contentModel.hero_text_html} </div> <span class=\"image object\"> <img src=\"${contentModel.hero_image_s !\"\"}\" alt=\"\" /> </span> </section>\n<!-- Section --> <section <@studio.iceAttr iceGroup=\"features\"/>> <header class=\"major\"> <h2>${contentModel.features_title_t}</h2> </header> <div class=\"features\" <@studio.componentContainerAttr target=\"features_o\" component=contentModel/>> <#if contentModel.features_o?? && contentModel.features_o.item??> <#list contentModel.features_o.item as feature> <@renderComponent component=feature /> </#list> </#if> </div> </section>\n<!-- Section --> <section> <header class=\"major\"> <h2>Featured Articles</h2> </header> <div class=\"posts\"> <#list articles as article> <article> <a href=\"${article.url}\" class=\"image\"> <#if article.image??> <#assign articleImage = article.image/> <#else> <#assign articleImage = \"/static-assets/images/placeholder.png\"/> </#if> <img src=\"${articleImage}\" alt=\"\" /> </a> <h3><a href=\"${article.url}\">${article.title}</a></h3> <p>${article.summary}</p> <ul class=\"actions\"> <li><a href=\"${article.url}\" class=\"button\">More</a></li> </ul> </article> </#list> </div> </section>\n</div> </div>\n<!-- Left Rail --> <@renderComponent component=contentModel.left\\-rail_o.item />\n</div>\n<!-- Scripts --> <script src=\"/static-assets/js/jquery.min.js\"><\/script> <script src=\"/static-assets/js/jquery-ui.min.js\"><\/script> <script src=\"/static-assets/js/skel.min.js\"><\/script> <script src=\"/static-assets/js/util.js\"><\/script> <!--[if lte IE 8]><script src=\"/static-assets/js/ie/respond.min.js\"><\/script><![endif]--> <script src=\"/static-assets/js/main.js?v=${siteContext.siteName}\"><\/script>\n<@studio.toolSupport/> </body> </html>"}}},"multipart/form-data":{"schema":{"type":"object","properties":{"site":{"type":"string","description":"the project/site id","example":"mysite"},"path":{"type":"string","description":"the folder in your site where you want to upload your file","example":"/static-assets"},"file":{"type":"string","description":"the file to be uploaded","format":"binary"}},"required":["site","path","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":null}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/server/get-available-languages.json":{"get":{"tags":["server"],"summary":"Get available languages.","description":"Required role: N/A","operationId":"getAvailableLanguages","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableLanguage"},"example":[{"id":"en","label":"English"},{"id":"es","label":"Español"},{"id":"kr","label":"한국어"}]}}}}}}},"/api/2/search/search":{"post":{"tags":["search"],"summary":"Performs a search for the given site","operationId":"search","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Search Parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchParams"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/SearchResult"}}}}}}}}},"/api/2/audit":{"get":{"tags":["audit"],"summary":"Get audit log","description":"Required permission \"AUDIT_LOG\"","operationId":"getAuditLog","parameters":[{"name":"siteId","in":"query","description":"Site ID (site identifier) - optional for super admin user, otherwise required","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"user","in":"query","description":"Filter log by user name","required":false,"schema":{"type":"string"}},{"name":"operations","in":"query","description":"Filter log by operations","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"includeParameters","in":"query","description":"Include parameters into result set if `true`. Default `false`","required":false,"schema":{"type":"boolean"}},{"name":"dateFrom","in":"query","description":"Lower boundary in date range query","required":false,"schema":{"type":"string"}},{"name":"dateTo","in":"query","description":"Upper boundary in date range query","required":false,"schema":{"type":"string"}},{"name":"target","in":"query","description":"Regular expression to filter target values","required":false,"schema":{"type":"string"}},{"name":"origin","in":"query","description":"Origin filter for audit log. Possible values `API` and `GIT`","required":false,"schema":{"type":"string"}},{"name":"clusterNodeId","in":"query","description":"Cluster node id filter for audit log","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort result set by specified field. Possible values `date`.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Order in sorted result. Possible values `ASC` and `DESC`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"auditLog":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/audit/{id}":{"get":{"tags":["audit"],"summary":"Get audit log entry","operationId":"getAuditLogById","parameters":[{"name":"id","in":"path","description":"The log entry ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"siteId","in":"query","description":"Site ID (site identifier) - optional for super admin user, otherwise required","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"auditLog":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/version":{"get":{"tags":["monitoring"],"summary":"Get the current version information","operationId":"getVersion","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"version":{"$ref":"#/components/schemas/VersionItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/status":{"get":{"tags":["monitoring"],"summary":"Get the current status information","operationId":"getStatus","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"status":{"$ref":"#/components/schemas/StatusItem"}}}}}},"202":{"description":"Replica responding status OK. Primary will respond with status 200","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"status":{"$ref":"#/components/schemas/ClusterStatusItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/memory":{"get":{"tags":["monitoring"],"summary":"Get the current memory information","operationId":"getMemory","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"memory":{"$ref":"#/components/schemas/MemoryItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/log":{"get":{"tags":["monitoring"],"summary":"Get the log events for a specific time period","operationId":"getLogEvents","parameters":[{"name":"since","in":"query","description":"The time in milliseconds from which events should be fetched","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"events":{"type":"array","items":{"$ref":"#/components/schemas/LogEvent"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/disk":{"get":{"tags":["monitoring"],"summary":"Get disk usage statistics","operationId":"getDiskUsage","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"disk":{"$ref":"#/components/schemas/DiskUsage"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/add_remote":{"post":{"tags":["repository"],"summary":"Add remote repository to the site content repository","description":"Required permission \"add_remote\"","operationId":"addRemoteRepository","requestBody":{"description":"Remote repository entity","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteRepository"}}}},"responses":{"201":{"description":"Added","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/pull_from_remote":{"post":{"tags":["repository"],"summary":"Pull content from remote repository to site content repository","description":"Required permission \"pull_from_remote\"","operationId":"pullFromRemoteRepository","requestBody":{"description":"pull from remote repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"remoteName":{"type":"string","description":"Remote repository name to pull from"},"remoteBranch":{"type":"string","description":"Remote repository branch to pull from"},"mergeStrategy":{"type":"string","format":"theirs, ours, none","description":"Merge strategy to use when pulling content from remote repository"}},"required":["siteId","remoteName","remoteBranch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"type":"object","properties":{"successful":{"type":"boolean","description":"Indicates if the pull was successful"},"commitsMerged":{"type":"integer","format":"int64","description":"Total number of commits merged from the remote repository"},"mergeCommitId":{"type":"string","description":"The merge commit id"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/push_to_remote":{"post":{"tags":["repository"],"summary":"Push content to remote repository from site content repository","description":"Required permission \"push_to_remote\"","operationId":"pushToRemoteRepository","requestBody":{"description":"push to remote repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"remoteName":{"type":"string","description":"Remote repository name to push to"},"remoteBranch":{"type":"string","description":"Remote repository branch to push to"},"force":{"type":"boolean","description":"Indicates whether to force push to remote or not"}},"required":["siteId","remoteName","remoteBranch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/remove_remote":{"post":{"tags":["repository"],"summary":"Remove remote repository from site content repository","description":"Required permission \"remove_remote\"","operationId":"removeRemoteRepository","requestBody":{"description":"remove remote repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"remoteName":{"type":"string","description":"Remote repository name of remote to be removed"}},"required":["siteId","remoteName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/list_remotes":{"get":{"tags":["repository"],"summary":"List remote repositories for a site","description":"Required permission \"list_remote\"","operationId":"listRemoteRepositories","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"remotes":{"type":"array","items":{"$ref":"#/components/schemas/RemoteRepositoryInfo"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/status":{"get":{"tags":["repository"],"summary":"Get status of repository for a site","description":"Required permission \"site_status\"","operationId":"repositoryStatus","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/resolve_conflict":{"post":{"tags":["repository"],"summary":"Resolve a conflict for a file by accepting ours or theirs","description":"Required permission \"resolve_conflict\"","operationId":"resolveConflict","requestBody":{"description":"resolve conflict request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"path":{"type":"string","description":"Conflicted file path"},"resolution":{"type":"string","description":"resolution mechanism to use (ours, theirs)"}},"required":["siteId","path","resolution"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/diff_conflicted_file":{"get":{"tags":["repository"],"summary":"Get the difference between ours and theirs for a conflicted file for a site","description":"Required permission \"site_diff_conflicted_file\"","operationId":"diffConflictedFile","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path of conflicted file","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"diff":{"type":"object","properties":{"diff":{"type":"string","description":"difference between ours and theirs"},"studioVersion":{"type":"string","description":"studio's version of the file content"},"remoteVersion":{"type":"string","description":"remote repository version of the file content"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/commit_resolution":{"post":{"tags":["repository"],"summary":"Commit a resolved set of conflicts for a site","description":"Required permission \"commit_resolution\"","operationId":"commitResolution","requestBody":{"description":"Commit resolution request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"commitMessage":{"type":"string","description":"Commit message"}},"required":["siteId","commitMessage"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/cancel_failed_pull":{"post":{"tags":["repository"],"summary":"Cancel a failed/conflicted pull for a site","description":"Required permission \"cancel_failed_pull\"","operationId":"cancelFailedPull","requestBody":{"description":"cancel failed pull request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"}},"required":["siteId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/unlock":{"post":{"tags":["repository"],"summary":"Unlock local git repository","description":"Required role \"system_admin\" for global, \"admin\" for site sandbox or published","operationId":"unlockRepository","requestBody":{"description":"Unlock local git repository request","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID, do not send if unlocking the GLOBAL repository"},"repositoryType":{"type":"string","format":"GLOBAL, SANDBOX or PUBLISHED"}},"required":["repositoryType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/corrupted":{"get":{"tags":["repository"],"summary":"Check if a given repository is corrupted","description":"Required role \"system_admin\" for global, \"admin\" for site sandbox or published","operationId":"isRepositoryCorrupted","parameters":[{"name":"siteId","in":"query","schema":{"type":"string"},"description":"site ID, do not send if checking the GLOBAL repository"},{"name":"repositoryType","required":true,"in":"query","schema":{"type":"string","format":"GLOBAL, SANDBOX or PUBLISHED"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"corrupted":{"type":"boolean"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/repair":{"post":{"tags":["repository"],"summary":"Repair local git repository","description":"Required role \"system_admin\" for global, \"admin\" for site sandbox or published","operationId":"repairCorruptedRepository","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID, do not send if repairing the GLOBAL repository"},"repositoryType":{"type":"string","format":"GLOBAL, SANDBOX or PUBLISHED"}},"required":["repositoryType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/model/{siteId}/definitions":{"post":{"tags":["model"],"summary":"Get all model definitions for site.","description":"Required permission \"read_configuration\". <br/>In a future release this request will accept a set of arguments which could surpass the max length of the GET request, consequently, this endpoint answers to a POST method..","operationId":"getAllModelDefinitions","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"types":{"type":"array","items":{"type":"string"},"example":["<form><title>Home</title>...","<form><title>Article</title>..."]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/get_configuration":{"get":{"tags":["configuration"],"summary":"Get configuration content for site and configuration location","description":"Required permission \"read_configuration\"","operationId":"getConfiguration","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"module","in":"query","description":"Module name (e.g. studio, engine)","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Configuration file path, relative to /config/<module>","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"environment to use","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"content":{"type":"string","description":"configuration file content"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/write_configuration":{"post":{"tags":["configuration"],"summary":"Write configuration content for site","description":"Required permission \"write_configuration\"","operationId":"writeConfiguration","requestBody":{"description":"write configuration request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"module":{"type":"string","description":"Module name (e.g. studio, engine)"},"path":{"type":"string","description":"Configuration file path, relative to /config/<module>"},"environment":{"type":"string","description":"environment to use"},"content":{"type":"string","description":"configuration file content"}},"required":["siteId","module","path","content"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/clear_cache":{"get":{"tags":["configuration"],"summary":"Clear all configuration cache for a given site","description":"Required Permission: \"write_configuration\"","operationId":"clearConfigurationCache","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/get_configuration_history":{"get":{"tags":["configuration"],"summary":"Get configuration history for site and configuration location","description":"Required permission \"read_configuration\"","operationId":"getConfigurationHistory","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"module","in":"query","description":"Module name (e.g. studio, engine)","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Configuration file path, relative to /config/<module>","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"environment to use","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"history":{"$ref":"#/components/schemas/History"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/content-type/usage":{"get":{"tags":["configuration"],"summary":"Get all usage of a given content-type","description":"Required permission \"content_read\"","operationId":"getContentTypeUsage","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"contentType","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"dependencies":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"string"},"description":"All templates associated with the given content-type"},"scripts":{"type":"array","items":{"type":"string"},"description":"All scripts associated with the given content-type"},"content":{"type":"array","items":{"type":"string"},"description":"All content types instantiated from the given content-type"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/api/2/configuration/content-type/preview_image":{"get":{"tags":["configuration"],"summary":"Get preview image of a given content type","description":"Required permission \"content_read\"","operationId":"getContentTypePreviewImage","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"contentTypeId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"The content of the preview image file"}}},"headers":{"Content-Type":{"description":"The MIME type of the preview image file","schema":{"type":"string"}},"Content-Length":{"description":"The size in bytes of the preview image file","schema":{"type":"integer","format":"int64"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/content-type/form_controller":{"get":{"tags":["configuration"],"summary":"Get the form controller (if it exists) script of a given content type","description":"Required permission \"content_read\"","operationId":"getContentTypeFormController","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"contentTypeId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"The content of the form controller file"}}},"headers":{"Content-Type":{"description":"The MIME type of the form controller file","schema":{"type":"string"}},"Content-Length":{"description":"The size in bytes of the form controller file","schema":{"type":"integer","format":"int64"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/content-type/delete":{"post":{"tags":["configuration"],"summary":"Delete files related to a given content-type","description":"Required permission \"write_configuration\"","operationId":"deleteContentType","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"contentType":{"type":"string","description":"The content-type to delete"},"deleteDependencies":{"type":"boolean","description":"Indicates if all dependencies of the content-type should be deleted (defaults to false)"}},"required":["siteId","contentType"]}}}},"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/api/2/plugin/file":{"servers":[{"url":"http://localhost:8080/studio/1"}],"get":{"security":[],"tags":["plugin"],"summary":"Get a file for a given plugin","operationId":"getPluginFile","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The plugin type (e.g. control, data-source)","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The plugin name (e.g. custom-input)","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"The name of the file (e.g. input.js, style/main.css)","required":true,"schema":{"type":"string"}},{"name":"pluginId","in":"query","description":"The id of the plugin (e.g. org.craftercms.plugin). This is only needed for plugins installed from the\nmarketplace","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"The content of the file"}}},"headers":{"Content-Type":{"description":"The MIME type of the file","schema":{"type":"string"}},"Content-Length":{"description":"The size in bytes of the file","schema":{"type":"integer","format":"int64"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/plugin/get_configuration":{"get":{"tags":["plugin"],"summary":"Get configuration for the given site and plugin","description":"Required permission \"site member\"","operationId":"getPluginConfiguration","parameters":[{"name":"siteId","in":"query","description":"The id of the site","required":true,"schema":{"type":"string"}},{"name":"pluginId","in":"query","description":"The id of the plugin","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"content":{"type":"string","description":"configuration file content"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/plugin/write_configuration":{"post":{"tags":["plugin"],"summary":"Write configuration content a given site and plugin","description":"Required permission \"write_configuration\" and \"site member\"","operationId":"writePluginConfiguration","requestBody":{"description":"write configuration request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"pluginId":{"type":"string","description":"The id of the plugin"},"content":{"type":"string","description":"configuration file content"}},"required":["siteId","pluginId","content"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/plugin/script/reload":{"get":{"tags":["plugin"],"summary":"Reloads groovy classes for all plugins in a given site","operationId":"reloadClasses","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"token","in":"query","description":"Management token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/list_quick_create_content":{"get":{"tags":["content"],"summary":"Get list of content types available for Quick Create functionality","description":"Required permission \"create content\"","operationId":"quickCreateContent","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/QuickCreateItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/get_delete_package":{"post":{"tags":["content"],"summary":"Get a list of delete children (will be deleted) and dependent items (will have broken references) for a given list of items to be deleted","description":"Required permission \"content_read\"","operationId":"getDeletePackage","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"paths":{"description":"Content paths to get a delete package for","type":"array","items":{"type":"string"}}},"required":["siteId","paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"object","properties":{"childItems":{"type":"array","items":{"type":"string"}},"dependentItems":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/delete":{"post":{"tags":["content"],"summary":"Delete content","description":"Required permission \"content_delete\"","operationId":"contentDelete","requestBody":{"description":"parameters for delete content","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"comment":{"type":"string","description":"deletion comment by the user performing the delete"}},"required":["siteId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/rename":{"post":{"tags":["content"],"summary":"Rename content","description":"Required permission \"content_write\"","operationId":"contentRename","requestBody":{"description":"parameters for rename content","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"path":{"type":"string","description":"full path to the item to rename"},"name":{"type":"string","description":"new item name (just the name, no path)"}},"required":["siteId","path","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/children_by_path":{"post":{"deprecated":true,"tags":["content"],"summary":"Get list of children for given item path","description":"Required permission \"get_children\" and \"site member\".<br/> This operation is deprecated, use /content/{siteId}/children instead.","operationId":"getChildrenByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"path":{"description":"item path to get children for","type":"string"},"localeCode":{"description":"filter children by locale code, or show source items (not translation) if translation to\nspecified locale code does not exist","type":"string"},"sortStrategy":{"description":"sort strategy (sort order) Possible values:\n  - alphabetical (default)\n  - foldersFirst (order by: folders alphabetical, files alphabetical)\n  - lastUpdated (order by: dateModified)","type":"string"},"order":{"description":"order for sort strategy ascending or descending (ASC / DESC)","type":"string","format":"ASC, DESC"},"offset":{"description":"offset of first child in response - default 0","type":"integer"},"limit":{"description":"number of children to return","type":"integer"},"keyword":{"description":"filter children by keyword","type":"string"},"systemTypes":{"description":"filter children by system type","type":"array","items":{"type":"string"}},"excludes":{"description":"exclude items by path","type":"array","items":{"type":"string"}}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"levelDescriptor":{"$ref":"#/components/schemas/SandboxItem"},"children":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/{siteId}/children":{"post":{"tags":["content"],"summary":"Get list of children for given item paths","description":"Required permission \"get_children\" and \"site member\"","operationId":"getChildrenByPaths","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paths":{"description":"item paths to get children for","type":"array","items":{"$ref":"#/components/schemas/ChildrenByPathRequest"}}},"required":["paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"item":{"$ref":"#/components/schemas/SandboxItem"},"levelDescriptor":{"$ref":"#/components/schemas/SandboxItem"},"children":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"}}}},"missingItems":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/exists":{"get":{"tags":["content"],"summary":"Check the existence of a content path","description":"Required permission \"content_read\"","operationId":"contentExists","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"item path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"exists":{"type":"boolean"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_by_path":{"get":{"tags":["content"],"summary":"Get item details for given an item path","description":"Required permission \"get_children\"","operationId":"getDetailedItemByPath","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"item path","required":true,"schema":{"type":"string"}},{"name":"preferContent","in":"query","description":"when set to true, return an item instead of a folder if the path can match either","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/DetailedItem"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/sandbox_items_by_path":{"post":{"tags":["content"],"summary":"Get list of items for given item paths","description":"Required permission \"get_children\" and \"site member\"","operationId":"getSandboxItemsByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"paths":{"description":"item paths to get","type":"array","items":{"type":"string"}},"preferContent":{"description":"when set to true, return an item instead of a folder if the path can match either","type":"boolean"}},"required":["siteId","paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}},"missingItems":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/descriptor":{"get":{"tags":["content"],"summary":"Get the XML descriptor for a given path","operationId":"getDescriptor","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"The path of the descriptor","required":true,"schema":{"type":"string"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"xml":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/paste":{"post":{"tags":["content"],"summary":"Paste a tree of items to a target path (copy content or move content).\nTo be used by the UI in the clipboard implementation.","description":"Required permission \"Write\"","operationId":"pasteItems","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasteRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"description":"The list of pasted items","type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/duplicate":{"post":{"tags":["content"],"summary":"Duplicate the given item in the same location","description":"Required permission \"Write\"","operationId":"duplicateItem","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"path":{"type":"string","description":"The path of the item to duplicate"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"description":"the path of the new item","type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_lock_by_path":{"post":{"tags":["content"],"summary":"Lock item by path","description":"Required permission \"content_write\"","operationId":"itemLockByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"path":{"type":"string","description":"Path of item to lock"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Item already locked","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"person":{"$ref":"#/components/schemas/Person"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_unlock_by_path":{"post":{"tags":["content"],"summary":"Unlock item by path","description":"Required permission \"item_unlock\" or lock owner","operationId":"itemUnlockByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"path":{"type":"string","description":"The path of the item to unlock"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Item already unlocked","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/get_content_by_commit_id":{"get":{"tags":["content"],"summary":"Get content for commit id","description":"Required permission \"content_read\"","operationId":"getContentByCommitId","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path of the content","required":true,"schema":{"type":"string"}},{"name":"commitId","in":"query","description":"commit id of the content version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"content":{"type":"string","description":"requested content"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_history":{"get":{"tags":["content"],"summary":"Get history for a content item","description":"Required permission \"content_read\"","operationId":"getItemHistory","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path of the content","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"history":{"type":"array","items":{"$ref":"#/components/schemas/ItemVersion"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dependency/dependencies":{"post":{"tags":["dependency"],"summary":"Get list of dependencies for given content paths","description":"Required permission \"content_read\"","operationId":"getDependencies","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"paths":{"description":"Content paths to get dependencies for","type":"array","items":{"type":"string"}}},"required":["siteId","paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"object","properties":{"hardDependencies":{"type":"array","items":{"type":"string"}},"softDependencies":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dependency/dependent_items":{"get":{"tags":["dependent_items"],"summary":"Get list of dependent items for given content path","description":"Required permission \"content_read\"","operationId":"getDependentItems","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"path":{"description":"Content path to get dependencies for","type":"string"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DependencyItem"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/search":{"get":{"tags":["marketplace"],"summary":"Search for compatible plugins in the marketplace","operationId":"searchPlugins","parameters":[{"name":"type","in":"query","description":"Plugin type to search (e.g. blueprint, control, datasource)","schema":{"type":"string"}},{"name":"keywords","in":"query","description":"The keywords to filter plugins","schema":{"type":"string"}},{"name":"showPending","description":"Include plugins pending of approval (default to false)","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"Offset for pagination","schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Limit for pagination","schema":{"type":"integer","format":"int64"}},{"name":"showIncompatible","in":"query","description":"Include incompatible plugins (defaults to false)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MarketplacePlugin"},{"$ref":"#/components/schemas/GitMarketplacePlugin"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/installed":{"get":{"tags":["marketplace"],"summary":"Get the list of marketplace plugins installed in the given site","description":"Required permission \"list_plugins\"","operationId":"getInstalledPlugins","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"plugins":{"type":"array","items":{"$ref":"#/components/schemas/PluginRecord"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/install":{"post":{"tags":["marketplace"],"summary":"Install a marketplace plugin in the given site","description":"Required permission \"install_plugins\"","operationId":"installPlugin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"The id of the site","type":"string"},"pluginId":{"description":"The id of the plugin","type":"string"},"pluginVersion":{"$ref":"#/components/schemas/Version"},"parameters":{"type":"object","description":"Object containing all parameters for the plugin. It should include all required parameters from the descriptor","additionalProperties":{"type":"string"}}},"required":["siteId","pluginId","pluginVersion"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/copy":{"post":{"tags":["marketplace"],"summary":"Copy a local plugin to a given site","description":"Required permission \"install_plugins\"","operationId":"copyPlugin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"The id of the site","type":"string"},"path":{"description":"The path of the local plugin source folder","type":"string"},"parameters":{"type":"object","description":"Object containing all parameters for the plugin. It should include all required parameters from the descriptor","additionalProperties":{"type":"string"}}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/remove":{"post":{"tags":["marketplace"],"summary":"Remove a marketplace plugin from the given site","description":"Required permission \"remove_plugins\"","operationId":"removePlugin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"The id of the site","type":"string"},"pluginId":{"description":"The id of the plugin","type":"string"},"force":{"description":"Indicates if the plugin should be removed even if there are dependant items"}},"required":["siteId","pluginId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/usage":{"get":{"tags":["marketplace"],"summary":"List dependant items for a plugin","description":"Required permission \"remove_plugins\"","operationId":"pluginUsage","parameters":[{"name":"siteId","description":"The id of the site","schema":{"type":"string"},"required":true,"in":"query"},{"name":"pluginId","description":"The id of the plugin","schema":{"type":"string"},"required":true,"in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/all":{"post":{"tags":["publishing"],"summary":"Publishes the entire project to the target (staging or live)","description":"Required permission \"Publish\"","operationId":"publishAll","requestBody":{"description":"publish all request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"publishingTarget":{"type":"string","description":"the publishing target (staging or live)"},"submissionComment":{"type":"string","description":"optional submission comment"}},"required":["siteId","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/packages":{"get":{"tags":["publishing"],"summary":"Get the list of packages in the publishing queue","description":"Required permission \"get_publishing_queue\"","operationId":"PublishingPackages","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"publishingTarget","in":"query","description":"filter by publishing target","required":false,"schema":{"type":"string"}},{"name":"path","in":"query","description":"regular expression to filter by path","required":false,"schema":{"type":"string"}},{"name":"states","in":"query","description":"filter by package state(s)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","description":"Offset for pagination","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Limit for pagination","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PublishingPackage"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/package":{"get":{"tags":["publishing"],"summary":"Get package details","description":"Required permission \"get_publishing_queue\"","operationId":"getPublishingPackageDetails","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"packageId","in":"query","description":"package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"package":{"$ref":"#/components/schemas/PublishingPackageDetails"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/cancel":{"post":{"tags":["publishing"],"summary":"Cancel publishing packages","description":"Required permission \"cancel_publish\"","operationId":"cancelPublishingPackages","requestBody":{"description":"cancel publishing packages request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"packageIds":{"type":"array","description":"packageIds","items":{"type":"string"}}},"required":["siteId","packageIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/status":{"get":{"tags":["publishing"],"summary":"Get publishing status for site","description":"Required permission \"publish_status\"","operationId":"getPublishingStatus","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingStatus":{"$ref":"#/components/schemas/PublishingStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/history":{"get":{"deprecated":true,"tags":["publishing"],"summary":"Get publishing history for site","description":"Required permission \"publish\". This operation is deprecated, use /api/2/dashboard/publishing/history instead.","operationId":"getPublishingHistory","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","description":"number of days to display history for","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"num","in":"query","description":"number of items to fetch","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filterType","in":"query","description":"filter items by type (all, page, component, asset)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingStatus":{"$ref":"#/components/schemas/DeploymentHistoryGroup"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/available_targets":{"get":{"tags":["publishing"],"summary":"Get available publishing targets for site","description":"Required permission \"publish\"","operationId":"getAvailablePublishingTargets","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingTargets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Target name"},"order":{"type":"integer","format":"int32","description":"order for display in the dropdown"}}}},"published":{"type":"boolean","description":"true if site has been published at least once (initial publish; published repository exist), otherwise false"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/has_initial_publish":{"get":{"tags":["publishing"],"summary":"Check if site has initial publish","description":"Required permission \"content_read\"","operationId":"hasInitialPublish","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"hasInitialPublish":{"type":"boolean","description":"true if site has been published at least once (initial publish; published repository exist), otherwise false"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/encrypt":{"post":{"tags":["security"],"summary":"Encrypt a text value","operationId":"encrypt","description":"Required permission \"encryption_tool\"","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/tokens":{"get":{"tags":["security"],"summary":"Get all existing tokens for the current user","operationId":"getAccessTokens","description":"Required permission \"manage_access_token\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/AccessToken"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["security"],"summary":"Creates a new access token for the current user","operationId":"createAccessToken","description":"Required permission \"manage_access_token\"","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The label for the access token"},"expiresAt":{"type":"string","format":"date-time","description":"The date of expiration for the access token"}},"required":["label"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"token":{"$ref":"#/components/schemas/AccessToken"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/tokens/{id}":{"post":{"tags":["security"],"summary":"Updates an access token for the current user","operationId":"updateAccessToken","description":"Required permission \"manage_access_token\"","parameters":[{"name":"id","in":"path","schema":{"type":"integer","format":"int64"},"description":"The id of the access token to update","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if the access token is enabled"}},"required":["enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"token":{"$ref":"#/components/schemas/AccessToken"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["security"],"summary":"Deletes an access token for the current user","operationId":"deleteAccessToken","description":"Required permission \"manage_access_token\"","parameters":[{"name":"id","in":"path","schema":{"type":"integer","format":"int64"},"description":"The id of the access token to delete","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/preview/switch":{"post":{"tags":["security"],"summary":"Configures preview to use a different site. Site is expected to be set in `crafterSite` cookie","operationId":"switchPreviewSite","description":"Required permission \"LOGGED_IN\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/activity":{"get":{"tags":["dashboard"],"summary":"Get user activities","description":"Required permission \"site_member\"","operationId":"getDashboardActivities","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"usernames","in":"query","description":"filter activities for given users only","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"actions","in":"query","description":"filter activities for given actions only","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/activity/me":{"get":{"tags":["dashboard"],"summary":"Get current user's activities","description":"Required permission \"site_member\"","operationId":"getDashboardMyActivities","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"actions","in":"query","description":"filter activities for given actions only","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/pending_approval":{"get":{"tags":["dashboard"],"summary":"Get publishing packages that are pending for approval","description":"Required permission \"site_member\"","operationId":"getDashboardContentPendingApproval","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}},{"name":"sort","schema":{"type":"string"},"in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by commas. Example: `dateModified asc, label desc`. Supported fields: `id` `dateModified` `label`. Default `dateModified desc`"},{"name":"itemType","in":"query","description":"The system types to filter the results by. Multiple types are separated by commas. Example: `renderingTemplate, asset`.Supported values: `asset` `component` `content type` `document` `file` `folder` `levelDescriptor` `page` `renderingTemplate` `script` `taxonomy`","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingItems":{"type":"array","items":{"$ref":"#/components/schemas/DetailedItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/pending_approval/{id}":{"get":{"tags":["dashboard"],"summary":"Get content items of the package that is pending for approval","description":"Required permission \"site_member\"","operationId":"getDashboardContentPendingApprovalDetail","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingPackageItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/unpublished":{"get":{"tags":["dashboard"],"summary":"Get unpublished items for site","description":"Required permission \"content_read\"","operationId":"getDashboardContentUnpublished","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by commas. Example: `dateModified asc, label desc`. Supported fields: `id` `dateModified` `label`. Default `dateModified desc`","schema":{"type":"string"}},{"name":"itemType","in":"query","description":"The system types to filter the results by. Multiple types are separated by commas. Example: `renderingTemplate, asset`. Supported values: `asset` `component` `content type` `document` `file` `folder` `levelDescriptor` `page` `renderingTemplate` `script` `taxonomy`","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"unpublishedItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/scheduled":{"get":{"tags":["dashboard"],"summary":"Get scheduled publishing items","description":"Required permission \"content_read\"","operationId":"getPublishingScheduled","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"publishingTarget","in":"query","description":"publishing target to filter results","required":false,"schema":{"type":"string"}},{"name":"approver","in":"query","description":"approver user to filter results","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by commas. Example: `dateScheduled asc, label desc`. Supported fields: `id` `dateScheduled` `label`. Default `dateScheduled desc`","schema":{"type":"string"}},{"name":"itemType","in":"query","description":"The system types to filter the results by. Multiple types are separated by commas. Example: `renderingTemplate, asset`. Supported values: `asset` `component` `content type` `document` `file` `folder` `levelDescriptor` `page` `renderingTemplate` `script` `taxonomy`","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingItems":{"type":"array","items":{"$ref":"#/components/schemas/DetailedItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/scheduled/{id}":{"get":{"tags":["dashboard"],"summary":"Get content items of the package that is scheduled","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingScheduledDetail","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingPackageItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/history":{"get":{"tags":["dashboard"],"summary":"Get history of published packages","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingHistory","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"publishingTarget","in":"query","description":"publishing target to filter results","required":false,"schema":{"type":"string"}},{"name":"approver","in":"query","description":"approver user to filter results","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingPackages":{"type":"array","items":{"$ref":"#/components/schemas/DashboardPublishingPackage"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/history/{id}":{"get":{"tags":["dashboard"],"summary":"Get content items of the package that was published","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingHistoryDetail","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"package ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingPackageItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/stats":{"get":{"tags":["dashboard"],"summary":"Get publishing stats","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingStats","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","description":"number of days to display stats for","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingStats":{"$ref":"#/components/schemas/PublishingStats"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/expiring":{"get":{"tags":["dashboard"],"summary":"Get content that is expiring","description":"Required permission \"site_member\"","operationId":"getDashboardContentExpiring","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"object","properties":{"itemName":{"type":"string","description":"internal name"},"itemPath":{"type":"string","description":"content path"},"expireDateTime":{"type":"string","format":"date-time","description":"date and time when content expires"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/expired":{"get":{"tags":["dashboard"],"summary":"Get content that expired","description":"Required permission \"site_member\"","operationId":"getDashboardContentExpired","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"object","properties":{"itemName":{"type":"string","description":"internal name"},"itemPath":{"type":"string","description":"content path"},"expiredDateTime":{"type":"string","format":"date-time","description":"date and time when content expired"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/item_states":{"get":{"tags":["workflow"],"summary":"Get item workflow states for site","description":"Required permission \"get_item_states\"","operationId":"getItemStates","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path regex","required":false,"schema":{"type":"string"}},{"name":"states","in":"query","description":"states bitmap mask","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["workflow"],"summary":"Set item workflow states for site","description":"Required permission \"set_item_states\"","operationId":"setItemStates","requestBody":{"description":"List of items to set workflow state(s)","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"items":{"type":"array","description":"path(s) of item(s)","items":{"type":"string"}},"clearSystemProcessing":{"type":"boolean","description":"true if system processing is to be cleared"},"clearUserLocked":{"type":"boolean","description":"true if user lock is to be cleared"},"live":{"type":"boolean","description":"true if item is to be set as live, otherwise false"},"staged":{"type":"boolean","description":"true if item is to be set as staged, otherwise false"},"new":{"type":"boolean","description":"true if item is to be set as new, otherwise false"},"modified":{"type":"boolean","description":"true if item is to be set as modified, otherwise false"}},"required":["siteId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/update_item_states_by_query":{"post":{"tags":["workflow"],"summary":"Set item workflow states for site using query","description":"Required permission \"set_item_states\"","operationId":"updateItemStates","requestBody":{"description":"List of items to set workflow state(s)","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"path":{"type":"string","description":"path regex of item(s)"},"states":{"type":"integer","format":"int64","description":"state bitmap mask to filter by state"}},"required":["siteId","paths"]},"update":{"type":"object","properties":{"clearSystemProcessing":{"type":"boolean","description":"true if system processing is to be cleared"},"clearUserLocked":{"type":"boolean","description":"true if user lock is to be cleared"},"live":{"type":"boolean","description":"true if item is to be set as live, otherwise false"},"staged":{"type":"boolean","description":"true if item is to be set as staged, otherwise false"},"new":{"type":"boolean","description":"true if item is to be set as new, otherwise false"},"modified":{"type":"boolean","description":"true if item is to be set as modified, otherwise false"}}}},"required":["query","update"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/affected_paths":{"get":{"tags":["workflow"],"summary":"Get workflow affected paths","description":"Required permission \"content_read\"","operationId":"getWorkflowAffectedPaths","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path of the content","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/request_publish":{"post":{"tags":["workflow"],"summary":"Request publish for content","description":"Required permission \"site_member\"","operationId":"workflowRequestPublish","requestBody":{"description":"parameters for request publish","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target to publish content to"},"schedule":{"type":"string","format":"datetime","description":"schedule when to publish content"},"comment":{"type":"string","description":"comment about publish request"},"sendEmailNotifications":{"type":"boolean","description":"if true, send email notifications"}},"required":["siteId","items","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/publish":{"post":{"tags":["workflow"],"summary":"Publish content","description":"Required permission \"publish\"","operationId":"workflowPublish","requestBody":{"description":"parameters for publish content","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target to publish content to"},"schedule":{"type":"string","format":"datetime","description":"schedule when to publish content"},"comment":{"type":"string","description":"submission comment by publisher"}},"required":["siteId","items","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/approve":{"post":{"tags":["workflow"],"summary":"Approve request publish submission","description":"Required permission \"publish\"","operationId":"workflowApprove","requestBody":{"description":"parameters for approve request publish submission","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target to publish content to"},"schedule":{"type":"string","format":"datetime","description":"schedule when to publish content"},"comment":{"type":"string","description":"Reviewer's comment"}},"required":["siteId","items","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/reject":{"post":{"tags":["workflow"],"summary":"Reject request publish submission","description":"Required permission \"publish\"","operationId":"workflowReject","requestBody":{"description":"parameters for reject request publish submission","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"comment":{"type":"string","description":"Reviewer's rejection comment"}},"required":["siteId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages":{"get":{"tags":["workflow"],"summary":"List workflow packages order by scheduled date","description":"Required permission \"request_publish, publish\"","operationId":"workflowListPackage","parameters":[{"name":"siteId","in":"query","description":"filter workflow packages by site","required":true,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary for filtering results by scheduled date","required":false,"schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","description":"upper boundary for filtering results by scheduled date","required":false,"schema":{"type":"string","format":"date"}},{"name":"offset","in":"query","description":"Offset of the first package in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of packages to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"order","in":"query","description":"ascending or descending (ASC | DESC). Default ascending","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowPackage"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["workflow"],"summary":"Create workflow package","description":"Required permission \"request_publish, publish\"","operationId":"workflowCreatePackage","requestBody":{"description":"parameters to create new workflow package","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"paths":{"type":"array","description":"paths of content items to add to package","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target where to publish content"},"schedule":{"type":"string","format":"datetime","description":"schedule when publishing should be performed"},"authorComment":{"type":"string","description":"author's comment about the package"},"label":{"type":"string","description":"user friendly name for the package"}},"required":["siteId","paths","publishingTarget"]}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["workflow"],"summary":"Update workflow package","description":"Required permission \"request_publish, publish\"","operationId":"workflowUpdatePackage","requestBody":{"description":"Workflow package entity to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPackage"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"package":{"$ref":"#/components/schemas/WorkflowPackage"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages/{id}":{"get":{"tags":["workflow"],"summary":"Get workflow package by id","description":"Required permission \"request_publish, publish\"","operationId":"workflowGetPackage","parameters":[{"name":"id","in":"path","description":"The workflow package ID","required":true,"schema":{"type":"string","format":"UUID"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"package":{"$ref":"#/components/schemas/WorkflowPackage"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages/approve":{"post":{"tags":["workflow"],"summary":"Approve workflow package","description":"Required permission \"publish\"","operationId":"workflowApprovePackage","requestBody":{"description":"parameters to approve a workflow package","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"packages":{"type":"array","items":{"type":"object","properties":{"packageId":{"type":"string","description":"Id of the workflow package to approve"},"approverComment":{"type":"string","description":"approver's comment about approved workflow package"}},"required":["packageId","approverComment"]}},"schedule":{"type":"string","format":"datetime","description":"approved schedule when to publish package"}},"required":["siteId","packages"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages/reject":{"post":{"tags":["workflow"],"summary":"Create workflow package","description":"Required permission \"request_publish, publish\"","operationId":"workflowRejectPackage","requestBody":{"description":"parameters to create new workflow package","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"packages":{"type":"array","items":{"type":"object","properties":{"packageId":{"type":"string","description":"Id of the workflow package to approve"},"rejectionComment":{"type":"string","description":"approver's comment about approved workflow package"}},"required":["packageId","rejectionComment"]}}},"required":["siteId","packages"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/loggers":{"get":{"tags":["loggers"],"summary":"Get all loggers and their configured priority levels","description":"Required permission \"view_log_levels or configure_log_levels\"","operationId":"loggersGetAll","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LoggerConfig"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/loggers/logger_level":{"post":{"tags":["loggers"],"summary":"Update logger priority level","description":"Required permission \"configure_log_levels\"","operationId":"loggersUpdateLevel","requestBody":{"description":"parameters to update the logger level","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerConfigRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/LoggerConfig"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"ApiResponse":{"type":"object","description":"The response of an API operation. Possible responses are:\n  * `CODE:` 0, `MESSAGE:` OK\n  * `CODE:` 1, `MESSAGE:` Created\n  * `CODE:` 2, `MESSAGE:` Deleted\n  * `CODE:` 3, `MESSAGE:` Completed with errors\n  * `CODE:` 1000, `MESSAGE:` Internal system failure, `REMEDIAL ACTION:` Contact support\n  * `CODE:` 1001, `MESSAGE:` Invalid parameter(s), `REMEDIAL ACTION:` Check API and make sure you're sending the correct parameters\n  * `CODE:` 2000, `MESSAGE:` Unauthenticated, `REMEDIAL ACTION:` Please login first\n  * `CODE:` 2001, `MESSAGE:` Unauthorized, `REMEDIAL ACTION:` You don't have permission to perform this task, please contact your administrator\n  * `CODE:` 3000, `MESSAGE:` Organization not found, `REMEDIAL ACTION:` Check if you sent in the right Org Id\n  * `CODE:` 3001, `MESSAGE:` Organization already exists, `REMEDIAL ACTION:` Try a different organization name\n  * `CODE:` 4000, `MESSAGE:` Group not found, `REMEDIAL ACTION:` Check if you sent in the right Group Id\n  * `CODE:` 5000, `MESSAGE:` Site not found, `REMEDIAL ACTION:` Check if you sent in the right Site Id\n  * `CODE:` 5001, `MESSAGE:` Site already exists, `REMEDIAL ACTION:` Try a different site name\n  * `CODE:` 6000, `MESSAGE:` User not found, `REMEDIAL ACTION:` Check if you're using the correct User ID or username\n  * `CODE:` 6001, `MESSAGE:` User already exists, `REMEDIAL ACTION:` Try a different username\n  * `CODE:` 6002, `MESSAGE:` User is externally managed, `REMEDIAL ACTION:` Update the user in the main identity system (e.g. LDAP)\n  * `CODE:` 6003, `MESSAGE:` User password does not fulfill requirements, `REMEDIAL ACTION:` Use password that will fulfill password requirements\n  * `CODE:` 6004, `MESSAGE:` User current password does not match, `REMEDIAL ACTION:` Use correct current password\n  * `CODE:` 7000, `MESSAGE:` Content not found, `REMEDIAL ACTION:` Check if you sent in the right Content Id\n  * `CODE:` 7001, `MESSAGE:` Content already exists, `REMEDIAL ACTION:` Edit the existing item or delete it before creating it again\n  * `CODE:` 7002, `MESSAGE:` Content already locked, `REMEDIAL ACTION:` The user that locked the item or the administrator must unlock the item first\n  * `CODE:` 7003, `MESSAGE:` Content already unlocked, `REMEDIAL ACTION:` The item is already unlocked\n  * `CODE:` 7004, `MESSAGE:` Paste destination folder is invalid (did you paste the item onto itself?), `REMEDIAL ACTION:` Try pasting the content to a different folder\n  * `CODE:` 8000, `MESSAGE:` Publishing is disabled, `REMEDIAL ACTION:` Advise the user to enable publishing\n  * `CODE:` 9000, `MESSAGE:` Search is unreachable, `REMEDIAL ACTION:` Advise the user that the search engine is not reachable\n  * `CODE:` 10000, `MESSAGE:` LoV not found, `REMEDIAL ACTION:` Check if you sent in the right LoV Id\n  * `CODE:` 11000, `MESSAGE:` Cluster member not found, `REMEDIAL ACTION:` Check if you sent in the right Cluster Member Id\n  * `CODE:` 11001, `MESSAGE:` Cluster member already exists, `REMEDIAL ACTION:` Get the list of cluster members to validate\n  * `CODE:` 12000, `MESSAGE:` Remote repository not found, `REMEDIAL ACTION:` Check if you sent in the right remote repository name\n  * `CODE:` 12001, `MESSAGE:` Remote repository already exists, `REMEDIAL ACTION:` Get the list of remote repositories to validate\n  * `CODE:` 12002, `MESSAGE:` Pull from remote repository resulted in conflict, `REMEDIAL ACTION:` Resolve conflicts before continuing work with repository\n  * `CODE:` 12003, `MESSAGE:` Remote is invalid. Not added to remote repositories, `REMEDIAL ACTION:` Add new remote repository with valid parameters.\n  * `CODE:` 12004, `MESSAGE:` Failed to remove remote repository, `REMEDIAL ACTION:` Contact your system administrator.\n  * `CODE:` 12005, `MESSAGE:` Push to remote repository failed, `REMEDIAL ACTION:` Check your repository settings or contact your system administrator.\n  * `CODE:` 12006, `MESSAGE:` Remove remote repository failed, `REMEDIAL ACTION:` The remote repository is a cluster node repository. It can't be removed.\n  * `CODE:` 12007, `MESSAGE:` Remote repository authentication failed, `REMEDIAL ACTION:` Recreate the remote repository with the correct authentication credentials and make sure you have write access.\n  * `CODE:` 40000, `MESSAGE:` Marketplace service is not initialized, `REMEDIAL ACTION:` Contact your system administrator.\n  * `CODE:` 40001, `MESSAGE:` Marketplace server is unreachable, `REMEDIAL ACTION:` Check the configuration to make sure the Marketplace URL is correct\n  * `CODE:` 40002, `MESSAGE:` Plugin is already installed, `REMEDIAL ACTION:` Check that the site id, plugin id and plugin version are correct\n  * `CODE:` 40003, `MESSAGE:` Error installing plugin, `REMEDIAL ACTION:` Check the plugin requirements\n  * `CODE:` 50003, `MESSAGE:` Target path does not exist in site repository, `REMEDIAL ACTION:` Check if you sent in the right Studio Path\n  * `CODE:` 52000, `MESSAGE:` AWS is unreachable, `REMEDIAL ACTION:` Advise the user that AWS engine is not reachable\n  * `CODE:` 53000, `MESSAGE:` Logger not found, `REMEDIAL ACTION:` Check if you sent in the right logger name or add 'createIfAbsent=true' parameter to create the logger if it does not exist","properties":{"code":{"type":"integer","format":"int32","description":"The response code"},"message":{"type":"string","description":"The detailed message of the response"},"remedialAction":{"type":"string","description":"What the user can do in order to address the issue indicated by the response"},"documentationUrl":{"type":"string","description":"A URL to documentation related to the response"}}},"UpdateUserRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID, unique and immutable"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"}},"required":["id","username","password","firstName","lastName","email","enabled","externallyManaged"]},"CreateUserRequest":{"type":"object","properties":{"username":{"type":"string","description":"Username, unique"},"password":{"type":"string","description":"User's password (not returned to caller)"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"},"externallyManaged":{"type":"boolean","description":"Indicates if a user is managed in by an external system (LDAP, SAML, etc.)"}},"required":["id","username","password","firstName","lastName","email","enabled","externallyManaged"]},"UserResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID, unique and immutable"},"username":{"type":"string","description":"Username, unique"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"},"externallyManaged":{"type":"boolean","description":"Indicates if a user is managed in by an external system (LDAP, SAML, etc.)"}},"required":["id","username","firstName","lastName","email","enabled","externallyManaged"]},"AuthenticatedUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID, unique and immutable"},"username":{"type":"string","description":"Username, unique"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"},"externallyManaged":{"type":"boolean","description":"Indicates if a user is managed in by an external system (LDAP, SAML, etc.)"},"authenticationType":{"type":"string","description":"The authentication type used to log in the user. Possible values are: DB, LDAP, AUTH_HEADERS"}},"required":["id","username","firstName","lastName","email","enabled","externallyManaged","authenticationType"]},"Group":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Group ID, unique and immutable"},"name":{"type":"string","description":"Group name, unique"},"desc":{"type":"string","description":"Group description"}},"required":["id","name"]},"UpdateGroupRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Group ID, unique and immutable"},"desc":{"type":"string","description":"Group description"}},"required":["id","name"]},"Site":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID, unique and immutable"},"state":{"type":"string","description":"Site state, one of: INITIALIZING, READY, DELETING, DELETED"},"uuid":{"type":"string","description":"Site UUID unique and immutable"},"name":{"type":"string","description":"site name"},"desc":{"type":"string","description":"Site description"}},"required":["siteId"]},"MenuItem":{"type":"object","properties":{"id":{"type":"string","description":"Menu item ID, unique and immutable"},"label":{"type":"string","description":"Menu item label"},"icon":{"type":"string","description":"Menu item icon as a Font Awesome id, example: fa-smile"}},"required":["id","label","icon"]},"S3Item":{"type":"object","properties":{"name":{"type":"string","description":"Name of the item"},"url":{"type":"string","description":"URL of the item"},"folder":{"type":"boolean","description":"Indicates if the item is a folder"}},"required":["name","url","folder"]},"MediaConvertResult":{"type":"object","properties":{"jobId":{"type":"string","description":"The id of the triggered job"},"jobArn":{"type":"string","description":"The full ARN of the triggered job"},"urls":{"type":"array","description":"The list of files that will be generated by the triggered job","items":{"type":"string"}}},"required":["jobId","jobArn","urls"]},"WebDavItem":{"type":"object","properties":{"name":{"type":"string","description":"Name of the item"},"url":{"type":"string","description":"URL of the item"},"folder":{"type":"boolean","description":"Indicates if the item is a folder"}},"required":["name","url","folder"]},"ClusterMember":{"type":"object","properties":{"primary":{"type":"boolean","description":"True for primary node, false for replicas"},"localAddress":{"type":"string","description":"Cluster Member local IP address, immutable"},"state":{"type":"string","description":"Cluster Member state","enum":["ACTIVE","INACTIVE"]},"gitUrl":{"type":"string","description":"Git URL, unique"},"gitRemoteName":{"type":"string","description":"Git Remote Name, unique"}},"required":["localAddress","state","gitUrl","gitRemoteName","primary"]},"Version":{"type":"object","properties":{"major":{"type":"integer","format":"int32","description":"The major version"},"minor":{"type":"integer","format":"int32","description":"The minor version"},"patch":{"type":"integer","format":"int32","description":"The patch version"}},"required":["major","minor"]},"Link":{"type":"object","properties":{"name":{"type":"string","description":"The name of the link"},"url":{"type":"string","description":"The URL of the link"}},"required":["name","url"]},"Asset":{"type":"object","properties":{"title":{"type":"string","description":"The title of the asset"},"description":{"type":"string","description":"The description of the asset"},"url":{"type":"string","description":"The URL of the asset"}},"required":["title","url"]},"Parameter":{"type":"object","properties":{"label":{"type":"string","description":"The label to use for the parameter"},"name":{"type":"string","description":"The name of the parameter (must be camelCase)"},"description":{"type":"string","description":"The description of the parameter"},"defaultValue":{"type":"string","description":"The default value of the parameter"},"type":{"type":"string","description":"The type of the parameter. Currently supported values are STRING, PASSWORD"},"required":{"type":"boolean","description":"Indicates if the parameter is required"}}},"PluginDescriptor":{"type":"object","properties":{"descriptorVersion":{"type":"integer","description":"The version of the plugin descriptor"},"plugin":{"$ref":"#/components/schemas/Plugin"}}},"Plugin":{"type":"object","properties":{"type":{"type":"string","description":"The type of plugin"},"id":{"type":"string","format":"package name","description":"The plugin id"},"name":{"type":"string","description":"The plugin name"},"tags":{"type":"array","description":"The plugin tags","items":{"type":"string"}},"version":{"$ref":"#/components/schemas/Version"},"description":{"type":"string","description":"The plugin description"},"website":{"$ref":"#/components/schemas/Link"},"media":{"type":"object","properties":{"screenshots":{"type":"array","description":"The screenshots of the plugin","items":{"$ref":"#/components/schemas/Asset"}},"videos":{"type":"array","description":"The videos of the plugin","items":{"$ref":"#/components/schemas/Asset"}}}},"developer":{"type":"object","properties":{"people":{"type":"array","description":"The people that worked on the plugin","items":{"$ref":"#/components/schemas/Link"}},"company":{"$ref":"#/components/schemas/Link"}}},"license":{"$ref":"#/components/schemas/Link"},"crafterCmsVersions":{"type":"array","description":"The supported CrafterCMS versions of the plugin","items":{"$ref":"#/components/schemas/Version"}},"crafterCmsEditions":{"type":"array","description":"The supported CrafterCMS editions of the plugin","items":{"type":"string"}},"parameters":{"type":"array","description":"The parameters supported by the plugin","items":{"$ref":"#/components/schemas/Parameter"}}}},"MarketplacePlugin":{"allOf":[{"$ref":"#/components/schemas/Plugin"},{"type":"object","properties":{"status":{"description":"The status of this version of the plugin (possible values are 'PENDING' approval and 'APPROVED')","type":"string"},"source":{"description":"The source of the plugin","type":"string"},"compatible":{"description":"Indicates if the plugin is compatible","type":"boolean"}}}]},"MarketplaceRemotePlugin":{"allOf":[{"$ref":"#/components/schemas/MarketplacePlugin"},{"type":"object","properties":{"url":{"type":"string"}}}]},"GitMarketplacePlugin":{"allOf":[{"$ref":"#/components/schemas/MarketplaceRemotePlugin"},{"type":"object","properties":{"ref":{"type":"string"}}}]},"CreateSiteFromMarketplace":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID to use"},"description":{"type":"string","description":"Site description"},"sandboxBranch":{"type":"string","description":"Name for sandbox branch (default master)"},"remoteName":{"type":"string","description":"Remote repository name (default origin)"},"blueprintId":{"type":"string","description":"The ID of the blueprint to use"},"blueprintVersion":{"$ref":"#/components/schemas/Version"},"siteParams":{"type":"object","description":"Object containing all parameters for the blueprint. It should include all required parameters from the descriptor","additionalProperties":{"type":"string"}}},"required":["siteId","blueprintId","blueprintVersion"]},"PluginRecord":{"type":"object","properties":{"id":{"type":"string","description":"The id of the plugin"},"version":{"$ref":"#/components/schemas/Version"},"pluginUrl":{"type":"string","description":"The URL of the plugin"},"installationDate":{"type":"string","format":"date-time","description":"The date when the plugin was installed"},"files":{"type":"array","description":"The list of installed files","items":{"$ref":"#/components/schemas/FileRecord"}}}},"FileRecord":{"type":"object","properties":{"path":{"type":"string","description":"The path where the file was copied during installation"}}},"SearchParams":{"type":"object","properties":{"query":{"type":"string","description":"The main Lucene query to execute"},"keywords":{"type":"string","description":"The keywords to search in the files"},"path":{"type":"string","description":"Regular expression to filter the paths"},"offset":{"type":"integer","format":"int64","description":"The offset to paginate the results (defaults to 0)"},"limit":{"type":"integer","format":"int64","description":"The limit to paginate the results (defaults to 10)"},"sortBy":{"type":"string","description":"The name of the field to sort the results (defaults to sort by relevance)"},"sortOrder":{"type":"string","description":"The order to sort the results (defaults to DESC)"},"orOperator":{"type":"boolean","description":"Indicates if the filters should use an OR instead of an AND operator (defaults to false)"},"filters":{"type":"object","description":"Object containing facets to filter the search results. Facets can be simple key-value pairs like \"MIME Type\":\"text/css\" or nested objects for range facets like \"Width\": { \"min\": 0, \"max\": 150 }. Both keys and\n values can be taken from the facets object of a previous search.","additionalProperties":true}}},"SearchResult":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total number of results found"},"items":{"type":"array","description":"List of items based on the pagination parameters","items":{"$ref":"#/components/schemas/SearchResultItem"}},"facets":{"type":"array","description":"List of facets based on the results found","items":{"$ref":"#/components/schemas/SearchFacet"}}}},"SearchResultItem":{"type":"object","properties":{"path":{"type":"string","description":"The path of the file"},"name":{"type":"string","description":"The internal name of the file"},"type":{"type":"string","description":"The type of the file"},"mimeType":{"type":"string","description":"The MIME type of the file"},"previewUrl":{"type":"string","description":"The preview URL of the file"},"lastModifier":{"type":"string","description":"The last user that modified the file"},"lastModified":{"type":"string","format":"date-time","description":"The last date that the file was modified"},"size":{"type":"integer","format":"int64","description":"The size of the file, in bytes"},"snippets":{"type":"array","description":"Snippets relevant to the search query","items":{"type":"string"}}}},"SearchFacet":{"type":"object","properties":{"name":{"type":"string","description":"The label of the facet"},"range":{"type":"boolean","description":"Indicates if the values of the facet are ranges"},"date":{"type":"boolean","description":"Indicates if the values of the facet are dates"},"values":{"type":"object","description":"The values and counts of the facet. If the facet is a range the values will be of type SearchFacetRange, otherwise it will be a single integer.","properties":{"facet1":{"type":"object","properties":{"value1":{"type":"integer"}}},"facet2":{"$ref":"#/components/schemas/SearchFacetRange"}}}}},"SearchFacetRange":{"type":"object","properties":{"count":{"type":"integer","format":"int64","description":"The number of files that match the range"},"from":{"type":"object","description":"The starting limit of the range"},"to":{"type":"object","description":"The ending limit of the range"}}},"AuditLog":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Audit log entry ID"},"organizationId":{"type":"integer","format":"int64","description":"Organization ID"},"siteId":{"type":"string","format":"string","description":"Site Identifier"},"siteName":{"type":"string","format":"string","description":"Site name"},"operation":{"type":"string","description":"Operation that was executed"},"operationTimestamp":{"type":"string","description":"Timestamp when operation was executed"},"origin":{"type":"string","description":"Origin of operation (UI/API or Git)"},"primaryTargetId":{"type":"string","description":"Target ID upon which operation was executed"},"primaryTargetType":{"type":"string","description":"Type of the target"},"primaryTargetSubtype":{"type":"string","description":"Subtype of the target"},"primaryTargetValue":{"type":"string","description":"Value of the target (e.g. content's path)"},"actorId":{"type":"string","description":"Actor ID which invoked operation"},"actorDetails":{"type":"string","description":"Details of the actor which invoked"},"clusterNodeId":{"type":"string","description":"Cluster node Id"},"parameters":{"type":"array","description":"Additional parameters of audit log","items":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID upon which operation was executed"},"targetType":{"type":"string","description":"Type of the target"},"targetValue":{"type":"string","description":"Value of the target (e.g. content's path)"}},"required":["targetId","targetType","targetValue"]}}},"required":["id","organizationId","siteId","siteName","operation","operationTimestamp","origin","primaryTargetId","primaryTargetType","primaryTargetValue","actorId"]},"VersionItem":{"type":"object","properties":{"packageName":{"type":"string","description":"The name of the current package"},"packageVersion":{"type":"string","description":"The version of the current package"},"packageBuild":{"type":"string","description":"The build of the current package"},"packageBuildDate":{"type":"string","format":"date-time","description":"The build date of the current package"},"osName":{"type":"string","description":"The name of the operating system"},"osVersion":{"type":"string","description":"The version of the operating system"},"osArch":{"type":"string","description":"The architecture of the operating system"},"javaVersion":{"type":"string","description":"The version of java being used"},"javaVendor":{"type":"string","description":"The name of the JVM vendor"},"javaVm":{"type":"string","description":"The name of the JVM"}}},"StatusItem":{"type":"object","properties":{"uptime":{"type":"integer","format":"int64","description":"The time in seconds that the JVM has been up"},"startup":{"type":"string","format":"date-time","description":"The date and time when the JVM started"}}},"ClusterStatusItem":{"type":"object","properties":{"uptime":{"type":"integer","format":"int64","description":"The time in seconds that the JVM has been up"},"startup":{"type":"string","format":"date-time","description":"The date and time when the JVM started"},"age":{"type":"integer","format":"int64","description":"The time in seconds that the cluster node has been up"},"role":{"type":"string","description":"Role that the node has in the cluster. Possible values PRIMARY, REPLICA, UNASSIGNED"},"readyToTakeTraffic":{"type":"boolean","description":"True if the cluster node is ready to take traffic. Typically it is a Primary node"},"readyToBecomePrimary":{"type":"boolean","description":"True if the cluster node is a Replica and in sync with the Primary node"}}},"MemoryItem":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","format":"int64","description":"The memory in bytes used by the JVM"},"freeJvmMemory":{"type":"integer","format":"int64","description":"The remaining memory in bytes for the JVM"},"maxJvmMemory":{"type":"integer","format":"int64","description":"The maximum memory in bytes available to the JVM"},"totalOsMemory":{"type":"integer","format":"int64","description":"The total memory in bytes available for the operating system"},"freeOsMemory":{"type":"integer","format":"int64","description":"The remaining memory in bytes for the operating system"},"totalSwapMemory":{"type":"integer","format":"int64","description":"The total memory in bytes available for swap space"},"freeSwapMemory":{"type":"integer","format":"int64","description":"The remaining memory in bytes for swap space"}}},"LogEvent":{"type":"object","properties":{"exception":{"type":"string","description":"The exception message if any"},"site":{"type":"string","description":"The site name"},"level":{"type":"string","description":"The level of the log event"},"thread":{"type":"string","description":"The name of the thread"},"message":{"type":"string","description":"The message of the log event"},"timestamp":{"type":"string","format":"datetime","description":"The timestamp of the log event"},"timestampm":{"type":"integer","format":"int64","description":"The time in milliseconds of the log event"}}},"DiskUsage":{"type":"object","properties":{"diskUsage":{"type":"integer","format":"int32","description":"The disk usage percentage","example":75},"totalSpace":{"type":"integer","format":"int64","description":"The total disk space in bytes"},"freeSpace":{"type":"integer","format":"int64","description":"The free disk space in bytes"},"usedSpace":{"type":"integer","format":"int64","description":"The used disk space in bytes"},"alarm":{"type":"boolean","description":"True if free space is too low"},"highWaterMark":{"type":"integer","format":"int32","description":"The high water mark percentage for disk usage","example":90},"lowWaterMark":{"type":"integer","format":"int32","description":"The low water mark percentage for disk usage","example":85},"alarmDate":{"type":"string","format":"date-time","description":"The date and time when the disk usage alarm was triggered"},"lastCheck":{"type":"string","format":"date-time","description":"The date and time when the last disk usage check was performed"},"lastCleanup":{"type":"string","format":"date-time","description":"The date and time when the last disk cleanup was performed"}}},"RemoteRepository":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"remoteName":{"type":"string","description":"remote repository name"},"remoteUrl":{"type":"string","format":"URL","description":"URL to access remote repository"},"authenticationType":{"type":"string","description":"Authentication type to use to access remote repository\nPossible values:\n\n  - none: no authentication\n\n  - basic: username and password authentication\n\n  - token: token authentication\n\n  - key: key-based authentication"},"remoteUsername":{"type":"string","description":"username to use to access remote repository"},"remotePassword":{"type":"string","description":"password to use to access remote repository"},"remoteToken":{"type":"string","description":"token to use to access remote repository"},"remotePrivateKey":{"type":"string","description":"private key to access"}},"required":["siteId","remoteName","remoteUrl","authenticationType"]},"RemoteRepositoryInfo":{"type":"object","properties":{"name":{"type":"string","description":"remote repository name"},"url":{"type":"string","description":"remote repository url"},"fetch":{"type":"string","description":"remote repository fetch references"},"push_url":{"type":"string","description":"remote repository push url"},"branches":{"type":"array","items":{"type":"string","description":"remote repository branch name"}},"reachable":{"type":"boolean","description":"true if remote repository is reachable, otherwise false"},"unreachableReason":{"type":"string","description":"reason why remote is unreachable"},"removable":{"type":"boolean","description":"true if remote repository can be removed, otherwise false"}}},"QuickCreateItem":{"type":"object","properties":{"siteId":{"type":"string","description":"site id"},"label":{"type":"string","description":"user friendly label for content type name"},"contentTypeId":{"type":"string","description":"content type id"},"path":{"type":"string","description":"path expression to generate path for quick create"}}},"RepositoryStatus":{"type":"object","properties":{"conflicting":{"type":"array","description":"list of conflicting files","items":{"type":"string"}},"uncommittedChanges":{"type":"array","description":"list of added files","items":{"type":"string"}},"clean":{"type":"boolean","description":"true if there are no conflicts or uncommitted changes"}}},"History":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/ContentItem"},"versions":{"type":"array","description":"list of versions","items":{"$ref":"#/components/schemas/ItemVersion"}}}},"ContentItem":{"type":"object","description":"API v1 object"},"PublishingPackage":{"type":"object","properties":{"id":{"type":"string","description":"package ID"},"siteId":{"type":"string","description":"site ID"},"schedule":{"type":"string","format":"datetime","description":"scheduled date and time"},"approver":{"type":"string","description":"user that approved publishing package"},"state":{"type":"string","description":"package state"},"publishingTarget":{"type":"string","description":"publishing target where package will be published"},"comment":{"type":"string","description":"submission comment"}},"required":["id","siteId","schedule","approver","state","publishingTarget"]},"PublishingPackageDetails":{"type":"object","properties":{"id":{"type":"string","description":"package ID"},"siteId":{"type":"string","description":"site ID"},"schedule":{"type":"string","format":"datetime","description":"scheduled date and time"},"approver":{"type":"string","description":"user that approved publishing package"},"state":{"type":"string","description":"package state"},"publishingTarget":{"type":"string","description":"publishing target where package will be published"},"comment":{"type":"string","description":"submission comment"},"items":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"content item path"},"contentTypeClass":{"type":"string","description":"content type class"},"mimeType":{"type":"string","description":"mime-type"}}}}},"required":["id","schedule","approver","state","publishingTarget","items"]},"PublishingStatus":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true if publishing for site is enabled, otherwise false"},"status":{"type":"string","description":"publishing status for site"},"lockOwner":{"type":"string","description":"studio instance owner of publishing lock"},"lockTTL":{"type":"string","description":"TTL timestamp for publishing lock"},"totalItems":{"type":"integer","format":"int32","description":"total number of item being published right now"},"numberOfItems":{"type":"integer","format":"int32","description":"number of items published so far"},"submissionId":{"type":"string","description":"identifier of a submission being published"},"publishingTarget":{"type":"string","description":"publishing target for package"},"published":{"type":"boolean","description":"true if site has been published at least once (initial publish; published repository exist), otherwise false"}},"required":["enabled","status","message","lockOwner","lockTTL"]},"DeploymentHistoryGroup":{"type":"object","properties":{"internalName":{"type":"string","description":"user friendly label"},"numberOfChildren":{"type":"integer","format":"int32","description":"number of items in the group"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ContentItem"}},"publishingTarget":{"type":"string","description":"publishing target where item was published"}},"required":["internalName","numberOfChildren","children","publishingTarget"]},"DependencyItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"}},"required":["id","label","path"]},"SandboxItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"parentId":{"type":"integer","format":"int64","description":"parent item ID"},"contentTypeId":{"type":"string","description":"content type of content item"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"},"previewUrl":{"type":"string","description":"url for previewing content item"},"systemType":{"type":"string","description":"one of predefined type values (page, component, asset, levelDescriptor, folder ...)"},"mimeType":{"type":"string","description":"mime-type of content item file"},"state":{"type":"integer","format":"int64","description":"bitmap of states\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: New, `DESCRIPTION`: The item is new and never been published\n  * `BIT ORDER (little-endian)`: 1: `FLAG`: Modified, `DESCRIPTION`: The item has been published in the past and has been modified in the sandbox\n  * `BIT ORDER (little-endian)`: 2: `FLAG`: Deleted, `DESCRIPTION`: The item is deleted\n  * `BIT ORDER (little-endian)`: 3: `FLAG`: User Locked, `DESCRIPTION`: The item is locked by a user\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: System Processing, `DESCRIPTION`: The item is locked by the system for processing\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: In Workflow, `DESCRIPTION`: The item has been submitted for review\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Scheduled, `DESCRIPTION`: The item has been scheduled for review or publishing ounce approved\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Publishing, `DESCRIPTION`: The item is being published\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Destination, `DESCRIPTION`: If the item is being published, the destination is staging if 0, and live if 1\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Staged, `DESCRIPTION`: The item has been pushed to the staging publishing target\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Live, `DESCRIPTION`: The item has been pushed to the live publishing target\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Disabled, `DESCRIPTION`: The item has been disabled\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Reserved 12, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Reserved 11, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Reserved 10, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Reserved 9, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Reserved 8, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Reserved 7, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Reserved 6, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Reserved 5, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Reserved 4, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Reserved 3, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Reserved 2, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Reserved 1, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Translation Up To Date, `DESCRIPTION`: This item is a translation of another and it’s up to date\n  * `BIT ORDER (little-endian)`: 25, `FLAG`: Translation Pending, `DESCRIPTION`: This item is a translation of another and it’s pending translation\n  * `BIT ORDER (little-endian)`: 26, `FLAG`: Translation in Progress, `DESCRIPTION`: This item is a translation of another and is currently being translated"},"lockOwner":{"$ref":"#/components/schemas/Person","description":"user that locked item for editing"},"localeCode":{"type":"string","description":"locale of content item"},"translationSourceId":{"type":"string","description":"ID of content item that is original for translation that current item represents"},"creator":{"$ref":"#/components/schemas/Person","description":"user that created the item"},"dateCreated":{"type":"string","format":"datetime","description":"timestamp when item was created"},"modifier":{"$ref":"#/components/schemas/Person","description":"last user that modified item"},"dateModified":{"type":"string","format":"datetime","description":"timestamp when was item last modified"},"submitter":{"$ref":"#/components/schemas/Person","description":"user that submitted item for review (if any)"},"dateSubmitted":{"type":"string","format":"datetime","description":"timestamp when item was submitted for review (if any)"},"sizeInBytes":{"type":"integer","format":"int64","description":"size of content item in the repository"},"expiresOn":{"type":"string","format":"datetime","description":"timestamp when the item will expire, can be null if not present/set"},"availableActions":{"type":"integer","format":"int64","description":"available actions bitmap\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: Content: Read, `DESCRIPTION`: Read content\n  * `BIT ORDER (little-endian)`: 1, `FLAG`: Content: Copy, `DESCRIPTION`: Copy content\n  * `BIT ORDER (little-endian)`: 2, `FLAG`: Content: Read Version History, `DESCRIPTION`: Read version history for content\n  * `BIT ORDER (little-endian)`: 3, `FLAG`: Content: Get Dependencies, `DESCRIPTION`: Get content dependencies\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: Publish: Request, `DESCRIPTION`: Request publish for content\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: Content: Create, `DESCRIPTION`: Create content\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Content: Paste, `DESCRIPTION`: Paste content\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Content: Edit, `DESCRIPTION`: Update content\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Content: Rename, `DESCRIPTION`: Rename or move content\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Content: Cut, `DESCRIPTION`: Cut content\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Content: Upload, `DESCRIPTION`: Upload content\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Content: Duplicate, `DESCRIPTION`: Duplicate content\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Content: Change Type, `DESCRIPTION`: Change content type\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Content: Revert, `DESCRIPTION`: Revert content\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Content: Edit controller, `DESCRIPTION`: Edit controller for content type\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Content: Edit template, `DESCRIPTION`: Edit rendering template\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Content: Create folder, `DESCRIPTION`: Create folder\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Content: Delete, `DESCRIPTION`: Delete content\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Content: Delete controller, `DESCRIPTION`: Delete content type controller\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Content: Delete template, `DESCRIPTION`: Delete rendering template\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Publish: Publish, `DESCRIPTION`: Publish content\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Publish: Approve, `DESCRIPTION`: Approve publish request\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Publish: Schedule, `DESCRIPTION`: Schedule publish\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Publish: Reject, `DESCRIPTION`: Reject publish request\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Content: Unlock, `DESCRIPTION`: Unlock content item"},"childrenCount":{"type":"integer","format":"int32","description":"number of children of the item"}},"required":["id","label","contentTypeId","path","previewUrl","systemType","mimeType","state","lockOwner","createdDate","creator","modifier","lastModifiedDate","commitId","availableActions"]},"DetailedItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"parentId":{"type":"integer","format":"int64","description":"parent item ID"},"contentTypeId":{"type":"string","description":"content type of content item"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"},"previewUrl":{"type":"string","description":"url for previewing content item"},"systemType":{"type":"string","format":"page, component, asset, levelDescriptor, folder","description":"type of item in CrafterCMS domain"},"mimeType":{"type":"string","description":"mime-type of content item file"},"state":{"type":"integer","format":"int64","description":"bitmap of states\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: New, `DESCRIPTION`: The item is new and never been published\n  * `BIT ORDER (little-endian)`: 1: `FLAG`: Modified, `DESCRIPTION`: The item has been published in the past and has been modified in the sandbox\n  * `BIT ORDER (little-endian)`: 2: `FLAG`: Deleted, `DESCRIPTION`: The item is deleted\n  * `BIT ORDER (little-endian)`: 3: `FLAG`: User Locked, `DESCRIPTION`: The item is locked by a user\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: System Processing, `DESCRIPTION`: The item is locked by the system for processing\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: In Workflow, `DESCRIPTION`: The item has been submitted for review\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Scheduled, `DESCRIPTION`: The item has been scheduled for review or publishing ounce approved\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Publishing, `DESCRIPTION`: The item is being published\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Destination, `DESCRIPTION`: If the item is being published, the destination is staging if 0, and live if 1\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Staged, `DESCRIPTION`: The item has been pushed to the staging publishing target\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Live, `DESCRIPTION`: The item has been pushed to the live publishing target\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Disabled, `DESCRIPTION`: The item has been disabled\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Reserved 12, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Reserved 11, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Reserved 10, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Reserved 9, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Reserved 8, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Reserved 7, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Reserved 6, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Reserved 5, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Reserved 4, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Reserved 3, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Reserved 2, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Reserved 1, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Translation Up To Date, `DESCRIPTION`: This item is a translation of another and it’s up to date\n  * `BIT ORDER (little-endian)`: 25, `FLAG`: Translation Pending, `DESCRIPTION`: This item is a translation of another and it’s pending translation\n  * `BIT ORDER (little-endian)`: 26, `FLAG`: Translation in Progress, `DESCRIPTION`: This item is a translation of another and is currently being translated"},"lockOwner":{"$ref":"#/components/schemas/Person","description":"user that locked item for editing"},"localeCode":{"type":"string","description":"locale of content item"},"translationSourceId":{"type":"string","description":"ID of content item that is original for translation that current item represents"},"expiresOn":{"type":"string","format":"datetime","description":"timestamp when the item will expire, can be null if not present/set"},"availableActions":{"type":"integer","format":"int64","description":"available actions bitmap\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: Content: Read, `DESCRIPTION`: Read content\n  * `BIT ORDER (little-endian)`: 1, `FLAG`: Content: Copy, `DESCRIPTION`: Copy content\n  * `BIT ORDER (little-endian)`: 2, `FLAG`: Content: Read Version History, `DESCRIPTION`: Read version history for content\n  * `BIT ORDER (little-endian)`: 3, `FLAG`: Content: Get Dependencies, `DESCRIPTION`: Get content dependencies\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: Publish: Request, `DESCRIPTION`: Request publish for content\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: Content: Create, `DESCRIPTION`: Create content\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Content: Paste, `DESCRIPTION`: Paste content\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Content: Edit, `DESCRIPTION`: Update content\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Content: Rename, `DESCRIPTION`: Rename or move content\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Content: Cut, `DESCRIPTION`: Cut content\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Content: Upload, `DESCRIPTION`: Upload content\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Content: Duplicate, `DESCRIPTION`: Duplicate content\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Content: Change Type, `DESCRIPTION`: Change content type\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Content: Revert, `DESCRIPTION`: Revert content\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Content: Edit controller, `DESCRIPTION`: Edit controller for content type\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Content: Edit template, `DESCRIPTION`: Edit rendering template\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Content: Create folder, `DESCRIPTION`: Create folder\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Content: Delete, `DESCRIPTION`: Delete content\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Content: Delete controller, `DESCRIPTION`: Delete content type controller\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Content: Delete template, `DESCRIPTION`: Delete rendering template\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Publish: Publish, `DESCRIPTION`: Publish content\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Publish: Approve, `DESCRIPTION`: Approve publish request\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Publish: Schedule, `DESCRIPTION`: Schedule publish\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Publish: Reject, `DESCRIPTION`: Reject publish request\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Content: Unlock, `DESCRIPTION`: Unlock content item"},"sandbox":{"type":"object","description":"metadata of content item version stored in sandbox repository","properties":{"creator":{"$ref":"#/components/schemas/Person","description":"user that created the item"},"dateCreated":{"type":"string","format":"datetime","description":"timestamp when item was created"},"modifier":{"$ref":"#/components/schemas/Person","description":"last user that modified sandbox version of item"},"dateModified":{"type":"string","format":"datetime","description":"timestamp when was item last modified in sandbox"},"submitter":{"$ref":"#/components/schemas/Person","description":"user that submitted item for publishing"},"dateSubmitted":{"type":"string","format":"datetime","description":"timestamp when item was submitted for review (if any)"},"sizeInBytes":{"type":"integer","format":"int64","description":"size of content item in the repository"}}},"staging":{"type":"object","description":"metadata of content item version stored in staging repository","properties":{"dateScheduled":{"type":"string","format":"datetime","description":"timestamp when is item scheduled for publishing to staging repository"},"datePublished":{"type":"string","format":"datetime","description":"timestamp when was item last time published to staging repository"},"publisher":{"type":"string","description":"username of last user that published item to staging repository"},"commitId":{"type":"string","description":"commit id of last modification in the staging repository"}}},"live":{"type":"object","description":"metadata of content item version stored in live repository","properties":{"dateScheduled":{"type":"string","format":"datetime","description":"timestamp when is item scheduled for publishing to live repository"},"datePublished":{"type":"string","format":"datetime","description":"timestamp when was item last time published to live repository"},"publisher":{"type":"string","description":"username of last user that published item to live repository"},"commitId":{"type":"string","description":"commit id of last modification in the live repository"}}},"childrenCount":{"type":"integer","format":"int32","description":"number of children of the item"}},"required":["id","label","contentTypeId","path","previewUrl","systemType","mimeType","state","lockOwner","staging","availableActions"]},"LocalizationItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"parentId":{"type":"integer","format":"int64","description":"parent item ID"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"},"previewUrl":{"type":"string","description":"url for previewing content item"},"systemType":{"type":"string","description":"one of predefined type values (page, component, asset, level descriptor, folder ...)"},"mimeType":{"type":"string","description":"mime-type of content item file"},"state":{"type":"integer","format":"int64","description":"bitmap of states\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: New, `DESCRIPTION`: The item is new and never been published\n  * `BIT ORDER (little-endian)`: 1: `FLAG`: Modified, `DESCRIPTION`: The item has been published in the past and has been modified in the sandbox\n  * `BIT ORDER (little-endian)`: 2: `FLAG`: Deleted, `DESCRIPTION`: The item is deleted\n  * `BIT ORDER (little-endian)`: 3: `FLAG`: User Locked, `DESCRIPTION`: The item is locked by a user\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: System Processing, `DESCRIPTION`: The item is locked by the system for processing\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: In Workflow, `DESCRIPTION`: The item has been submitted for review\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Scheduled, `DESCRIPTION`: The item has been scheduled for review or publishing ounce approved\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Publishing, `DESCRIPTION`: The item is being published\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Destination, `DESCRIPTION`: If the item is being published, the destination is staging if 0, and live if 1\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Staged, `DESCRIPTION`: The item has been pushed to the staging publishing target\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Live, `DESCRIPTION`: The item has been pushed to the live publishing target\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Disabled, `DESCRIPTION`: The item has been disabled\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Reserved 12, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Reserved 11, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Reserved 10, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Reserved 9, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Reserved 8, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Reserved 7, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Reserved 6, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Reserved 5, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Reserved 4, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Reserved 3, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Reserved 2, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Reserved 1, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Translation Up To Date, `DESCRIPTION`: This item is a translation of another and it’s up to date\n  * `BIT ORDER (little-endian)`: 25, `FLAG`: Translation Pending, `DESCRIPTION`: This item is a translation of another and it’s pending translation\n  * `BIT ORDER (little-endian)`: 26, `FLAG`: Translation in Progress, `DESCRIPTION`: This item is a translation of another and is currently being translated"},"lockOwner":{"type":"string","description":"username of user that locked item for editing"},"localeCode":{"type":"string","description":"locale of content item"},"translationSourceId":{"type":"string","description":"ID of content item that is original for translation that current item represents"}},"required":["id","label","contentTypeId","path","previewUrl","systemType","mimeType","state","lockOwner","localeCode"]},"ContentValidationRequest":{"type":"object","properties":{"actions":{"type":"array","description":"The list of actions to verify","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of action, possible values: CREATE, RENAME, MOVE, COPY\n"},"source":{"type":"string","description":"The source value, only needed for recursive COPY, MOVE and RENAME actions"},"target":{"type":"string","description":"The target value"},"recursive":{"type":"boolean","description":"Indicates if all child items should be verified too","default":false},"contentMetadata":{"type":"object","properties":{"fileSize":{"type":"integer","format":"int64","description":"The size of the file in bytes, only needed for CREATE actions"},"contentType":{"type":"string","description":"The id of the crafter content type, only needed for CREATE actions"}}}},"required":["type","target"]}}},"required":["siteId","actions"]},"ContentValidationResult":{"type":"object","properties":{"actions":{"type":"array","description":"The list of results","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of action"},"target":{"type":"string","description":"The target value"},"allowed":{"type":"boolean","description":"Indicates if the operation is allowed"},"modifiedValue":{"type":"string","description":"The adjusted value if available"},"message":{"type":"string","description":"A detail message for the validation result"}}}}}},"ChildrenByPathRequest":{"type":"object","properties":{"path":{"description":"item path to get children for","type":"string"},"localeCode":{"description":"filter children by locale code, or show source items (not translation) if translation to\nspecified locale code does not exist","type":"string"},"sortStrategy":{"description":"sort strategy (sort order) Possible values:\n  - alphabetical (default)\n  - foldersFirst (order by: folders alphabetical, files alphabetical)\n  - lastUpdated (order by: dateModified)","type":"string"},"order":{"description":"order for sort strategy ascending or descending (ASC / DESC)","type":"string","format":"ASC, DESC"},"offset":{"description":"offset of first child in response - default 0","type":"integer"},"limit":{"description":"number of children to return","type":"integer"},"keyword":{"description":"filter children by keyword","type":"string"},"systemTypes":{"description":"filter children by system type\n\nNote that this parameter does not honor \"levelDescriptor\" as a valid type","type":"array","items":{"type":"string"}},"excludes":{"description":"exclude items by path","type":"array","items":{"type":"string"}}}},"PasteItem":{"type":"object","properties":{"path":{"type":"string","description":"The path of the item"},"children":{"type":"array","description":"The child items","items":{"$ref":"#/components/schemas/PasteItem"}}},"required":["path"]},"PasteRequest":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"operation":{"type":"string","description":"Indicate the type of operation","enum":["COPY","CUT"]},"targetPath":{"type":"string","description":"The target path for the operation"},"item":{"$ref":"#/components/schemas/PasteItem"}},"required":["siteId","target","item"]},"AccessToken":{"type":"object","properties":{"token":{"type":"string","description":"Value of the access token, only visible when the token is created"},"expiresAt":{"type":"string","format":"date-time","description":"Date of expiration of the access token"},"id":{"type":"integer","format":"int64","description":"Id of the access token"},"label":{"type":"string","description":"The label of the access token"},"enabled":{"type":"boolean","description":"Indicates if the access token is enabled"},"createdOn":{"type":"string","format":"date-time","description":"Date of creation of the access token"}}},"WorkflowPackage":{"type":"object","properties":{"id":{"type":"string","description":"workflow package ID"},"siteId":{"type":"string","description":"site identifier"},"status":{"type":"string","description":"workflow package status"},"author":{"type":"string","description":"username of the author"},"reviewer":{"type":"string","description":"username of the reviewer"},"schedule":{"type":"string","format":"datetime","description":"scheduled date and time to publish the package"},"publishingTarget":{"type":"string","description":"name of the publishing target where package will be published"},"authorComment":{"type":"string","description":"author's comment"},"reviewerComment":{"type":"string","description":"reviewer's comment"},"label":{"type":"string","description":"user friendly label for package"}},"required":["id","siteId","status","author","publishingTarget"]},"Activity":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"activity ID"},"person":{"$ref":"#/components/schemas/Person"},"actionType":{"type":"string","description":"operation performed by user\n  * CREATE\n  * UPDATE\n  * DELETE\n  * MOVE\n  * REQUEST_PUBLISH\n  * APPROVE\n  * APPROVE_SCHEDULED\n  * REJECT\n  * REVERT\n  * PUBLISH\n  * INITIAL_PUBLISH\n  * UNKNOWN"},"item":{"type":"object","description":"item that operation was performed against","properties":{"id":{"type":"integer","format":"int64","description":"The id of the item"},"path":{"type":"string","description":"The path of the item"},"label":{"type":"string","description":"The label of the item"},"previewUrl":{"type":"string","description":"The preview URL of the item"}}},"package":{"type":"object","description":"package that operation was performed against","properties":{"id":{"type":"string","format":"UUID","description":"The id of the package"}}}},"required":["id","person","actionType"]},"Person":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"user ID"},"username":{"type":"string","description":"user's username"},"firstName":{"type":"string","description":"user's first name"},"lastName":{"type":"string","description":"user's last name"},"avatar":{"type":"string","format":"CLOB","description":"user's avatar"}},"required":["id","username","firstName","lastName"]},"DashboardPublishingPackage":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"package id"},"label":{"type":"string","description":"user friendly name of the package"},"comment":{"type":"string","description":"submission comment by publisher"},"submitter":{"$ref":"#/components/schemas/Person"},"size":{"type":"integer","format":"int32","description":"number of items in the package"},"publishingTarget":{"type":"string","description":"publishing target where package will be published"},"schedule":{"type":"string","format":"date-time","description":"date and time when package will be published"}},"required":["id","label","submitter","size","publishingTarget"]},"PublishingStats":{"type":"object","properties":{"numberOfPublishes":{"type":"integer","format":"int32","description":"Number of published content for given unit of time"},"numberOfNewAndPublishedItems":{"type":"integer","format":"int32","description":"Number of newly created and published items for given unit of time"},"numberOfEditedAndPublishedItems":{"type":"integer","format":"int32","description":"Number of edited and published items for given unit of time"}},"required":["numberOfPublishes","numberOfNewAndPublishedItems","numberOfEditedAndPublishedItems"]},"LoggerConfig":{"type":"object","properties":{"name":{"type":"string","description":"the logger name"},"level":{"type":"string","description":"the logger priority level (off|error|warn|info|debug|trace|all)"}},"required":["name","level"]},"LoggerConfigRequest":{"allOf":[{"$ref":"#/components/schemas/LoggerConfig"},{"type":"object","properties":{"createIfAbsent":{"type":"boolean","description":"if true, the logger will be created in case it does not exist yet. If false, a 404 status code will be returned if logger is not in the registry."}}}]},"ItemVersion":{"type":"object","properties":{"versionNumber":{"type":"string","description":"the commit id"},"path":{"type":"string","description":"the path of the item"},"oldPath":{"type":"string","description":"the old path of the item (will be the same as path if the item has not been renamed)"},"committer":{"type":"string","description":"the committer of the commit according to git log"},"author":{"$ref":"#/components/schemas/Person","description":"corresponds to the Studio user author of the commit (if any)"},"comment":{"type":"string","description":"the comment of the commit"},"revertible":{"type":"boolean","description":"true if a revert to this version will be allowed"},"modifiedDate":{"type":"string","format":"date-time","description":"the date of the commit"}}},"DuplicateSiteRequest":{"type":"object","properties":{"siteName":{"type":"string","description":"The name of the new site"},"siteId":{"type":"string","description":"The ID of the new site"},"description":{"type":"string","description":"The description of the new site"},"sandboxBranch":{"type":"string","description":"The sandbox branch to be used in the new site sandbox repository"},"readOnlyBlobStores":{"type":"boolean","description":"If true, the blob stores will be read-only in the copied site.","default":false}}},"ContentType":{"type":"object","properties":{"name":{"type":"string","description":"The site content name"},"label":{"type":"string","description":"The content type display name"},"form":{"type":"string","description":"The content type form"},"formPath":{"type":"string","description":"The content type form path"},"type":{"type":"string","description":"The type, e.g. page, component, etc"},"contentAsFolder":{"type":"boolean","description":"Indicates whether to create content in a folder wrapper e.g. pageUrl: 101 means 101/index.xml instead of 101.xml"},"useRoundedFolder":{"type":"boolean","description":"Indicates whether use rounded folder to arrange content"},"modelInstancePath":{"type":"string","description":"The path to the model instance file (WCM)"},"allowedRoles":{"type":"array","items":{"type":"string"},"description":"The list of roles allowed"},"lastUpdated":{"type":"string","description":"The date the content type was last updated"},"copyDependencyPattern":{"type":"array","items":{"type":"string"},"description":"The list of copy association patterns"},"imageThumbnail":{"type":"string","description":"The thumbnail image file to be displayed"},"noThumbnail":{"type":"boolean","description":"Indicates whether content type has a thumbnail"},"pathIncludes":{"type":"array","items":{"type":"string"},"description":"The the list of included paths"},"pathExcludes":{"type":"array","items":{"type":"string"},"description":"The the list of excluded paths"},"nodeRef":{"type":"string","description":"The configuration noderef this content type is associated with"},"quickCreate":{"type":"boolean","description":"Indicates whether the content type is available from the quick create button"},"quickCreatePath":{"type":"string","description":"The destination path pattern of content type"},"deleteDependencyPattern":{"type":"array","items":{"type":"string"},"description":"The list of delete association patterns that this content type is dependent on for deleting indexes in webproject"},"previewable":{"type":"boolean","description":"Indicates whether the content type is previewable"}}},"ContentItemV1":{"type":"object","properties":{"name":{"type":"string","description":"The item name"},"internalName":{"type":"string","description":"The item internal name"},"contentType":{"type":"string","description":"The item content type"},"uri":{"type":"string","description":"The content type uri"},"path":{"type":"string","description":"The content type form path"},"browserUri":{"type":"string"},"navigation":{"type":"boolean"},"floating":{"type":"boolean"},"hideInAuthoring":{"type":"boolean"},"previewable":{"type":"boolean"},"lockOwner":{"type":"string"},"user":{"type":"string"},"userFirstName":{"type":"string"},"userLastName":{"type":"string"},"nodeRef":{"type":"string"},"metaDescription":{"type":"string"},"site":{"type":"string"},"page":{"type":"boolean"},"component":{"type":"boolean"},"document":{"type":"boolean"},"asset":{"type":"boolean"},"isContainer":{"type":"boolean"},"container":{"type":"boolean"},"disabled":{"type":"boolean"},"savedAsDraft":{"type":"boolean"},"submitted":{"type":"boolean"},"submittedForDeletion":{"type":"boolean"},"scheduled":{"type":"boolean"},"published":{"type":"boolean"},"deleted":{"type":"boolean"},"inProgress":{"type":"boolean"},"live":{"type":"boolean"},"inFlight":{"type":"boolean"},"isDisabled":{"type":"boolean"},"isSavedAsDraft":{"type":"boolean"},"isInProgress":{"type":"boolean"},"isLive":{"type":"boolean"},"isSubmittedForDeletion":{"type":"boolean"},"isScheduled":{"type":"boolean"},"isPublished":{"type":"boolean"},"isNavigation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isNew":{"type":"boolean"},"isSubmitted":{"type":"boolean"},"isFloating":{"type":"boolean"},"isPage":{"type":"boolean"},"isPreviewable":{"type":"boolean"},"isComponent":{"type":"boolean"},"isDocument":{"type":"boolean"},"isAsset":{"type":"boolean"},"isInFlight":{"type":"boolean"},"eventDate":{"type":"string"},"endpoint":{"type":"string"},"timezone":{"type":"string"},"numOfChildren":{"type":"number"},"scheduledDate":{"type":"string"},"publishedDate":{"type":"string"},"mandatoryParent":{"type":"string"},"isLevelDescriptor":{"type":"boolean"},"categoryRoot":{"type":"string"},"lastEditDate":{"type":"string"},"form":{"type":"string"},"formPagePath":{"type":"string"},"renderingTemplates":{"type":"array","items":{"type":"string"}},"folder":{"type":"boolean"},"submissionComment":{"type":"string"},"components":{"type":"string"},"documents":{"type":"string"},"levelDescriptors":{"type":"string"},"pages":{"type":"string"},"parentPath":{"type":"string"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemOrder"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemV1"}},"size":{"type":"number"},"sizeUnit":{"type":"string"},"mimeType":{"type":"string"},"levelDescriptor":{"type":"boolean"},"newFile":{"type":"boolean"},"reference":{"type":"boolean"},"new":{"type":"boolean"}}},"ContentItemOrder":{"type":"object","properties":{"name":{"type":"string","description":"The item name"},"id":{"type":"string","description":"The item id"},"disabled":{"type":"string","description":"Indicates whether the item is disabled"},"order":{"type":"string","description":"The item's order"},"placeInNav":{"type":"string","description":"Indicates whether the item is placed in the navigation"}}},"ContentItemVersions":{"type":"object","properties":{"lastModifiedDate":{"type":"string","description":"The item's last modified date"},"lastModifier":{"type":"string","description":"The user that last modified the item"},"versionNumber":{"type":"string","description":"The item's version number"},"contentItem":{"type":"string","description":"The item content"},"comment":{"type":"string","description":"The comment"}}},"WriteContentWebForm":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site to use","example":"mysite"},"path":{"type":"string","description":"Path of the content","example":"/site/website/index.xml"},"fileName":{"type":"string","description":"File name of the content","example":"index.xml"},"contentType":{"type":"string","description":"Content type of the content","example":"/page/home"},"edit":{"type":"string","description":"True if it is edit, otherwise it is create","example":"index.xml"},"user":{"type":"string","description":"User that executes action","example":"admin"},"oldContentPath":{"type":"string","description":"If renaming, content old path"},"draft":{"type":"string","description":"True if saving as draft"},"unlock":{"type":"string","description":"False to keep content locked, otherwise true","example":"true"}},"required":["site_id","path","fileName","contentType","unlock"]},"WriteContentAssetForm":{"type":"object","properties":{"site":{"type":"string","description":"Project/Site to use","example":"mysite"},"path":{"type":"string","description":"Path of the content","example":"/site/website/index.xml"},"fileName":{"type":"string","description":"File name of the content","example":"index.xml"},"contentType":{"type":"string","description":"Content type of the content","example":"/page/home"},"user":{"type":"string","description":"User that executes action","example":"admin"},"isImage":{"type":"string","description":"True if it is image"},"allowedWidth":{"type":"integer","description":"Allowed image width"},"allowedHeight":{"type":"integer","description":"Allowed image height"},"allowLessSize":{"type":"string","description":"Allow less size"},"draft":{"type":"string","description":"True if saving as draft"},"unlock":{"type":"string","description":"false to keep content locked, otherwise true"},"systemAsset":{"type":"string","description":"true if it is private asset"}},"required":["site","path","fileName","unlock"]},"WriteContentFileUpload":{"type":"object","properties":{"site":{"type":"string","description":"Project/Site to use","example":"mysite"},"path":{"type":"string","description":"Path of the content","example":"/site/website/index.xml"},"fileName":{"type":"string","description":"File name of the content","example":"index.xml"},"contentType":{"type":"string","description":"Content type of the content","example":"/page/home"},"user":{"type":"string","description":"User that executes action","example":"admin"},"isImage":{"type":"string","description":"True if it is image"},"allowedWidth":{"type":"integer","description":"Allowed image width"},"allowedHeight":{"type":"integer","description":"Allowed image height"},"allowLessSize":{"type":"string","description":"Allow less size"},"draft":{"type":"string","description":"True if saving as draft"},"unlock":{"type":"string","description":"false to keep content locked, otherwise true"}},"required":["site","path","fileName","unlock"]},"AvailableLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The language code, e.g. ja"},"label":{"type":"string","description":"The language display name"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"Conflict":{"description":"Resource already exists","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"RequestTimeout":{"description":"Request Timeout (408)","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"InternalServerError":{"description":"Internal system failure","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"ServiceUnavailable":{"description":"Service unavailable (503)","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"api1OK":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"api1NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Site not found"}}}}},"api1BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"invalidParameter":{"value":{"message":"Invalid parameter: site_id"}},"pathMissing":{"value":{"message":"Path must be provided"}},"siteMissing":{"value":{"message":"Site must be provided"}}}}}},"api1Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}}},"api1Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized"}}}}},"api1Conflict":{"description":"Resource already exists","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Site already exists"}}}}},"api1InternalServerError":{"description":"Internal system failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Internal server error. ACTUAL_EXCEPTION"}}}}}},"securitySchemes":{"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"basicAuth":{"type":"http","scheme":"basic"}},"links":{},"callbacks":{}},"security":[{"jwtAuth":[]},{"basicAuth":[]}]}},"searchIndex":{"store":["tag/groups","tag/groups/operation/getGroups","tag/groups/operation/createGroup","tag/groups/operation/updateGroup","tag/groups/operation/deleteGroup","tag/groups/operation/getGroup","tag/groups/operation/getGroupMembers","tag/groups/operation/addGroupMembers","tag/groups/operation/removeGroupMembers","tag/users","tag/users/operation/getUsers","tag/users/operation/createUser","tag/users/operation/updateUser","tag/users/operation/deleteUser","tag/users/operation/getUser","tag/users/operation/enableUser","tag/users/operation/disableUser","tag/users/operation/getUserSites","tag/users/operation/getUserSiteRoles","tag/users/operation/resetUserPassword","tag/users/operation/setUserPassword","tag/users/operation/getCurrentUser","tag/users/operation/getCurrentUserSites","tag/users/operation/getCurrentUserSiteRoles","tag/users/operation/getCurrentUserSitePermissions","tag/users/operation/hasCurrentUserSitePermissions","tag/users/operation/getCurrentUserGlobalPermissions","tag/users/operation/hasCurrentUserGlobalPermissions","tag/users/operation/getCurrentUserSsoLogoutUrl","tag/users/operation/currentUserChangePassword","tag/users/operation/getUserProperties","tag/users/operation/updateUserProperties","tag/users/operation/deleteUserProperties","tag/users/operation/forgotPassword","tag/users/operation/validateToken","tag/ui","tag/ui/operation/getGlobalMenu","tag/ui/operation/getActiveEnv","tag/aws","tag/aws/operation/listItems","tag/aws/operation/uploadItem","tag/aws/operation/uploadVideo","tag/cluster","tag/cluster/operation/getClusterMembers","tag/cluster/operation/getClusterMode","tag/sites","tag/sites/operation/availableBlueprints","tag/sites/operation/createSiteFromMarketplace","tag/sites/operation/updateSite","tag/sites/operation/deleteSite","tag/sites/operation/unlockSite","tag/sites/operation/validate","tag/sites/operation/duplicateSite","tag/sites/operation/createSite","tag/sites/operation/deleteSiteAPI1","tag/sites/operation/projectExists","tag/sites/operation/getCannedMessage","tag/sites/operation/getSite","tag/sites/operation/monitorContent","tag/search","tag/search/operation/search","tag/audit","tag/audit/operation/getAuditLog","tag/audit/operation/getAuditLogById","tag/monitoring","tag/monitoring/operation/getVersion","tag/monitoring/operation/getStatus","tag/monitoring/operation/getMemory","tag/monitoring/operation/getLogEvents","tag/monitoring/operation/getDiskUsage","tag/repository","tag/repository/operation/addRemoteRepository","tag/repository/operation/pullFromRemoteRepository","tag/repository/operation/pushToRemoteRepository","tag/repository/operation/removeRemoteRepository","tag/repository/operation/listRemoteRepositories","tag/repository/operation/repositoryStatus","tag/repository/operation/resolveConflict","tag/repository/operation/diffConflictedFile","tag/repository/operation/commitResolution","tag/repository/operation/cancelFailedPull","tag/repository/operation/unlockRepository","tag/repository/operation/isRepositoryCorrupted","tag/repository/operation/repairCorruptedRepository","tag/content","tag/content/operation/changeContentType","tag/content/operation/createFolder","tag/content/operation/renameFolder","tag/content/operation/getContent","tag/content/operation/getContentAtPath","tag/content/operation/getContentType","tag/content/operation/getContentTypes","tag/content/operation/getItem","tag/content/operation/getItemOrders","tag/content/operation/getItemVersions","tag/content/operation/getItemsTree","tag/content/operation/getNextItemOrder","tag/content/operation/getPages","tag/content/operation/reorderItems","tag/content/operation/revertContent","tag/content/operation/writeContent","tag/content/operation/quickCreateContent","tag/content/operation/getDeletePackage","tag/content/operation/contentDelete","tag/content/operation/contentRename","tag/content/operation/getChildrenByPath","tag/content/operation/getChildrenByPaths","tag/content/operation/contentExists","tag/content/operation/getDetailedItemByPath","tag/content/operation/getSandboxItemsByPath","tag/content/operation/getDescriptor","tag/content/operation/pasteItems","tag/content/operation/duplicateItem","tag/content/operation/itemLockByPath","tag/content/operation/itemUnlockByPath","tag/content/operation/getContentByCommitId","tag/content/operation/getItemHistory","tag/configuration","tag/configuration/operation/getConfiguration","tag/configuration/operation/writeConfiguration","tag/configuration/operation/clearConfigurationCache","tag/configuration/operation/getConfigurationHistory","tag/configuration/operation/getContentTypeUsage","tag/configuration/operation/getContentTypePreviewImage","tag/configuration/operation/getContentTypeFormController","tag/configuration/operation/deleteContentType","tag/plugin","tag/plugin/operation/getPluginFile","tag/plugin/operation/getPluginConfiguration","tag/plugin/operation/writePluginConfiguration","tag/plugin/operation/reloadClasses","tag/dependency","tag/dependency/operation/getDependant","tag/dependency/operation/getSimpleDependencies","tag/dependency/operation/getDependencies","tag/marketplace","tag/marketplace/operation/searchPlugins","tag/marketplace/operation/getInstalledPlugins","tag/marketplace/operation/installPlugin","tag/marketplace/operation/copyPlugin","tag/marketplace/operation/removePlugin","tag/marketplace/operation/pluginUsage","tag/webdav","tag/webdav/operation/listItemsWebdav","tag/webdav/operation/uploadItemWebdav","tag/publishing","tag/publishing/operation/publishCommits","tag/publishing/operation/publishStart","tag/publishing/operation/publishStop","tag/publishing/operation/publishAll","tag/publishing/operation/PublishingPackages","tag/publishing/operation/getPublishingPackageDetails","tag/publishing/operation/cancelPublishingPackages","tag/publishing/operation/getPublishingStatus","tag/publishing/operation/getPublishingHistory","tag/publishing/operation/getAvailablePublishingTargets","tag/publishing/operation/hasInitialPublish","tag/security","tag/security/operation/encrypt","tag/security/operation/getAccessTokens","tag/security/operation/createAccessToken","tag/security/operation/updateAccessToken","tag/security/operation/deleteAccessToken","tag/security/operation/switchPreviewSite","tag/dashboard","tag/dashboard/operation/getDashboardActivities","tag/dashboard/operation/getDashboardMyActivities","tag/dashboard/operation/getDashboardContentPendingApproval","tag/dashboard/operation/getDashboardContentPendingApprovalDetail","tag/dashboard/operation/getDashboardContentUnpublished","tag/dashboard/operation/getPublishingScheduled","tag/dashboard/operation/getDashboardPublishingScheduledDetail","tag/dashboard/operation/getDashboardPublishingHistory","tag/dashboard/operation/getDashboardPublishingHistoryDetail","tag/dashboard/operation/getDashboardPublishingStats","tag/dashboard/operation/getDashboardContentExpiring","tag/dashboard/operation/getDashboardContentExpired","tag/workflow","tag/workflow/operation/getItemStates","tag/workflow/operation/setItemStates","tag/workflow/operation/updateItemStates","tag/workflow/operation/getWorkflowAffectedPaths","tag/workflow/operation/workflowRequestPublish","tag/workflow/operation/workflowPublish","tag/workflow/operation/workflowApprove","tag/workflow/operation/workflowReject","tag/workflow/operation/workflowListPackage","tag/workflow/operation/workflowCreatePackage","tag/workflow/operation/workflowUpdatePackage","tag/workflow/operation/workflowGetPackage","tag/workflow/operation/workflowApprovePackage","tag/workflow/operation/workflowRejectPackage","tag/loggers","tag/loggers/operation/loggersGetAll","tag/loggers/operation/loggersUpdateLevel","tag/server","tag/server/operation/getAvailableLanguages","tag/deployment","tag/deployment/operation/bulkGoLive","tag/preview","tag/preview/operation/syncSite","tag/model","tag/model/operation/getAllModelDefinitions","tag/dependent_items","tag/dependent_items/operation/getDependentItems"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.371]],["description/0",[0,3.444,1,4.281,2,2.384]],["title/1",[0,4.371]],["description/1",[3,0.22,4,0.414,5,4.099,6,3.846]],["title/2",[0,3.766,7,3.643]],["description/2",[3,0.22,4,0.414,6,3.846,8,4.952]],["title/3",[0,3.766,9,4.055]],["description/3",[3,0.22,4,0.414,6,3.846,10,4.438]],["title/4",[11,3.766,12,6.025]],["description/4",[3,0.22,4,0.414,6,3.846,13,4.438]],["title/5",[0,3.766,14,4.435]],["description/5",[3,0.22,4,0.414,5,4.099,15,4.952]],["title/6",[0,3.308,16,3.562,17,3.896]],["description/6",[3,0.22,4,0.414,5,4.099,18,4.099]],["title/7",[0,2.95,17,3.474,19,4.23,20,4.23]],["description/7",[3,0.22,4,0.414,10,4.438,18,4.099]],["title/8",[0,2.95,17,3.474,20,4.23,21,3.907]],["description/8",[3,0.22,4,0.414,13,4.438,18,4.099]],["title/9",[22,2.761]],["description/9",[1,4.281,2,2.384,22,2.176]],["title/10",[22,2.761]],["description/10",[3,0.22,4,0.414,23,3.846,24,3.846]],["title/11",[7,3.643,22,2.379]],["description/11",[3,0.22,4,0.414,24,3.846,25,4.952]],["title/12",[9,4.055,22,2.379]],["description/12",[3,0.22,4,0.414,24,3.846,26,3.846]],["title/13",[11,3.766,27,4.988]],["description/13",[3,0.22,4,0.414,24,3.846,28,4.952]],["title/14",[14,3.474,22,2.596,29,4.719]],["description/14",[3,0.22,4,0.414,23,3.846,30,4.952]],["title/15",[27,4.988,31,6.025]],["description/15",[3,0.22,4,0.414,26,3.846,32,4.952]],["title/16",[27,4.988,33,5.4]],["description/16",[3,0.22,4,0.414,26,3.846,34,4.952]],["title/17",[17,3.474,22,1.863,35,1.257,36,3.474]],["description/17",[3,0.22,4,0.414,23,3.846,37,4.952]],["title/18",[17,3.474,22,1.863,35,1.257,38,1.686]],["description/18",[3,0.22,4,0.414,23,3.846,39,4.952]],["title/19",[22,2.09,40,5.293,41,3.896]],["description/19",[3,0.22,4,0.414,26,3.846,42,4.952]],["title/20",[22,2.09,41,3.896,43,4.382]],["description/20",[3,0.22,4,0.414,44,4.099,45,4.952]],["title/21",[22,2.09,46,2.381,47,3.308]],["description/21",[3,0.22,4,0.414,48,2.539,49,4.952]],["title/22",[22,1.681,35,1.134,36,3.134,46,1.915,47,2.661]],["description/22",[3,0.22,4,0.414,48,2.539,50,4.952]],["title/23",[22,1.681,35,1.134,38,1.521,46,1.915,47,2.661]],["description/23",[3,0.22,4,0.414,48,2.539,51,4.952]],["title/24",[4,0.356,22,1.681,35,1.134,46,1.915,47,2.661]],["description/24",[3,0.22,4,0.414,48,2.539,52,4.952]],["title/25",[4,0.324,22,1.531,46,1.745,47,2.424,53,2.723,54,1.531]],["description/25",[3,0.22,4,0.414,48,2.539,55,4.952]],["title/26",[22,1.863,46,2.123,47,2.95,56,3.314]],["description/26",[3,0.22,4,0.414,48,2.539,57,4.952]],["title/27",[4,0.298,22,1.406,46,1.602,47,2.226,53,2.501,54,1.406,56,2.501]],["description/27",[3,0.22,4,0.414,48,2.539,58,4.952]],["title/28",[22,1.3,46,1.481,47,2.058,59,2.951,60,3.292,61,3.292,62,2.951,63,2.951]],["description/28",[3,0.081,4,0.152,22,0.718,33,1.629,47,1.136,48,0.932,59,1.629,62,3.659,63,1.629,64,3.113,65,1.629,66,1.818,67,1.338,68,1.818,69,1.818,70,1.818,71,1.818,72,1.818]],["title/29",[22,1.863,41,3.474,43,3.907,46,2.123]],["description/29",[3,0.22,4,0.414,48,2.539,73,4.952]],["title/30",[22,1.863,46,2.123,74,4.719,75,3.907]],["description/30",[3,0.22,4,0.414,48,2.539,76,4.099]],["title/31",[9,3.176,22,1.863,46,2.123,75,3.907]],["description/31",[3,0.22,4,0.414,48,2.539,76,4.099]],["title/32",[11,2.95,22,1.863,46,2.123,75,3.907]],["description/32",[3,0.22,4,0.414,48,2.539,76,4.099]],["title/33",[41,4.435,77,5.4]],["description/33",[3,0.22,4,0.414,44,4.099,78,4.952]],["title/34",[41,3.474,77,4.23,79,4.719,80,3.474]],["description/34",[3,0.22,4,0.414,44,4.099,81,4.952]],["title/35",[82,5.789]],["description/35",[2,2.384,82,4.562,83,5.51]],["title/36",[22,1.531,46,1.745,56,2.723,84,3.879,85,1.455,86,2.855]],["description/36",[3,0.22,4,0.414,48,2.539,87,4.952]],["title/37",[46,2.123,65,4.23,88,3.907,89,4.719]],["description/37",[3,0.22,4,0.414,48,2.539,90,4.952]],["title/38",[91,6.267]],["description/38",[2,2.687,91,5.567]],["title/39",[85,1.77,92,2.544,93,3.907,94,3.907]],["description/39",[3,0.22,4,0.414,95,4.952,96,4.952]],["title/40",[93,3.907,94,3.907,97,3.666,98,3.056]],["description/40",[3,0.22,4,0.414,99,4.438,100,4.952]],["title/41",[93,2.949,94,2.949,97,2.767,98,2.307,101,3.562,102,3.562,103,3.562]],["description/41",[3,0.22,4,0.414,99,4.438,104,4.952]],["title/42",[105,5.432]],["description/42",[1,4.281,2,2.384,105,4.281]],["title/43",[16,4.055,105,4.681]],["description/43",[3,0.22,4,0.414,106,4.438,107,4.952]],["title/44",[67,3.134,105,3.308,108,3.134,109,4.258,110,4.258]],["description/44",[3,0.22,4,0.414,106,4.438,111,4.952]],["title/45",[35,1.863]],["description/45",[1,4.281,2,2.384,35,1.468]],["title/46",[86,4.435,112,5.4]],["description/46",[3,0.22,4,0.414,48,2.539,113,4.952]],["title/47",[7,2.854,35,1.257,112,4.23,114,3.176]],["description/47",[115,7.116]],["title/48",[9,2.866,35,1.134,54,1.681,116,4.258,117,4.258]],["description/48",[3,0.22,4,0.414,118,4.438,119,4.438]],["title/49",[11,3.766,35,1.605]],["description/49",[3,0.22,4,0.414,119,4.438,120,4.952]],["title/50",[35,1.134,121,3.525,122,5.06,123,3.308]],["description/50",[3,0.22,4,0.414,118,4.438,124,4.952]],["title/51",[35,1.033,125,3.879,126,3.879,127,3.879,128,3.879,129,3.879]],["description/51",[130,7.116]],["title/52",[35,1.605,131,5.4]],["description/52",[132,7.116]],["title/53",[7,2.854,108,3.474,133,3.314,134,3.907]],["description/53",[3,0.22,38,1.769,135,3.095,136,4.952]],["title/54",[11,2.95,108,3.474,133,3.314,134,3.907]],["description/54",[3,0.22,38,1.769,135,3.095,137,4.952]],["title/55",[53,2.99,108,3.134,133,2.99,138,3.134,139,3.308]],["description/55",[3,0.183,16,2.771,38,1.471,135,2.573,138,3.03,140,4.117]],["title/56",[141,5.4,142,6.025]],["description/56",[3,0.245,38,1.968,143,5.51]],["title/57",[108,3.896,133,3.716,138,3.896]],["description/57",[3,0.245,38,1.968,144,5.51]],["title/58",[145,5.293,146,1.672,147,4.382]],["description/58",[3,0.22,38,1.769,148,4.952,149,4.952]],["title/59",[150,5.432]],["description/59",[2,2.687,150,4.825]],["title/60",[35,1.257,54,1.863,150,3.666,151,4.719]],["description/60",[152,7.116]],["title/61",[153,5.432]],["description/61",[2,2.384,153,4.281,154,4.281]],["title/62",[153,4.681,154,4.681]],["description/62",[3,0.22,4,0.414,155,4.952,156,4.952]],["title/63",[153,4.112,154,4.112,157,5.293]],["description/63",[158,7.116]],["title/64",[147,5.789]],["description/64",[2,2.687,147,5.142]],["title/65",[46,2.381,159,4.382,160,4.382]],["description/65",[161,7.116]],["title/66",[46,2.381,160,4.382,162,4.382]],["description/66",[163,7.116]],["title/67",[46,2.381,160,4.382,164,5.293]],["description/67",[165,7.116]],["title/68",[154,3.308,166,4.258,167,3.816,168,4.258,169,4.258]],["description/68",[170,7.116]],["title/69",[171,5.293,172,4.744,173,5.293]],["description/69",[174,7.116]],["title/70",[175,3.871]],["description/70",[2,2.687,175,3.439]],["title/71",[19,3.476,35,1.033,146,1.225,175,3.162,176,2.855]],["description/71",[3,0.22,4,0.414,177,4.952,178,4.952]],["title/72",[35,0.949,146,1.693,175,2.968,176,2.622,179,3.192]],["description/72",[3,0.22,4,0.414,180,4.952,181,4.952]],["title/73",[35,0.949,146,1.693,175,2.968,176,2.622,182,3.562]],["description/73",[3,0.22,4,0.414,183,4.952,184,4.952]],["title/74",[21,3.211,35,1.033,146,1.225,175,3.162,176,2.855]],["description/74",[3,0.22,4,0.414,185,4.952,186,4.952]],["title/75",[35,1.257,92,2.544,175,2.613,176,3.474]],["description/75",[3,0.22,4,0.414,187,4.952,188,4.952]],["title/76",[35,1.41,162,4.382,175,2.93]],["description/76",[3,0.22,4,0.414,189,4.952,190,4.952]],["title/77",[98,2.512,191,3.476,192,3.211,193,3.476,194,3.476,195,3.476]],["description/77",[3,0.22,4,0.414,196,4.952,197,4.952]],["title/78",[35,0.949,98,2.307,192,2.949,194,3.192,195,3.192,198,3.192,199,3.562]],["description/78",[3,0.22,4,0.414,200,4.952,201,4.952]],["title/79",[35,1.134,191,3.816,192,3.525,202,3.525,203,3.134]],["description/79",[3,0.22,4,0.414,204,4.952,205,4.952]],["title/80",[35,1.257,179,4.23,206,4.23,207,4.719]],["description/80",[3,0.22,4,0.414,208,4.952,209,4.952]],["title/81",[67,3.474,121,3.907,175,2.613,210,4.23]],["description/81",[3,0.146,35,0.875,38,1.174,56,2.307,135,2.054,211,2.72,212,2.552,213,1.155,214,3.286]],["title/82",[53,3.314,54,1.863,175,2.613,215,4.719]],["description/82",[3,0.146,35,0.875,38,1.174,56,2.307,135,2.054,211,2.72,212,2.552,213,1.155,216,3.286]],["title/83",[67,3.474,175,2.613,210,4.23,217,4.719]],["description/83",[3,0.146,35,0.875,38,1.174,56,2.307,135,2.054,211,2.72,212,2.552,213,1.155,218,3.286]],["title/84",[146,2.209]],["description/84",[2,2.687,146,1.962]],["title/85",[43,4.382,146,1.672,219,4.744]],["description/85",[3,0.22,38,1.769,220,2.321,221,4.952]],["title/86",[7,3.643,222,5.4]],["description/86",[3,0.22,38,1.769,220,2.321,223,4.952]],["title/87",[222,5.4,224,5.4]],["description/87",[3,0.22,38,1.769,220,2.321,225,4.952]],["title/88",[146,1.904,226,5.4]],["description/88",[3,0.22,38,1.769,220,2.321,227,4.952]],["title/89",[146,1.672,226,4.744,228,2.782]],["description/89",[3,0.22,38,1.769,220,2.321,229,4.952]],["title/90",[146,1.672,230,3.896,231,3.013]],["description/90",[3,0.22,38,1.769,220,2.321,232,4.952]],["title/91",[54,1.681,146,1.345,228,2.238,230,3.134,233,4.258]],["description/91",[3,0.22,38,1.769,220,2.321,234,4.952]],["title/92",[85,2.26,146,1.904]],["description/92",[3,0.22,38,1.769,220,2.321,235,4.952]],["title/93",[85,2.26,236,4.988]],["description/93",[3,0.22,38,1.769,220,2.321,237,4.952]],["title/94",[85,1.77,146,1.491,159,3.907,238,3.474]],["description/94",[3,0.22,38,1.769,220,2.321,239,4.952]],["title/95",[85,2.26,240,4.988]],["description/95",[3,0.22,38,1.769,220,2.321,241,4.952]],["title/96",[85,1.986,236,4.382,242,5.293]],["description/96",[3,0.22,38,1.769,220,2.321,243,4.952]],["title/97",[54,1.406,85,1.336,146,1.125,228,1.872,240,2.949,244,3.562,245,3.562]],["description/97",[3,0.22,38,1.769,220,2.321,246,4.952]],["title/98",[85,1.986,146,1.672,247,5.293]],["description/98",[3,0.22,38,1.769,220,2.321,248,4.952]],["title/99",[85,1.597,146,1.345,159,3.525,167,3.816,249,4.258]],["description/99",[3,0.22,38,1.769,220,2.321,250,4.952]],["title/100",[146,1.904,251,4.435]],["description/100",[3,0.066,38,0.531,97,1.154,98,0.962,146,0.826,219,1.332,252,1.486,253,1.486,254,1.486,255,2.613,256,1.835,257,1.486,258,1.486,259,1.486,260,1.486,261,1.486,262,1.332,263,1.486,264,1.486,265,1.486,266,1.486,267,1.486,268,1.094,269,1.486]],["title/101",[7,2.154,86,2.622,92,1.92,146,1.125,230,2.622,270,3.562,271,3.562]],["description/101",[3,0.2,4,0.376,7,2.719,146,1.42,272,4.496]],["title/102",[11,3.231,54,0.998,85,1.538,92,2.21,273,2.093,274,1.637,275,2.528,276,2.528]],["description/102",[3,0.22,4,0.414,277,2.48,278,4.952]],["title/103",[11,3.766,146,1.904]],["description/103",[3,0.22,4,0.414,279,4.952,280,4.952]],["title/104",[146,1.904,224,5.4]],["description/104",[3,0.22,4,0.414,281,4.438,282,4.952]],["title/105",[54,1.681,85,1.597,92,2.296,228,2.238,273,3.525]],["description/105",[2,1.253,3,0.129,4,0.242,35,0.772,256,2.033,283,2.25,284,2.896,285,2.596,286,2.896,287,2.596,288,2.896]],["title/106",[54,1.681,85,1.597,92,2.296,228,2.238,273,3.525]],["description/106",[3,0.183,4,0.344,16,2.771,35,1.097,283,3.198,289,4.117]],["title/107",[53,3.314,139,3.666,146,1.491,228,2.48]],["description/107",[3,0.22,4,0.414,277,2.48,290,4.952]],["title/108",[54,1.681,85,2.293,228,2.238,291,3.816]],["description/108",[3,0.22,4,0.414,283,3.846,292,4.952]],["title/109",[54,1.681,85,2.293,92,2.296,228,2.238]],["description/109",[3,0.183,4,0.344,16,2.771,35,1.097,283,3.198,293,4.117]],["title/110",[54,1.863,228,2.48,294,4.719,295,4.719]],["description/110",[296,7.116]],["title/111",[82,1.978,85,0.896,146,1.237,228,1.256,240,1.978,256,1.678,297,2.389,298,1.978,299,2.141,300,2.389,301,2.389,302,2.389]],["description/111",[3,0.22,4,0.414,251,3.645,303,4.952]],["title/112",[54,1.681,85,1.597,131,3.816,304,4.258,305,3.525]],["description/112",[3,0.22,4,0.414,251,3.645,306,4.952]],["title/113",[85,1.986,122,4.382,228,2.782]],["description/113",[3,0.22,4,0.414,281,4.438,307,4.952]],["title/114",[85,1.986,121,4.382,228,2.782]],["description/114",[3,0.183,4,0.344,122,3.408,308,4.117,309,4.117,310,4.117]],["title/115",[14,3.896,146,1.672,202,4.382]],["description/115",[3,0.22,4,0.414,277,2.48,311,4.952]],["title/116",[85,1.986,146,1.672,238,3.896]],["description/116",[3,0.22,4,0.414,277,2.48,312,4.952]],["title/117",[231,3.981]],["description/117",[2,2.687,231,3.536]],["title/118",[35,1.134,146,1.345,231,3.48,305,3.525]],["description/118",[3,0.22,4,0.414,313,4.099,314,4.952]],["title/119",[35,1.257,146,1.491,231,2.687,251,3.474]],["description/119",[3,0.22,4,0.414,315,3.846,316,4.952]],["title/120",[35,1.134,54,1.681,231,2.424,317,4.258,318,4.258]],["description/120",[3,0.22,4,0.414,315,3.846,319,4.952]],["title/121",[35,1.134,231,3.48,238,3.134,305,3.525]],["description/121",[3,0.22,4,0.414,313,4.099,320,4.952]],["title/122",[54,2.09,172,4.744,321,4.744]],["description/122",[3,0.22,4,0.414,277,2.48,322,4.952]],["title/123",[54,1.681,146,1.345,230,3.134,323,3.308,324,4.258]],["description/123",[3,0.22,4,0.414,277,2.48,325,4.952]],["title/124",[54,1.406,139,2.767,146,1.125,230,2.622,262,3.192,326,3.562,327,3.562]],["description/124",[3,0.22,4,0.414,277,2.48,328,4.952]],["title/125",[11,2.661,54,1.681,98,2.758,321,3.816,329,4.258]],["description/125",[3,0.22,4,0.414,315,3.846,330,4.952]],["title/126",[331,3.981]],["description/126",[2,2.687,331,3.536]],["title/127",[54,2.09,98,3.428,331,3.013]],["description/127",[332,7.116]],["title/128",[35,1.257,54,1.863,231,2.687,331,2.687]],["description/128",[3,0.2,4,0.376,16,3.026,35,1.198,333,4.496]],["title/129",[35,1.033,54,1.531,146,1.225,231,2.208,251,2.855,331,2.208]],["description/129",[3,0.183,4,0.344,16,2.771,35,1.097,315,3.198,334,4.117]],["title/130",[35,1.033,54,1.531,331,2.208,335,3.879,336,3.879,337,3.879]],["description/130",[338,7.116]],["title/131",[274,4.529]],["description/131",[2,2.687,274,4.022]],["title/132",[85,1.986,146,1.672,274,3.428]],["description/132",[3,0.22,38,1.769,220,2.321,339,4.952]],["title/133",[274,3.902,340,6.025]],["description/133",[3,0.22,38,1.769,220,2.321,341,4.952]],["title/134",[54,1.681,92,2.296,146,1.345,228,2.238,274,2.758]],["description/134",[3,0.22,4,0.414,277,2.48,342,4.952]],["title/135",[114,4.706]],["description/135",[2,2.687,114,4.18]],["title/136",[114,3.176,150,3.666,331,2.687,343,4.719]],["description/136",[344,7.116]],["title/137",[35,1.033,54,1.531,92,2.091,114,2.611,331,2.208,345,3.476]],["description/137",[3,0.22,4,0.414,346,4.952,347,4.438]],["title/138",[35,1.134,54,1.681,114,2.866,331,2.424,345,3.816]],["description/138",[3,0.22,4,0.414,347,4.438,348,4.438]],["title/139",[35,1.134,54,1.681,67,3.134,299,3.816,331,2.424]],["description/139",[3,0.22,4,0.414,348,4.438,349,4.952]],["title/140",[21,3.525,35,1.134,54,1.681,114,2.866,331,2.424]],["description/140",[3,0.22,4,0.414,350,4.438,351,4.952]],["title/141",[85,1.77,92,2.544,274,3.056,331,2.687]],["description/141",[3,0.22,4,0.414,350,4.438,352,4.952]],["title/142",[353,5.432]],["description/142",[2,2.687,353,4.825]],["title/143",[85,1.77,92,2.544,353,3.666,354,3.666]],["description/143",[3,0.22,4,0.414,355,4.952,356,4.952]],["title/144",[97,3.666,98,3.056,353,3.666,354,3.666]],["description/144",[3,0.22,4,0.414,357,4.952,358,4.952]],["title/145",[213,2.458]],["description/145",[2,2.687,213,2.184]],["title/146",[14,2.855,175,2.147,202,4.729,212,3.013,213,1.364]],["description/146",[3,0.157,4,0.295,35,0.939,38,1.258,135,3.323,359,3.523,360,3.523]],["title/147",[133,2.99,138,3.134,213,1.497,361,4.258,362,3.816]],["description/147",[3,0.183,35,1.097,38,1.471,135,3.729,363,4.117]],["title/148",[133,2.99,138,3.134,213,1.497,362,3.816,364,4.258]],["description/148",[3,0.183,35,1.097,38,1.471,135,3.729,365,4.117]],["title/149",[134,3.211,213,1.364,298,3.211,366,3.879,367,3.879,368,3.476]],["description/149",[3,0.22,4,0.414,213,1.741,369,4.952]],["title/150",[92,2.544,213,1.659,370,2.544,371,4.719]],["description/150",[3,0.22,4,0.414,372,4.438,373,4.438]],["title/151",[291,5.4,370,3.248]],["description/151",[3,0.22,4,0.414,372,4.438,373,4.438]],["title/152",[206,4.744,213,1.861,370,2.854]],["description/152",[3,0.22,4,0.414,374,4.952,375,4.952]],["title/153",[35,1.41,162,4.382,213,1.861]],["description/153",[3,0.22,4,0.414,376,4.952,377,4.952]],["title/154",[35,1.41,213,1.861,238,3.896]],["description/154",[2,1.421,3,0.146,4,0.275,213,1.155,256,2.307,285,2.945,287,2.945,378,2.945,379,3.286]],["title/155",[35,1.257,86,3.474,213,1.659,298,3.907]],["description/155",[3,0.22,4,0.414,213,1.741,380,4.952]],["title/156",[35,1.257,53,3.314,213,1.659,381,4.719]],["description/156",[3,0.22,4,0.414,277,2.48,382,4.952]],["title/157",[383,6.267]],["description/157",[2,2.687,383,5.567]],["title/158",[384,5.293,385,5.293,386,5.293]],["description/158",[3,0.22,4,0.414,387,4.952,388,4.952]],["title/159",[22,1.863,46,2.123,80,3.474,139,3.666]],["description/159",[3,0.22,4,0.414,389,3.846,390,4.438]],["title/160",[7,2.345,22,1.531,36,2.855,46,1.745,80,2.855,391,3.879]],["description/160",[3,0.22,4,0.414,389,3.846,390,4.438]],["title/161",[9,2.866,22,1.681,36,3.134,46,1.915,80,3.134]],["description/161",[3,0.22,4,0.414,389,3.846,392,4.438]],["title/162",[11,2.661,22,1.681,36,3.134,46,1.915,80,3.134]],["description/162",[3,0.22,4,0.414,389,3.846,392,4.438]],["title/163",[35,1.206,198,2.563,203,2.105,231,1.628,256,2.008,323,2.222,393,2.86,394,2.86,395,2.86]],["description/163",[3,0.22,4,0.414,48,2.539,396,4.952]],["title/164",[397,6.267]],["description/164",[2,2.687,397,5.567]],["title/165",[22,2.379,88,4.988]],["description/165",[3,0.22,4,0.414,398,3.333,399,4.952]],["title/166",[46,2.381,88,4.382,400,5.293]],["description/166",[3,0.22,4,0.414,398,3.333,401,4.952]],["title/167",[213,1.659,370,2.544,402,4.23,403,3.666]],["description/167",[3,0.22,4,0.414,398,3.333,404,4.952]],["title/168",[85,1.597,146,1.345,370,2.296,402,3.816,403,3.308]],["description/168",[3,0.22,4,0.414,398,3.333,405,4.952]],["title/169",[35,1.41,85,1.986,406,5.293]],["description/169",[3,0.22,4,0.414,277,2.48,407,4.952]],["title/170",[85,1.986,213,1.861,408,4.382]],["description/170",[3,0.22,4,0.414,277,2.48,409,4.952]],["title/171",[85,1.77,146,1.491,370,2.544,408,3.907]],["description/171",[3,0.22,4,0.414,277,2.48,410,4.952]],["title/172",[213,1.861,238,3.896,370,2.854]],["description/172",[3,0.22,4,0.414,277,2.48,378,4.438]],["title/173",[85,1.77,146,1.491,213,1.659,370,2.544]],["description/173",[3,0.22,4,0.414,277,2.48,411,4.952]],["title/174",[213,2.118,412,6.025]],["description/174",[3,0.22,4,0.414,277,2.48,413,4.952]],["title/175",[146,1.904,414,5.4]],["description/175",[3,0.22,4,0.414,398,3.333,415,4.438]],["title/176",[146,1.904,414,5.4]],["description/176",[3,0.22,4,0.414,398,3.333,415,4.438]],["title/177",[416,3.981]],["description/177",[2,2.687,416,3.536]],["title/178",[35,1.257,85,1.77,123,3.666,416,2.687]],["description/178",[3,0.22,4,0.414,417,4.952,418,4.438]],["title/179",[35,1.134,85,1.597,123,3.308,203,3.134,416,2.424]],["description/179",[3,0.22,4,0.414,418,4.438,419,4.438]],["title/180",[35,0.949,85,1.336,123,2.767,203,2.622,256,2.501,416,2.027,420,3.562]],["description/180",[3,0.22,4,0.414,419,4.438,421,4.952]],["title/181",[228,2.782,416,3.013,422,5.293]],["description/181",[3,0.22,4,0.414,277,2.48,423,4.952]],["title/182",[146,1.672,213,1.861,268,3.896]],["description/182",[3,0.22,4,0.414,398,3.333,424,4.952]],["title/183",[146,1.904,213,2.118]],["description/183",[3,0.22,4,0.414,213,1.741,425,4.952]],["title/184",[213,1.659,268,3.474,403,3.666,426,4.23]],["description/184",[3,0.22,4,0.414,213,1.741,427,4.952]],["title/185",[141,4.23,213,1.659,268,3.474,426,4.23]],["description/185",[3,0.22,4,0.414,213,1.741,428,4.952]],["title/186",[92,2.091,236,3.211,370,2.091,408,3.211,416,2.208,429,3.879]],["description/186",[3,0.2,4,0.376,213,1.581,430,3.309,431,3.722]],["title/187",[7,3.201,370,2.854,416,3.013]],["description/187",[3,0.2,4,0.376,213,1.581,430,3.309,431,3.722]],["title/188",[9,3.562,370,2.854,416,3.013]],["description/188",[3,0.2,4,0.376,213,1.581,430,3.309,431,3.722]],["title/189",[14,3.896,370,2.854,416,3.013]],["description/189",[3,0.2,4,0.376,213,1.581,430,3.309,432,4.496]],["title/190",[370,2.854,403,4.112,416,3.013]],["description/190",[3,0.22,4,0.414,213,1.741,433,4.952]],["title/191",[7,3.201,370,2.854,416,3.013]],["description/191",[3,0.2,4,0.376,213,1.581,430,3.309,434,4.496]],["title/192",[435,5.432]],["description/192",[2,2.384,231,3.137,435,4.281]],["title/193",[231,2.687,435,3.666,436,4.23,437,4.23]],["description/193",[3,0.2,4,0.376,438,4.496,439,4.029,440,4.496]],["title/194",[9,3.176,435,3.666,436,4.23,437,4.23]],["description/194",[3,0.22,4,0.414,439,4.438,441,4.952]],["title/195",[354,5.432]],["description/195",[2,2.687,354,4.825]],["title/196",[86,4.435,442,6.025]],["description/196",[3,0.22,38,1.769,220,2.321,443,4.952]],["title/197",[444,6.993]],["description/197",[]],["title/198",[368,4.744,445,5.293,446,5.293]],["description/198",[3,0.22,38,1.769,220,2.321,447,4.952]],["title/199",[323,5.432]],["description/199",[]],["title/200",[146,1.491,175,2.613,323,3.666,448,4.719]],["description/200",[3,0.22,38,1.769,220,2.321,449,4.952]],["title/201",[450,6.267]],["description/201",[]],["title/202",[35,1.41,450,4.744,451,5.293]],["description/202",[3,0.084,4,0.158,193,1.692,203,1.39,268,2.367,313,1.563,452,1.888,453,1.888,454,1.888,455,1.888,456,1.888,457,1.888,458,1.888,459,1.888,460,1.888,461,1.888,462,1.888,463,1.888,464,1.888]],["title/203",[465,6.993]],["description/203",[]],["title/204",[54,1.531,85,1.455,92,2.091,146,1.225,228,2.039,274,2.512]],["description/204",[3,0.22,4,0.414,277,2.48,466,4.952]]],"invertedIndex":[["",{"_index":64,"title":{},"description":{"28":{}}}],["accept",{"_index":193,"title":{"77":{}},"description":{"202":{}}}],["access",{"_index":36,"title":{"17":{},"22":{},"160":{},"161":{},"162":{}},"description":{}}],["action",{"_index":127,"title":{"51":{}},"description":{}}],["activ",{"_index":88,"title":{"37":{},"165":{},"166":{}},"description":{}}],["add",{"_index":19,"title":{"7":{},"71":{}},"description":{}}],["add_remot",{"_index":177,"title":{},"description":{"71":{}}}],["admin",{"_index":135,"title":{},"description":{"53":{},"54":{},"55":{},"81":{},"82":{},"83":{},"146":{},"147":{},"148":{}}}],["affect",{"_index":422,"title":{"181":{}},"description":{}}],["allow",{"_index":233,"title":{"91":{}},"description":{}}],["anonym",{"_index":44,"title":{},"description":{"20":{},"33":{},"34":{}}}],["answer",{"_index":461,"title":{},"description":{"202":{}}}],["api/1/services/api/1/content/change-content-type.json",{"_index":221,"title":{},"description":{"85":{}}}],["api/1/services/api/1/content/create-folder.json",{"_index":223,"title":{},"description":{"86":{}}}],["api/1/services/api/1/content/get-content-at-path.json",{"_index":229,"title":{},"description":{"89":{}}}],["api/1/services/api/1/content/get-content-type.json",{"_index":232,"title":{},"description":{"90":{}}}],["api/1/services/api/1/content/get-content-types.json",{"_index":234,"title":{},"description":{"91":{}}}],["api/1/services/api/1/content/get-content.json",{"_index":227,"title":{},"description":{"88":{}}}],["api/1/services/api/1/content/get-item-orders.json",{"_index":237,"title":{},"description":{"93":{}}}],["api/1/services/api/1/content/get-item-versions.json",{"_index":239,"title":{},"description":{"94":{}}}],["api/1/services/api/1/content/get-item.json",{"_index":235,"title":{},"description":{"92":{}}}],["api/1/services/api/1/content/get-items-tree.json",{"_index":241,"title":{},"description":{"95":{}}}],["api/1/services/api/1/content/get-next-item-order.json",{"_index":243,"title":{},"description":{"96":{}}}],["api/1/services/api/1/content/get-pages.json",{"_index":246,"title":{},"description":{"97":{}}}],["api/1/services/api/1/content/rename-folder.json",{"_index":225,"title":{},"description":{"87":{}}}],["api/1/services/api/1/content/reorder-items.json",{"_index":248,"title":{},"description":{"98":{}}}],["api/1/services/api/1/content/revert-content.json",{"_index":250,"title":{},"description":{"99":{}}}],["api/1/services/api/1/content/write-content.json",{"_index":269,"title":{},"description":{"100":{}}}],["api/1/services/api/1/dependency/get-dependant.json",{"_index":339,"title":{},"description":{"132":{}}}],["api/1/services/api/1/dependency/get-simple-dependencies.json",{"_index":341,"title":{},"description":{"133":{}}}],["api/1/services/api/1/deployment/bulk-golive.json",{"_index":447,"title":{},"description":{"198":{}}}],["api/1/services/api/1/preview/sync-site.json",{"_index":449,"title":{},"description":{"200":{}}}],["api/1/services/api/1/publish/commits.json",{"_index":360,"title":{},"description":{"146":{}}}],["api/1/services/api/1/publish/start.json",{"_index":363,"title":{},"description":{"147":{}}}],["api/1/services/api/1/publish/stop.json",{"_index":365,"title":{},"description":{"148":{}}}],["api/1/services/api/1/server/get-available-languages.json",{"_index":443,"title":{},"description":{"196":{}}}],["api/1/services/api/1/site/create.json",{"_index":136,"title":{},"description":{"53":{}}}],["api/1/services/api/1/site/delete-site.json",{"_index":137,"title":{},"description":{"54":{}}}],["api/1/services/api/1/site/exists.json",{"_index":140,"title":{},"description":{"55":{}}}],["api/1/services/api/1/site/get-canned-message.json",{"_index":143,"title":{},"description":{"56":{}}}],["api/1/services/api/1/site/get.json",{"_index":144,"title":{},"description":{"57":{}}}],["api/1/services/api/1/site/monitor-content.json",{"_index":149,"title":{},"description":{"58":{}}}],["api/2/audit",{"_index":156,"title":{},"description":{"62":{}}}],["api/2/audit/{id",{"_index":158,"title":{},"description":{"63":{}}}],["api/2/aws/mediaconvert/upload",{"_index":104,"title":{},"description":{"41":{}}}],["api/2/aws/s3/list",{"_index":96,"title":{},"description":{"39":{}}}],["api/2/aws/s3/upload",{"_index":100,"title":{},"description":{"40":{}}}],["api/2/clust",{"_index":107,"title":{},"description":{"43":{}}}],["api/2/cluster/mod",{"_index":111,"title":{},"description":{"44":{}}}],["api/2/configuration/clear_cach",{"_index":319,"title":{},"description":{"120":{}}}],["api/2/configuration/content-type/delet",{"_index":330,"title":{},"description":{"125":{}}}],["api/2/configuration/content-type/form_control",{"_index":328,"title":{},"description":{"124":{}}}],["api/2/configuration/content-type/preview_imag",{"_index":325,"title":{},"description":{"123":{}}}],["api/2/configuration/content-type/usag",{"_index":322,"title":{},"description":{"122":{}}}],["api/2/configuration/get_configur",{"_index":314,"title":{},"description":{"118":{}}}],["api/2/configuration/get_configuration_histori",{"_index":320,"title":{},"description":{"121":{}}}],["api/2/configuration/write_configur",{"_index":316,"title":{},"description":{"119":{}}}],["api/2/content/children_by_path",{"_index":288,"title":{},"description":{"105":{}}}],["api/2/content/delet",{"_index":280,"title":{},"description":{"103":{}}}],["api/2/content/descriptor",{"_index":296,"title":{},"description":{"110":{}}}],["api/2/content/dupl",{"_index":306,"title":{},"description":{"112":{}}}],["api/2/content/exist",{"_index":290,"title":{},"description":{"107":{}}}],["api/2/content/get_content_by_commit_id",{"_index":311,"title":{},"description":{"115":{}}}],["api/2/content/get_delete_packag",{"_index":278,"title":{},"description":{"102":{}}}],["api/2/content/item_by_path",{"_index":292,"title":{},"description":{"108":{}}}],["api/2/content/item_histori",{"_index":312,"title":{},"description":{"116":{}}}],["api/2/content/item_lock_by_path",{"_index":307,"title":{},"description":{"113":{}}}],["api/2/content/item_unlock_by_path",{"_index":310,"title":{},"description":{"114":{}}}],["api/2/content/list_quick_create_cont",{"_index":272,"title":{},"description":{"101":{}}}],["api/2/content/past",{"_index":303,"title":{},"description":{"111":{}}}],["api/2/content/renam",{"_index":282,"title":{},"description":{"104":{}}}],["api/2/content/sandbox_items_by_path",{"_index":293,"title":{},"description":{"109":{}}}],["api/2/content/{siteid}/children",{"_index":289,"title":{},"description":{"106":{}}}],["api/2/dashboard/act",{"_index":399,"title":{},"description":{"165":{}}}],["api/2/dashboard/activity/m",{"_index":401,"title":{},"description":{"166":{}}}],["api/2/dashboard/content/expir",{"_index":415,"title":{},"description":{"175":{},"176":{}}}],["api/2/dashboard/content/pending_approv",{"_index":404,"title":{},"description":{"167":{}}}],["api/2/dashboard/content/pending_approval/{id",{"_index":405,"title":{},"description":{"168":{}}}],["api/2/dashboard/content/unpublish",{"_index":407,"title":{},"description":{"169":{}}}],["api/2/dashboard/publishing/histori",{"_index":378,"title":{},"description":{"154":{},"172":{}}}],["api/2/dashboard/publishing/history/{id",{"_index":411,"title":{},"description":{"173":{}}}],["api/2/dashboard/publishing/schedul",{"_index":409,"title":{},"description":{"170":{}}}],["api/2/dashboard/publishing/scheduled/{id",{"_index":410,"title":{},"description":{"171":{}}}],["api/2/dashboard/publishing/stat",{"_index":413,"title":{},"description":{"174":{}}}],["api/2/dependency/depend",{"_index":342,"title":{},"description":{"134":{}}}],["api/2/dependency/dependent_item",{"_index":466,"title":{},"description":{"204":{}}}],["api/2/group",{"_index":6,"title":{},"description":{"1":{},"2":{},"3":{},"4":{}}}],["api/2/groups/{id",{"_index":15,"title":{},"description":{"5":{}}}],["api/2/groups/{id}/memb",{"_index":18,"title":{},"description":{"6":{},"7":{},"8":{}}}],["api/2/logg",{"_index":440,"title":{},"description":{"193":{}}}],["api/2/loggers/logger_level",{"_index":441,"title":{},"description":{"194":{}}}],["api/2/marketplace/copi",{"_index":349,"title":{},"description":{"139":{}}}],["api/2/marketplace/instal",{"_index":347,"title":{},"description":{"137":{},"138":{}}}],["api/2/marketplace/remov",{"_index":351,"title":{},"description":{"140":{}}}],["api/2/marketplace/search",{"_index":344,"title":{},"description":{"136":{}}}],["api/2/marketplace/usag",{"_index":352,"title":{},"description":{"141":{}}}],["api/2/model/{siteid}/definit",{"_index":464,"title":{},"description":{"202":{}}}],["api/2/monitoring/disk",{"_index":174,"title":{},"description":{"69":{}}}],["api/2/monitoring/log",{"_index":170,"title":{},"description":{"68":{}}}],["api/2/monitoring/memori",{"_index":165,"title":{},"description":{"67":{}}}],["api/2/monitoring/statu",{"_index":163,"title":{},"description":{"66":{}}}],["api/2/monitoring/vers",{"_index":161,"title":{},"description":{"65":{}}}],["api/2/plugin/fil",{"_index":332,"title":{},"description":{"127":{}}}],["api/2/plugin/get_configur",{"_index":333,"title":{},"description":{"128":{}}}],["api/2/plugin/script/reload",{"_index":338,"title":{},"description":{"130":{}}}],["api/2/plugin/write_configur",{"_index":334,"title":{},"description":{"129":{}}}],["api/2/publish/al",{"_index":369,"title":{},"description":{"149":{}}}],["api/2/publish/available_target",{"_index":380,"title":{},"description":{"155":{}}}],["api/2/publish/cancel",{"_index":375,"title":{},"description":{"152":{}}}],["api/2/publish/has_initial_publish",{"_index":382,"title":{},"description":{"156":{}}}],["api/2/publish/histori",{"_index":379,"title":{},"description":{"154":{}}}],["api/2/publish/packag",{"_index":373,"title":{},"description":{"150":{},"151":{}}}],["api/2/publish/statu",{"_index":377,"title":{},"description":{"153":{}}}],["api/2/repository/add_remot",{"_index":178,"title":{},"description":{"71":{}}}],["api/2/repository/cancel_failed_pul",{"_index":209,"title":{},"description":{"80":{}}}],["api/2/repository/commit_resolut",{"_index":205,"title":{},"description":{"79":{}}}],["api/2/repository/corrupt",{"_index":216,"title":{},"description":{"82":{}}}],["api/2/repository/diff_conflicted_fil",{"_index":201,"title":{},"description":{"78":{}}}],["api/2/repository/list_remot",{"_index":188,"title":{},"description":{"75":{}}}],["api/2/repository/pull_from_remot",{"_index":181,"title":{},"description":{"72":{}}}],["api/2/repository/push_to_remot",{"_index":184,"title":{},"description":{"73":{}}}],["api/2/repository/remove_remot",{"_index":186,"title":{},"description":{"74":{}}}],["api/2/repository/repair",{"_index":218,"title":{},"description":{"83":{}}}],["api/2/repository/resolve_conflict",{"_index":197,"title":{},"description":{"77":{}}}],["api/2/repository/statu",{"_index":190,"title":{},"description":{"76":{}}}],["api/2/repository/unlock",{"_index":214,"title":{},"description":{"81":{}}}],["api/2/search/search",{"_index":152,"title":{},"description":{"60":{}}}],["api/2/security/encrypt",{"_index":388,"title":{},"description":{"158":{}}}],["api/2/security/preview/switch",{"_index":396,"title":{},"description":{"163":{}}}],["api/2/security/token",{"_index":390,"title":{},"description":{"159":{},"160":{}}}],["api/2/security/tokens/{id",{"_index":392,"title":{},"description":{"161":{},"162":{}}}],["api/2/sites/available_blueprint",{"_index":113,"title":{},"description":{"46":{}}}],["api/2/sites/create_site_from_marketplac",{"_index":115,"title":{},"description":{"47":{}}}],["api/2/sites/{siteid",{"_index":119,"title":{},"description":{"48":{},"49":{}}}],["api/2/sites/{siteid}/dupl",{"_index":132,"title":{},"description":{"52":{}}}],["api/2/sites/{siteid}/policy/valid",{"_index":130,"title":{},"description":{"51":{}}}],["api/2/sites/{siteid}/unlock",{"_index":124,"title":{},"description":{"50":{}}}],["api/2/ui/system/active_environ",{"_index":90,"title":{},"description":{"37":{}}}],["api/2/ui/views/global_menu",{"_index":87,"title":{},"description":{"36":{}}}],["api/2/us",{"_index":24,"title":{},"description":{"10":{},"11":{},"12":{},"13":{}}}],["api/2/users/dis",{"_index":34,"title":{},"description":{"16":{}}}],["api/2/users/en",{"_index":32,"title":{},"description":{"15":{}}}],["api/2/users/forgot_password",{"_index":78,"title":{},"description":{"33":{}}}],["api/2/users/m",{"_index":49,"title":{},"description":{"21":{}}}],["api/2/users/me/change_password",{"_index":73,"title":{},"description":{"29":{}}}],["api/2/users/me/global/has_permiss",{"_index":58,"title":{},"description":{"27":{}}}],["api/2/users/me/global/permiss",{"_index":57,"title":{},"description":{"26":{}}}],["api/2/users/me/logout/sso/url",{"_index":72,"title":{},"description":{"28":{}}}],["api/2/users/me/properti",{"_index":76,"title":{},"description":{"30":{},"31":{},"32":{}}}],["api/2/users/me/sit",{"_index":50,"title":{},"description":{"22":{}}}],["api/2/users/me/sites/{site}/has_permiss",{"_index":55,"title":{},"description":{"25":{}}}],["api/2/users/me/sites/{site}/permiss",{"_index":52,"title":{},"description":{"24":{}}}],["api/2/users/me/sites/{site}/rol",{"_index":51,"title":{},"description":{"23":{}}}],["api/2/users/set_password",{"_index":45,"title":{},"description":{"20":{}}}],["api/2/users/validate_token",{"_index":81,"title":{},"description":{"34":{}}}],["api/2/users/{id",{"_index":30,"title":{},"description":{"14":{}}}],["api/2/users/{id}/reset_password",{"_index":42,"title":{},"description":{"19":{}}}],["api/2/users/{id}/sit",{"_index":37,"title":{},"description":{"17":{}}}],["api/2/users/{id}/sites/{site}/rol",{"_index":39,"title":{},"description":{"18":{}}}],["api/2/webdav/list",{"_index":356,"title":{},"description":{"143":{}}}],["api/2/webdav/upload",{"_index":358,"title":{},"description":{"144":{}}}],["api/2/workflow/affected_path",{"_index":423,"title":{},"description":{"181":{}}}],["api/2/workflow/approv",{"_index":427,"title":{},"description":{"184":{}}}],["api/2/workflow/item_st",{"_index":418,"title":{},"description":{"178":{},"179":{}}}],["api/2/workflow/packag",{"_index":431,"title":{},"description":{"186":{},"187":{},"188":{}}}],["api/2/workflow/packages/approv",{"_index":433,"title":{},"description":{"190":{}}}],["api/2/workflow/packages/reject",{"_index":434,"title":{},"description":{"191":{}}}],["api/2/workflow/packages/{id",{"_index":432,"title":{},"description":{"189":{}}}],["api/2/workflow/publish",{"_index":425,"title":{},"description":{"183":{}}}],["api/2/workflow/reject",{"_index":428,"title":{},"description":{"185":{}}}],["api/2/workflow/request_publish",{"_index":424,"title":{},"description":{"182":{}}}],["api/2/workflow/update_item_states_by_queri",{"_index":421,"title":{},"description":{"180":{}}}],["approv",{"_index":403,"title":{"167":{},"168":{},"184":{},"190":{}},"description":{}}],["argument",{"_index":455,"title":{},"description":{"202":{}}}],["asset",{"_index":261,"title":{},"description":{"100":{}}}],["audit",{"_index":153,"title":{"61":{},"62":{},"63":{}},"description":{"61":{}}}],["audit_log",{"_index":155,"title":{},"description":{"62":{}}}],["authent",{"_index":47,"title":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{}},"description":{"28":{}}}],["author",{"_index":252,"title":{},"description":{"100":{}}}],["avail",{"_index":86,"title":{"36":{},"46":{},"101":{},"155":{},"196":{}},"description":{}}],["aw",{"_index":91,"title":{"38":{}},"description":{"38":{}}}],["between",{"_index":199,"title":{"78":{}},"description":{}}],["blueprint",{"_index":112,"title":{"46":{},"47":{}},"description":{}}],["br/>in",{"_index":452,"title":{},"description":{"202":{}}}],["br><br",{"_index":253,"title":{},"description":{"100":{}}}],["broken",{"_index":275,"title":{"102":{}},"description":{}}],["bucket",{"_index":94,"title":{"39":{},"40":{},"41":{}},"description":{}}],["bulk",{"_index":445,"title":{"198":{}},"description":{}}],["cach",{"_index":318,"title":{"120":{}},"description":{}}],["cancel",{"_index":206,"title":{"80":{},"152":{}},"description":{}}],["cancel_failed_pul",{"_index":208,"title":{},"description":{"80":{}}}],["cancel_publish",{"_index":374,"title":{},"description":{"152":{}}}],["chang",{"_index":43,"title":{"20":{},"29":{},"85":{}},"description":{}}],["check",{"_index":53,"title":{"25":{},"27":{},"55":{},"82":{},"107":{},"156":{}},"description":{}}],["children",{"_index":273,"title":{"102":{},"105":{},"106":{}},"description":{}}],["class",{"_index":337,"title":{"130":{}},"description":{}}],["clear",{"_index":317,"title":{"120":{}},"description":{}}],["clipboard",{"_index":301,"title":{"111":{}},"description":{}}],["cluster",{"_index":105,"title":{"42":{},"43":{},"44":{}},"description":{"42":{}}}],["commit",{"_index":202,"title":{"79":{},"115":{},"146":{}},"description":{}}],["commit_resolut",{"_index":204,"title":{},"description":{"79":{}}}],["compat",{"_index":343,"title":{"136":{}},"description":{}}],["compliant",{"_index":128,"title":{"51":{}},"description":{}}],["configur",{"_index":231,"title":{"90":{},"117":{},"118":{},"119":{},"120":{},"121":{},"128":{},"129":{},"163":{},"193":{}},"description":{"117":{},"192":{}}}],["configure_log_level",{"_index":439,"title":{},"description":{"193":{},"194":{}}}],["conflict",{"_index":192,"title":{"77":{},"78":{},"79":{}},"description":{}}],["consequ",{"_index":459,"title":{},"description":{"202":{}}}],["content",{"_index":146,"title":{"58":{},"71":{},"72":{},"73":{},"74":{},"84":{},"85":{},"88":{},"89":{},"90":{},"91":{},"92":{},"94":{},"97":{},"98":{},"99":{},"100":{},"101":{},"103":{},"104":{},"107":{},"111":{},"115":{},"116":{},"118":{},"119":{},"123":{},"124":{},"129":{},"132":{},"134":{},"168":{},"171":{},"173":{},"175":{},"176":{},"182":{},"183":{},"200":{},"204":{}},"description":{"84":{},"100":{},"101":{}}}],["content-typ",{"_index":321,"title":{"122":{},"125":{}},"description":{}}],["content/{siteid}/children",{"_index":286,"title":{},"description":{"105":{}}}],["content_delet",{"_index":279,"title":{},"description":{"103":{}}}],["content_read",{"_index":277,"title":{},"description":{"102":{},"107":{},"115":{},"116":{},"122":{},"123":{},"124":{},"134":{},"156":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"181":{},"204":{}}}],["content_writ",{"_index":281,"title":{},"description":{"104":{},"113":{}}}],["control",{"_index":326,"title":{"124":{}},"description":{}}],["cooki",{"_index":395,"title":{"163":{}},"description":{}}],["copi",{"_index":299,"title":{"111":{},"139":{}},"description":{}}],["corrupt",{"_index":215,"title":{"82":{}},"description":{}}],["crafter",{"_index":133,"title":{"53":{},"54":{},"55":{},"57":{},"147":{},"148":{}},"description":{}}],["craftersit",{"_index":394,"title":{"163":{}},"description":{}}],["creat",{"_index":7,"title":{"2":{},"11":{},"47":{},"53":{},"86":{},"101":{},"160":{},"187":{},"191":{}},"description":{"101":{}}}],["create/edit",{"_index":257,"title":{},"description":{"100":{}}}],["create_group",{"_index":8,"title":{},"description":{"2":{}}}],["create_us",{"_index":25,"title":{},"description":{"11":{}}}],["css",{"_index":264,"title":{},"description":{"100":{}}}],["current",{"_index":46,"title":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"36":{},"37":{},"65":{},"66":{},"67":{},"159":{},"160":{},"161":{},"162":{},"166":{}},"description":{}}],["dashboard",{"_index":397,"title":{"164":{}},"description":{"164":{}}}],["date",{"_index":429,"title":{"186":{}},"description":{}}],["definit",{"_index":451,"title":{"202":{}},"description":{}}],["delet",{"_index":11,"title":{"4":{},"13":{},"32":{},"49":{},"54":{},"102":{},"103":{},"125":{},"162":{}},"description":{}}],["delete_group",{"_index":13,"title":{},"description":{"4":{},"8":{}}}],["delete_sit",{"_index":120,"title":{},"description":{"49":{}}}],["delete_us",{"_index":28,"title":{},"description":{"13":{}}}],["depend",{"_index":274,"title":{"102":{},"131":{},"132":{},"133":{},"134":{},"141":{},"204":{}},"description":{"131":{}}}],["dependent_item",{"_index":465,"title":{"203":{}},"description":{}}],["deploy",{"_index":444,"title":{"197":{}},"description":{}}],["deprec",{"_index":285,"title":{},"description":{"105":{},"154":{}}}],["descript",{"_index":117,"title":{"48":{}},"description":{}}],["descriptor",{"_index":295,"title":{"110":{}},"description":{}}],["detail",{"_index":291,"title":{"108":{},"151":{}},"description":{}}],["differ",{"_index":198,"title":{"78":{},"163":{}},"description":{}}],["disabl",{"_index":33,"title":{"16":{}},"description":{"28":{}}}],["disk",{"_index":171,"title":{"69":{}},"description":{}}],["duplic",{"_index":131,"title":{"52":{},"112":{}},"description":{}}],["edit_sit",{"_index":118,"title":{},"description":{"48":{},"50":{}}}],["enabl",{"_index":31,"title":{"15":{}},"description":{}}],["encrypt",{"_index":384,"title":{"158":{}},"description":{}}],["encryption_tool",{"_index":387,"title":{},"description":{"158":{}}}],["endpoint",{"_index":460,"title":{},"description":{"202":{}}}],["entir",{"_index":366,"title":{"149":{}},"description":{}}],["entiti",{"_index":69,"title":{},"description":{"28":{}}}],["entri",{"_index":157,"title":{"63":{}},"description":{}}],["environ",{"_index":89,"title":{"37":{}},"description":{}}],["event",{"_index":166,"title":{"68":{}},"description":{}}],["exist",{"_index":139,"title":{"55":{},"107":{},"124":{},"159":{}},"description":{}}],["expect",{"_index":393,"title":{"163":{}},"description":{}}],["expir",{"_index":414,"title":{"175":{},"176":{}},"description":{}}],["failed/conflict",{"_index":207,"title":{"80":{}},"description":{}}],["file",{"_index":98,"title":{"40":{},"41":{},"77":{},"78":{},"125":{},"127":{},"144":{}},"description":{"100":{}}}],["folder",{"_index":222,"title":{"86":{},"87":{}},"description":{}}],["forgot",{"_index":77,"title":{"33":{},"34":{}},"description":{}}],["form",{"_index":262,"title":{"124":{}},"description":{"100":{}}}],["form.<br",{"_index":259,"title":{},"description":{"100":{}}}],["function",{"_index":271,"title":{"101":{}},"description":{}}],["futur",{"_index":453,"title":{},"description":{"202":{}}}],["get",{"_index":245,"title":{"97":{}},"description":{}}],["get_children",{"_index":283,"title":{},"description":{"105":{},"106":{},"108":{},"109":{}}}],["get_item_st",{"_index":417,"title":{},"description":{"178":{}}}],["get_publishing_queu",{"_index":372,"title":{},"description":{"150":{},"151":{}}}],["git",{"_index":210,"title":{"81":{},"83":{}},"description":{}}],["given",{"_index":54,"title":{"25":{},"27":{},"48":{},"60":{},"82":{},"91":{},"97":{},"102":{},"105":{},"106":{},"108":{},"109":{},"110":{},"112":{},"120":{},"122":{},"123":{},"124":{},"125":{},"127":{},"128":{},"129":{},"130":{},"134":{},"137":{},"138":{},"139":{},"140":{},"204":{}},"description":{}}],["global",{"_index":56,"title":{"26":{},"27":{},"36":{}},"description":{"81":{},"82":{},"83":{}}}],["go",{"_index":446,"title":{"198":{}},"description":{}}],["groovi",{"_index":336,"title":{"130":{}},"description":{}}],["groovy).<br",{"_index":265,"title":{},"description":{"100":{}}}],["group",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"5":{},"6":{},"7":{},"8":{}},"description":{"0":{}}}],["group(",{"_index":12,"title":{"4":{}},"description":{}}],["histori",{"_index":238,"title":{"94":{},"116":{},"121":{},"154":{},"172":{}},"description":{}}],["id",{"_index":14,"title":{"5":{},"14":{},"115":{},"146":{},"189":{}},"description":{}}],["imag",{"_index":324,"title":{"123":{}},"description":{}}],["implement",{"_index":302,"title":{"111":{}},"description":{}}],["indic",{"_index":126,"title":{"51":{}},"description":{}}],["inform",{"_index":160,"title":{"65":{},"66":{},"67":{}},"description":{}}],["initi",{"_index":381,"title":{"156":{}},"description":{}}],["instal",{"_index":345,"title":{"137":{},"138":{}},"description":{}}],["install_plugin",{"_index":348,"title":{},"description":{"138":{},"139":{}}}],["instanc",{"_index":109,"title":{"44":{}},"description":{}}],["instead",{"_index":287,"title":{},"description":{"105":{},"154":{}}}],["item",{"_index":85,"title":{"36":{},"39":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"102":{},"105":{},"106":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"116":{},"132":{},"141":{},"143":{},"168":{},"169":{},"170":{},"171":{},"173":{},"178":{},"179":{},"180":{},"204":{}},"description":{}}],["item_unlock",{"_index":308,"title":{},"description":{"114":{}}}],["javascript",{"_index":263,"title":{},"description":{"100":{}}}],["job",{"_index":103,"title":{"41":{}},"description":{}}],["languag",{"_index":442,"title":{"196":{}},"description":{}}],["length",{"_index":458,"title":{},"description":{"202":{}}}],["level",{"_index":437,"title":{"193":{},"194":{}},"description":{}}],["list",{"_index":92,"title":{"39":{},"75":{},"101":{},"102":{},"105":{},"106":{},"109":{},"134":{},"137":{},"141":{},"143":{},"150":{},"186":{},"204":{}},"description":{}}],["list_plugin",{"_index":346,"title":{},"description":{"137":{}}}],["list_remot",{"_index":187,"title":{},"description":{"75":{}}}],["live",{"_index":368,"title":{"149":{},"198":{}},"description":{}}],["local",{"_index":67,"title":{"44":{},"81":{},"83":{},"139":{}},"description":{"28":{}}}],["locat",{"_index":305,"title":{"112":{},"118":{},"121":{}},"description":{}}],["lock",{"_index":122,"title":{"50":{},"113":{}},"description":{"114":{}}}],["log",{"_index":154,"title":{"62":{},"63":{},"68":{}},"description":{"61":{}}}],["logged_in",{"_index":48,"title":{},"description":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"36":{},"37":{},"46":{},"163":{}}}],["logger",{"_index":435,"title":{"192":{},"193":{},"194":{}},"description":{"192":{}}}],["logout",{"_index":62,"title":{"28":{}},"description":{"28":{}}}],["manag",{"_index":1,"title":{},"description":{"0":{},"9":{},"42":{},"45":{}}}],["manage_access_token",{"_index":389,"title":{},"description":{"159":{},"160":{},"161":{},"162":{}}}],["marketplac",{"_index":114,"title":{"47":{},"135":{},"136":{},"137":{},"138":{},"140":{}},"description":{"135":{}}}],["max",{"_index":457,"title":{},"description":{"202":{}}}],["mediaconvert",{"_index":102,"title":{"41":{}},"description":{}}],["member",{"_index":16,"title":{"6":{},"43":{}},"description":{"55":{},"106":{},"109":{},"128":{},"129":{}}}],["member\".<br",{"_index":284,"title":{},"description":{"105":{}}}],["member(",{"_index":20,"title":{"7":{},"8":{}},"description":{}}],["memori",{"_index":164,"title":{"67":{}},"description":{}}],["menu",{"_index":84,"title":{"36":{}},"description":{}}],["method",{"_index":463,"title":{},"description":{"202":{}}}],["mode",{"_index":110,"title":{"44":{}},"description":{}}],["model",{"_index":450,"title":{"201":{},"202":{}},"description":{}}],["monitor",{"_index":147,"title":{"58":{},"64":{}},"description":{"64":{}}}],["move",{"_index":300,"title":{"111":{}},"description":{}}],["multipart",{"_index":267,"title":{},"description":{"100":{}}}],["n/a",{"_index":220,"title":{},"description":{"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"132":{},"133":{},"196":{},"198":{},"200":{}}}],["name",{"_index":116,"title":{"48":{}},"description":{}}],["new",{"_index":391,"title":{"160":{}},"description":{}}],["next",{"_index":242,"title":{"96":{}},"description":{}}],["none",{"_index":148,"title":{},"description":{"58":{}}}],["null",{"_index":70,"title":{},"description":{"28":{}}}],["oper",{"_index":2,"title":{},"description":{"0":{},"9":{},"35":{},"38":{},"42":{},"45":{},"59":{},"61":{},"64":{},"70":{},"84":{},"105":{},"117":{},"126":{},"131":{},"135":{},"142":{},"145":{},"154":{},"157":{},"164":{},"177":{},"192":{},"195":{}}}],["options:<br>writecontentwebform",{"_index":254,"title":{},"description":{"100":{}}}],["order",{"_index":236,"title":{"93":{},"96":{},"186":{}},"description":{}}],["our",{"_index":194,"title":{"77":{},"78":{}},"description":{}}],["owner",{"_index":309,"title":{},"description":{"114":{}}}],["packag",{"_index":370,"title":{"150":{},"151":{},"152":{},"167":{},"168":{},"171":{},"172":{},"173":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{}},"description":{}}],["page",{"_index":244,"title":{"97":{}},"description":{}}],["password",{"_index":41,"title":{"19":{},"20":{},"29":{},"33":{},"34":{}},"description":{}}],["past",{"_index":297,"title":{"111":{}},"description":{}}],["path",{"_index":228,"title":{"89":{},"91":{},"97":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"113":{},"114":{},"134":{},"181":{},"204":{}},"description":{}}],["pend",{"_index":402,"title":{"167":{},"168":{}},"description":{}}],["perform",{"_index":151,"title":{"60":{}},"description":{}}],["period",{"_index":169,"title":{"68":{}},"description":{}}],["permiss",{"_index":4,"title":{"24":{},"25":{},"27":{}},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"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":{},"36":{},"37":{},"39":{},"40":{},"41":{},"43":{},"44":{},"46":{},"48":{},"49":{},"50":{},"62":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"128":{},"129":{},"134":{},"137":{},"138":{},"139":{},"140":{},"141":{},"143":{},"144":{},"146":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"193":{},"194":{},"202":{},"204":{}}}],["plugin",{"_index":331,"title":{"126":{},"127":{},"128":{},"129":{},"130":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{}},"description":{"126":{}}}],["polici",{"_index":129,"title":{"51":{}},"description":{}}],["post",{"_index":462,"title":{},"description":{"202":{}}}],["preview",{"_index":323,"title":{"123":{},"163":{},"199":{},"200":{}},"description":{}}],["prioriti",{"_index":436,"title":{"193":{},"194":{}},"description":{}}],["project",{"_index":134,"title":{"53":{},"54":{},"149":{}},"description":{}}],["project/sit",{"_index":138,"title":{"55":{},"57":{},"147":{},"148":{}},"description":{"55":{}}}],["projects/sit",{"_index":145,"title":{"58":{}},"description":{}}],["properti",{"_index":75,"title":{"30":{},"31":{},"32":{}},"description":{}}],["provid",{"_index":61,"title":{"28":{}},"description":{}}],["publish",{"_index":213,"title":{"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"152":{},"153":{},"154":{},"155":{},"156":{},"167":{},"170":{},"172":{},"173":{},"174":{},"182":{},"183":{},"184":{},"185":{}},"description":{"81":{},"82":{},"83":{},"145":{},"149":{},"154":{},"155":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{}}}],["publish_by_commit",{"_index":359,"title":{},"description":{"146":{}}}],["publish_statu",{"_index":376,"title":{},"description":{"153":{}}}],["pull",{"_index":179,"title":{"72":{},"80":{}},"description":{}}],["pull_from_remot",{"_index":180,"title":{},"description":{"72":{}}}],["push",{"_index":182,"title":{"73":{}},"description":{}}],["push_to_remot",{"_index":183,"title":{},"description":{"73":{}}}],["queri",{"_index":420,"title":{"180":{}},"description":{}}],["queue",{"_index":371,"title":{"150":{}},"description":{}}],["quick",{"_index":270,"title":{"101":{}},"description":{}}],["read_clust",{"_index":106,"title":{},"description":{"43":{},"44":{}}}],["read_configur",{"_index":313,"title":{},"description":{"118":{},"121":{},"202":{}}}],["read_group",{"_index":5,"title":{},"description":{"1":{},"5":{},"6":{}}}],["read_us",{"_index":23,"title":{},"description":{"10":{},"14":{},"17":{},"18":{}}}],["reason",{"_index":142,"title":{"56":{}},"description":{}}],["redirect",{"_index":66,"title":{},"description":{"28":{}}}],["refer",{"_index":276,"title":{"102":{}},"description":{}}],["reject",{"_index":141,"title":{"56":{},"185":{}},"description":{}}],["relat",{"_index":329,"title":{"125":{}},"description":{}}],["releas",{"_index":454,"title":{},"description":{"202":{}}}],["reload",{"_index":335,"title":{"130":{}},"description":{}}],["remot",{"_index":176,"title":{"71":{},"72":{},"73":{},"74":{},"75":{}},"description":{}}],["remov",{"_index":21,"title":{"8":{},"74":{},"140":{}},"description":{}}],["remove_plugin",{"_index":350,"title":{},"description":{"140":{},"141":{}}}],["remove_remot",{"_index":185,"title":{},"description":{"74":{}}}],["renam",{"_index":224,"title":{"87":{},"104":{}},"description":{}}],["reorder",{"_index":247,"title":{"98":{}},"description":{}}],["repair",{"_index":217,"title":{"83":{}},"description":{}}],["repositori",{"_index":175,"title":{"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"81":{},"82":{},"83":{},"146":{},"200":{}},"description":{"70":{}}}],["request",{"_index":268,"title":{"182":{},"184":{},"185":{}},"description":{"100":{},"202":{}}}],["request_publish",{"_index":430,"title":{},"description":{"186":{},"187":{},"188":{},"189":{},"191":{}}}],["requir",{"_index":3,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"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":{},"36":{},"37":{},"39":{},"40":{},"41":{},"43":{},"44":{},"46":{},"48":{},"49":{},"50":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"62":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"128":{},"129":{},"132":{},"133":{},"134":{},"137":{},"138":{},"139":{},"140":{},"141":{},"143":{},"144":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"193":{},"194":{},"196":{},"198":{},"200":{},"202":{},"204":{}}}],["reset",{"_index":40,"title":{"19":{}},"description":{}}],["resolv",{"_index":191,"title":{"77":{},"79":{}},"description":{}}],["resolve_conflict",{"_index":196,"title":{},"description":{"77":{}}}],["respons",{"_index":68,"title":{},"description":{"28":{}}}],["retriev",{"_index":74,"title":{"30":{}},"description":{}}],["revert",{"_index":249,"title":{"99":{}},"description":{}}],["role",{"_index":38,"title":{"18":{},"23":{}},"description":{"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"81":{},"82":{},"83":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"132":{},"133":{},"146":{},"147":{},"148":{},"196":{},"198":{},"200":{}}}],["s3",{"_index":93,"title":{"39":{},"40":{},"41":{}},"description":{}}],["s3_read",{"_index":95,"title":{},"description":{"39":{}}}],["s3_write",{"_index":99,"title":{},"description":{"40":{},"41":{}}}],["same",{"_index":304,"title":{"112":{}},"description":{}}],["sandbox",{"_index":212,"title":{"146":{}},"description":{"81":{},"82":{},"83":{}}}],["save",{"_index":255,"title":{},"description":{"100":{}}}],["schedul",{"_index":408,"title":{"170":{},"171":{},"186":{}},"description":{}}],["script",{"_index":327,"title":{"124":{}},"description":{}}],["search",{"_index":150,"title":{"59":{},"60":{},"136":{}},"description":{"59":{}}}],["secur",{"_index":383,"title":{"157":{}},"description":{"157":{}}}],["server",{"_index":354,"title":{"143":{},"144":{},"195":{}},"description":{"195":{}}}],["servic",{"_index":60,"title":{"28":{}},"description":{}}],["set",{"_index":203,"title":{"79":{},"163":{},"179":{},"180":{}},"description":{"202":{}}}],["set_item_st",{"_index":419,"title":{},"description":{"179":{},"180":{}}}],["simpl",{"_index":340,"title":{"133":{}},"description":{}}],["site",{"_index":35,"title":{"17":{},"18":{},"22":{},"23":{},"24":{},"45":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"60":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"78":{},"79":{},"80":{},"118":{},"119":{},"120":{},"121":{},"128":{},"129":{},"130":{},"137":{},"138":{},"139":{},"140":{},"153":{},"154":{},"155":{},"156":{},"163":{},"169":{},"178":{},"179":{},"180":{},"202":{}},"description":{"45":{},"81":{},"82":{},"83":{},"105":{},"106":{},"109":{},"128":{},"129":{},"146":{},"147":{},"148":{}}}],["site_diff_conflicted_fil",{"_index":200,"title":{},"description":{"78":{}}}],["site_memb",{"_index":398,"title":{},"description":{"165":{},"166":{},"167":{},"168":{},"175":{},"176":{},"182":{}}}],["site_statu",{"_index":189,"title":{},"description":{"76":{}}}],["specif",{"_index":167,"title":{"68":{},"99":{}},"description":{}}],["specifi",{"_index":17,"title":{"6":{},"7":{},"8":{},"17":{},"18":{}},"description":{}}],["sso",{"_index":59,"title":{"28":{}},"description":{"28":{}}}],["stage",{"_index":367,"title":{"149":{}},"description":{}}],["start",{"_index":361,"title":{"147":{}},"description":{}}],["stat",{"_index":412,"title":{"174":{}},"description":{}}],["state",{"_index":123,"title":{"50":{},"178":{},"179":{},"180":{}},"description":{}}],["statist",{"_index":173,"title":{"69":{}},"description":{}}],["statu",{"_index":162,"title":{"66":{},"76":{},"153":{}},"description":{}}],["stop",{"_index":364,"title":{"148":{}},"description":{}}],["stream",{"_index":226,"title":{"88":{},"89":{}},"description":{}}],["studio",{"_index":108,"title":{"44":{},"53":{},"54":{},"55":{},"57":{}},"description":{}}],["studio’",{"_index":362,"title":{"147":{},"148":{}},"description":{}}],["submiss",{"_index":426,"title":{"184":{},"185":{}},"description":{}}],["support",{"_index":83,"title":{},"description":{"35":{}}}],["surpass",{"_index":456,"title":{},"description":{"202":{}}}],["sync",{"_index":448,"title":{"200":{}},"description":{}}],["system",{"_index":65,"title":{"37":{}},"description":{"28":{}}}],["system_admin",{"_index":211,"title":{},"description":{"81":{},"82":{},"83":{}}}],["target",{"_index":298,"title":{"111":{},"149":{},"155":{}},"description":{}}],["templat",{"_index":219,"title":{"85":{}},"description":{"100":{}}}],["text",{"_index":385,"title":{"158":{}},"description":{}}],["their",{"_index":195,"title":{"77":{},"78":{}},"description":{}}],["through",{"_index":71,"title":{},"description":{"28":{}}}],["time",{"_index":168,"title":{"68":{}},"description":{}}],["token",{"_index":80,"title":{"34":{},"159":{},"160":{},"161":{},"162":{}},"description":{}}],["tree",{"_index":240,"title":{"95":{},"97":{},"111":{}},"description":{}}],["trigger",{"_index":101,"title":{"41":{}},"description":{}}],["type",{"_index":230,"title":{"90":{},"91":{},"101":{},"123":{},"124":{}},"description":{}}],["ui",{"_index":82,"title":{"35":{},"111":{}},"description":{"35":{}}}],["unlock",{"_index":121,"title":{"50":{},"81":{},"114":{}},"description":{}}],["unpublish",{"_index":406,"title":{"169":{}},"description":{}}],["updat",{"_index":9,"title":{"3":{},"12":{},"31":{},"48":{},"161":{},"188":{},"194":{}},"description":{}}],["update_group",{"_index":10,"title":{},"description":{"3":{},"7":{}}}],["update_us",{"_index":26,"title":{},"description":{"12":{},"15":{},"16":{},"19":{}}}],["upload",{"_index":97,"title":{"40":{},"41":{},"144":{}},"description":{"100":{}}}],["url",{"_index":63,"title":{"28":{}},"description":{"28":{}}}],["us",{"_index":256,"title":{"111":{},"163":{},"180":{}},"description":{"100":{},"105":{},"154":{}}}],["usag",{"_index":172,"title":{"69":{},"122":{}},"description":{}}],["user",{"_index":22,"title":{"9":{},"10":{},"11":{},"12":{},"14":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"36":{},"159":{},"160":{},"161":{},"162":{},"165":{}},"description":{"9":{},"28":{}}}],["user'",{"_index":400,"title":{"166":{}},"description":{}}],["user(",{"_index":27,"title":{"13":{},"15":{},"16":{}},"description":{}}],["usernam",{"_index":29,"title":{"14":{}},"description":{}}],["valid",{"_index":79,"title":{"34":{}},"description":{}}],["valu",{"_index":386,"title":{"158":{}},"description":{}}],["verifi",{"_index":125,"title":{"51":{}},"description":{}}],["version",{"_index":159,"title":{"65":{},"94":{},"99":{}},"description":{}}],["view_log_level",{"_index":438,"title":{},"description":{"193":{}}}],["web",{"_index":258,"title":{},"description":{"100":{}}}],["webdav",{"_index":353,"title":{"142":{},"143":{},"144":{}},"description":{"142":{}}}],["webdav_read",{"_index":355,"title":{},"description":{"143":{}}}],["webdav_writ",{"_index":357,"title":{},"description":{"144":{}}}],["workflow",{"_index":416,"title":{"177":{},"178":{},"179":{},"180":{},"181":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{}},"description":{"177":{}}}],["write",{"_index":251,"title":{"100":{},"119":{},"129":{}},"description":{"111":{},"112":{}}}],["write_configur",{"_index":315,"title":{},"description":{"119":{},"120":{},"125":{},"129":{}}}],["writecontentassetform",{"_index":260,"title":{},"description":{"100":{}}}],["writecontentfileupload",{"_index":266,"title":{},"description":{"100":{}}}],["xml",{"_index":294,"title":{"110":{}},"description":{}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","servers":[{"url":"http://localhost:8080/studio"}],"info":{"description":"Crafter Studio API","version":"4.5.0","title":"Crafter Studio","termsOfService":"","contact":{"email":"info@craftercms.org"},"license":{"name":"GPL 3.0","url":"https://www.gnu.org/licenses/gpl-3.0.en.html"}},"externalDocs":{"description":"CrafterCMS - Studio","url":"https://craftercms.com/docs/current/reference/modules/studio.html"},"tags":[{"name":"groups","description":"Group management operations"},{"name":"users","description":"User management operations"},{"name":"ui","description":"UI support operations"},{"name":"aws","description":"AWS operations"},{"name":"cluster","description":"Cluster management operations"},{"name":"sites","description":"Site management operations"},{"name":"search","description":"Search operations"},{"name":"audit","description":"Audit log operations"},{"name":"monitoring","description":"Monitoring operations"},{"name":"repository","description":"Repository operations"},{"name":"content","description":"Content operations"},{"name":"configuration","description":"Configuration operations"},{"name":"plugin","description":"Plugin operations"},{"name":"dependency","description":"Dependencies operations"},{"name":"marketplace","description":"Marketplace operations"},{"name":"webdav","description":"WebDAV operations"},{"name":"publishing","description":"Publishing operations"},{"name":"security","description":"Security operations"},{"name":"dashboard","description":"Dashboard operations"},{"name":"workflow","description":"Workflow operations"},{"name":"loggers","description":"Logger configuration operations"},{"name":"server","description":"Server operations"}],"paths":{"/api/2/groups":{"get":{"tags":["groups"],"summary":"Get all groups","operationId":"getGroups","description":"Required Permission: \"READ_GROUPS\"","parameters":[{"name":"keyword","in":"query","description":"The keyword to filter groups","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first group in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of groups to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by\ncommas. Example: `column1 ASC, column2 DESC`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["groups"],"summary":"Create group","description":"Required Permission: \"CREATE_GROUPS\"","operationId":"createGroup","requestBody":{"description":"Group entity to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"group":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["groups"],"summary":"Update group","description":"Required Permission: \"UPDATE_GROUPS\"","operationId":"updateGroup","requestBody":{"description":"Group entity to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"group":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["groups"],"summary":"Delete group(s)","description":"Required Permission: \"DELETE_GROUPS\"","operationId":"deleteGroup","parameters":[{"name":"id","in":"query","description":"The group ID(s). Can be repeated for multiple deletes (id=1&id=2&id=3)","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/groups/{id}":{"get":{"tags":["groups"],"summary":"Get group by ID","description":"Required Permission: \"READ_GROUPS\"","operationId":"getGroup","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"group":{"$ref":"#/components/schemas/Group"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/groups/{id}/members":{"get":{"tags":["groups"],"summary":"Get all the members of the specified group","description":"Required Permission: \"READ_GROUPS\"","operationId":"getGroupMembers","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by\ncommas. Example: `column1 ASC, column2 DESC`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["groups"],"summary":"Add member(s) to the specified group","description":"Required Permission: \"UPDATE_GROUPS\"","operationId":"addGroupMembers","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"List of user IDs and/or usernames to add","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"usernames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["groups"],"summary":"Remove member(s) from the specified group","description":"Required Permission: \"DELETE_GROUPS\"","operationId":"removeGroupMembers","parameters":[{"name":"id","in":"path","description":"The group ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"userId","in":"query","description":"The user ID(s) to remove. Can be repeated for multiple deletes (userId=1&userId=2&userId=3)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"query","description":"The username(s) to remove. Can be repeated for multiple deletes (username=john&username=mark)","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users":{"get":{"tags":["users"],"summary":"Get all users","description":"Required Permission: \"READ_USERS\"","operationId":"getUsers","parameters":[{"name":"site_id","in":"query","description":"The site ID to filter users for a particular site","required":false,"schema":{"type":"string"}},{"name":"keyword","in":"query","description":"The keyword to filter users","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by\ncommas. Example: `column1 ASC, column2 DESC`.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["users"],"summary":"Create user","description":"Required Permission: \"CREATE_USERS\"","operationId":"createUser","requestBody":{"description":"User entity to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["users"],"summary":"Update user","description":"Required Permission: \"UPDATE_USERS\"","operationId":"updateUser","requestBody":{"description":"User entity to update. Supported update attributes are firstName, lastName, email and enabled.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["users"],"summary":"Delete user(s)","description":"Required Permission: \"DELETE_USERS\"","operationId":"deleteUser","parameters":[{"name":"id","in":"query","description":"The user ID(s). Can be repeated for multiple deletes (id=1&id=2&id=3)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"username","in":"query","description":"The username(s). Can be repeated for multiple deletes (username=john&username=mark)","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}":{"get":{"tags":["users"],"summary":"Get user by user ID or username","description":"Required Permission: \"READ_USERS\"","operationId":"getUser","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/enable":{"patch":{"tags":["users"],"summary":"Enable user(s)","description":"Required Permission: \"UPDATE_USERS\"","operationId":"enableUser","requestBody":{"description":"List of user IDs and/or usernames to enable","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"usernames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/disable":{"patch":{"tags":["users"],"summary":"Disable user(s)","description":"Required Permission: \"UPDATE_USERS\"","operationId":"disableUser","requestBody":{"description":"List of user IDs and/or usernames to disable","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"usernames":{"type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}/sites":{"get":{"tags":["users"],"summary":"Get all the sites the specified user has access to","description":"Required Permission: \"READ_USERS\"","operationId":"getUserSites","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first site in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of sites to return","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}/sites/{site}/roles":{"get":{"tags":["users"],"summary":"Get the site roles for the specified user","description":"Required Permission: \"READ_USERS\"","operationId":"getUserSiteRoles","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}},{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"roles":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/{id}/reset_password":{"post":{"tags":["users"],"summary":"Reset password for user","description":"Required Permission: \"UPDATE_USERS\"","operationId":"resetUserPassword","parameters":[{"name":"id","in":"path","description":"The user ID. Username can also be used","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"request body to reset password for user","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"new":{"type":"string","description":"new password"}},"required":["username","new"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/set_password":{"post":{"tags":["users"],"summary":"Change password for user","description":"Required Permission: \"ANONYMOUS\"","operationId":"setUserPassword","requestBody":{"description":"request body to change password","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"},"new":{"type":"string","description":"new password"}},"required":["token","new"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me":{"get":{"tags":["users"],"summary":"Get current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUser","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"authenticatedUser":{"$ref":"#/components/schemas/AuthenticatedUser"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites":{"get":{"tags":["users"],"summary":"Get all the sites the current authenticated user has access to","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserSites","parameters":[{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites/{site}/roles":{"get":{"tags":["users"],"summary":"Get the site roles for the current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserSiteRoles","parameters":[{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"roles":{"type":"array","items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites/{site}/permissions":{"get":{"tags":["users"],"summary":"Get the site permissions for the current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserSitePermissions","parameters":[{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"array","items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/sites/{site}/has_permissions":{"post":{"tags":["users"],"summary":"Check if the current authenticated user has given permissions","description":"Required Permission: \"LOGGED_IN\"","operationId":"hasCurrentUserSitePermissions","parameters":[{"name":"site","in":"path","description":"The site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"request body to check if current authenticated user has permissions","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"}}},"required":["permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"object","example":{"create":true,"update":true,"delete":false}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/global/permissions":{"get":{"tags":["users"],"summary":"Get the global for the current authenticated user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getCurrentUserGlobalPermissions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"array","items":{"type":"string"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/global/has_permissions":{"post":{"tags":["users"],"summary":"Check if the current authenticated user has given global permissions","description":"Required Permission: \"LOGGED_IN\"","operationId":"hasCurrentUserGlobalPermissions","requestBody":{"description":"request body to check if current authenticated user has permissions","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"string"}}},"required":["permissions"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"permissions":{"type":"object","example":{"create":true,"update":true,"delete":false}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/logout/sso/url":{"get":{"tags":["users"],"summary":"Get the SSO Service Provide logout URL for the current authenticated user","description":"* Required Permission: \"LOGGED_IN\"\n* The system should redirect to this logout URL `AFTER` local logout. Response entity can be null if user is\nnot authenticated through SSO or if logout is disabled","operationId":"getCurrentUserSsoLogoutUrl","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"logoutUrl":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/change_password":{"post":{"tags":["users"],"summary":"Change password for current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"currentUserChangePassword","requestBody":{"description":"request body to change password","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"current":{"type":"string","description":"current password"},"new":{"type":"string","description":"new password"}},"required":["username","current","new"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"user":{"$ref":"#/components/schemas/UserResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/me/properties":{"get":{"tags":["users"],"summary":"Retrieve properties for the current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"getUserProperties","parameters":[{"name":"siteId","schema":{"type":"string"},"in":"query","description":"The id of the site (defaults to global)"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"properties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"description":"The properties of the current user grouped by site"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["users"],"summary":"Update properties for the current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"updateUserProperties","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site (defaults to global)"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"Properties to update or add"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The properties of the current user after the updates"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["users"],"summary":"Delete properties for the current user","description":"Required Permission: \"LOGGED_IN\"","operationId":"deleteUserProperties","parameters":[{"name":"siteId","in":"query","schema":{"type":"string"},"description":"The id of the site (defaults to global)"},{"name":"properties","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}},"description":"List of keys to delete"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The properties of the current user after the updates"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/forgot_password":{"get":{"tags":["users"],"summary":"Forgot password","description":"Required Permission: \"ANONYMOUS\"","operationId":"forgotPassword","parameters":[{"name":"username","in":"query","description":"The username of user that forgot password","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/users/validate_token":{"get":{"tags":["users"],"summary":"Validate forgot password token","description":"Required Permission: \"ANONYMOUS\"","operationId":"validateToken","parameters":[{"name":"token","in":"query","description":"forgot password token to be validated","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/ui/views/global_menu":{"get":{"tags":["ui"],"summary":"Get the global menu items available to the current user","operationId":"getGlobalMenu","description":"Required Permission: \"LOGGED_IN\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"menuItems":{"type":"array","items":{"$ref":"#/components/schemas/MenuItem"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/ui/system/active_environment":{"get":{"tags":["ui"],"summary":"Get the current active environment for the system","operationId":"getActiveEnv","description":"Required Permission: \"LOGGED_IN\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"environment":{"type":"string"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/aws/s3/list":{"get":{"tags":["aws"],"summary":"Get a list of items from an S3 bucket","operationId":"listItems","description":"Required Permission: \"s3_read\"","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","description":"The profile ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"The path of the directory to list (defaults to the root)","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of items to list (defaults to all types)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/S3Item"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/aws/s3/upload":{"post":{"tags":["aws"],"summary":"Upload a file to an S3 bucket","operationId":"uploadItem","description":"Required Permission: \"s3_write\"","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The site ID"},"profileId":{"type":"string","description":"The profile ID"},"path":{"type":"string","description":"The path where the file will be uploaded (will be used as part of the key in S3)"},"filename":{"type":"string","description":"The name of the file (will be used as part of the item key in S3)"},"file":{"type":"string","format":"binary","description":"The content of the file to upload"}},"required":["siteId","profileId","filename","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/S3Item"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/aws/mediaconvert/upload":{"post":{"tags":["aws"],"summary":"Upload a file to an S3 bucket and trigger a MediaConvert job","operationId":"uploadVideo","description":"Required Permission: \"s3_write\"","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The site ID"},"inputProfileId":{"type":"string","description":"The MediaConvert profile ID"},"outputProfileId":{"type":"string","description":"The S3 profile ID for the generated URLs"},"file":{"type":"string","format":"binary","description":"The content of the file to upload"}},"required":["siteId","inputProfileId","outputProfileId","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/MediaConvertResult"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/webdav/list":{"get":{"tags":["webdav"],"summary":"Get a list of items from a WebDAV server","description":"Required Permission: \"webdav_read\"","operationId":"listItemsWebdav","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"query","description":"The profile ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"The path of the directory to list (defaults to the root)","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The MIME-type of items to list, defaults to all","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/WebDavItem"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/webdav/upload":{"post":{"tags":["webdav"],"summary":"Upload a file to a WebDAV server","description":"Required Permission: \"webdav_write\"","operationId":"uploadItemWebdav","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The site ID"},"profileId":{"type":"string","description":"The profile ID"},"path":{"type":"string","description":"The path where the file will be uploaded"},"file":{"type":"string","format":"binary","description":"The content of the file to upload"}},"required":["siteId","profileId","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/WebDavItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/cluster":{"get":{"tags":["cluster"],"summary":"Get all the members of the cluster","description":"Required Permission: \"read_cluster\"","operationId":"getClusterMembers","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"clusterMembers":{"type":"array","items":{"$ref":"#/components/schemas/ClusterMember"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/cluster/mode":{"get":{"tags":["cluster"],"summary":"Get the local Studio instance cluster mode","description":"Required Permission: \"read_cluster\"","operationId":"getClusterMode","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"mode":{"type":"string","enum":["PRIMARY","REPLICA","UNKNOWN"]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/available_blueprints":{"get":{"tags":["sites"],"summary":"Get all available blueprints","description":"Required Permission: \"LOGGED_IN\"","operationId":"availableBlueprints","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"blueprints":{"type":"array","items":{"$ref":"#/components/schemas/PluginDescriptor"}}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/create_site_from_marketplace":{"post":{"tags":["sites"],"summary":"Create a site from a Marketplace blueprint","operationId":"createSiteFromMarketplace","requestBody":{"description":"The site information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSiteFromMarketplace"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}":{"post":{"tags":["sites"],"summary":"Updates the name and description for a given site","description":"Required Permission: \"edit_site\"","operationId":"updateSite","parameters":[{"name":"siteId","in":"path","required":true,"description":"The site ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of the site","type":"string"},"description":{"description":"The description of the site","type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["sites"],"summary":"Deletes a site","description":"Required Permission: \"delete_site\"","operationId":"deleteSite","parameters":[{"name":"siteId","in":"path","required":true,"description":"The site ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}/unlock":{"post":{"tags":["sites"],"summary":"Unlock a site locked with state LOCKED","description":"Required Permission: \"edit_site\"","operationId":"unlockSite","parameters":[{"name":"siteId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/ContentValidationResult"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}/policy/validate":{"post":{"tags":["sites"],"summary":"Verifies if all indicated actions are compliant with the site policies","operationId":"validate","parameters":[{"name":"siteId","in":"path","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentValidationRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/ContentValidationResult"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/sites/{siteId}/duplicate":{"post":{"tags":["sites"],"summary":"Duplicates a site","operationId":"duplicateSite","parameters":[{"name":"siteId","in":"path","schema":{"type":"string"},"required":true}],"requestBody":{"description":"Duplicate site request information","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateSiteRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/services/api/1/site/create.json":{"post":{"tags":["sites"],"summary":"Create a Crafter Studio project.","description":"Required Role: \"Admin\"","operationId":"createSite","requestBody":{"description":"Project/site details","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"description":"Project/Site ID to use","type":"string","example":"my-editorial"},"name":{"type":"string","description":"Label to use for the project/site"},"sandbox_branch":{"type":"string","description":"Name for sandbox branch (default: master)"},"description":{"type":"string","description":"Project/Site description","example":"My very first site!"},"blueprint":{"type":"string","description":"Blueprint to use for bootstrapping the project/site \n\n <i>Required if</i> `use_remote` <i>is false</i>","example":"org.craftercms.blueprint.empty"},"use_remote":{"type":"boolean","description":"Use remote repository option if true, otherwise false","example":false},"remote_name":{"type":"string","description":"Remote repository name (default: origin)"},"remote_url":{"type":"string","description":"Remote repository URL \n\n <i>Required if</i> `use_remote` <i>is true</i>"},"remote_branch":{"type":"string","description":"Branch to clone repo from"},"single_branch":{"type":"string","description":"Clone single branch if true, otherwise clone all"},"authentication_type":{"type":"string","description":"Authentication type to use to access remote repository \n\n \t none: No authentication \n\n \t basic: username password authentication \n\n \t token: username token authentication \n\n \t key: key-based authentication \n\n <i>Required if</i> `authentication_type` <i>to be used is not</i> `none`"},"remote_username":{"type":"string","description":"Username to access remote repository \n\n <i>Required if</i> `authentication_type` <i>is set to</i> `basic`"},"remote_password":{"type":"string","description":"Password to access remote repository \n\n <i>Required if</i> `authentication_type` <i>is set to</i> `basic`"},"remote_token":{"type":"string","description":"Token to use to access remote repository \n\n <i>Required if</i> `authentication_type` <i>is set to</i> `token`"},"remote_private_key":{"type":"string","description":"Private key to access remote repository"},"create_option":{"type":"string","description":"Create options for remote repository: \n\n `clone`: clone from remote repository <i>Required if</i> `use_remote` <i>is true</i>"},"site_params":{"type":"object","description":"Object containing all parameters for the blueprint. It should include all required parameters from the descriptor"},"create_as_orphan":{"type":"boolean","description":"Create the project/site from a remote repository as orphan (no git history) - default is false"}},"required":["site_id","name"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"OK"}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"409":{"$ref":"#/components/responses/api1Conflict"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/delete-site.json":{"post":{"tags":["sites"],"summary":"Delete a Crafter Studio project.","description":"Required Role: \"Admin\"","operationId":"deleteSiteAPI1","requestBody":{"description":"Project/site to delete","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"description":"Project/Site ID to use","type":"string","example":"my-editorial"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean","example":true}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"409":{"$ref":"#/components/responses/api1Conflict"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/exists.json":{"get":{"tags":["sites"],"summary":"Check if Crafter Studio project/site exists.","description":"Required role: admin, member in the project/site","operationId":"projectExists","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"boolean","example":true}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/get-canned-message.json":{"get":{"tags":["sites"],"summary":"Get rejection reason.","description":"No required role","operationId":"getCannedMessage","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Locale of message","required":true,"schema":{"type":"string"},"example":"en"},{"name":"type","in":"query","description":"Message type","required":true,"schema":{"type":"string"},"example":"Typos"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"exists":{"type":"string","example":"This content has multiple spelling errors and/or grammatical errors. Please correct and re-submit."}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/get.json":{"get":{"tags":["sites"],"summary":"Get a Crafter Studio project/site","description":"No required role","operationId":"getSite","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"},"example":{"id":8,"siteUuid":"8d71254a-ceb3-409a-bb59-610505764a77","siteId":"third","name":"third","description":"null","deleted":0,"liveUrl":"null","lastCommitId":"5cb6fe1a1f2fa5aa38d372c757c8db8f0f17ecb3","publishingEnabled":1,"publishingStatus":"ready","lastVerifiedGitlogCommitId":"5cb6fe1a1f2fa5aa38d372c757c8db8f0f17ecb3","sandboxBranch":"master","publishedRepoCreated":0,"state":"READY","lastSyncedGitlogCommitId":"5cb6fe1a1f2fa5aa38d372c757c8db8f0f17ecb3","siteDeleted":false,"sitePublishedRepoCreated":false}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/site/monitor-content.json":{"get":{"tags":["sites"],"summary":"Get all projects/sites content monitors","description":"Required role: none","operationId":"monitorContent","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"site_id":{"type":"string"},"contentMonitoring":{"type":"object","properties":{"monitors":{"type":"array","items":{"type":"string"}}}}}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/publish/commits.json":{"post":{"tags":["publishing"],"summary":"Publish commits from sandbox repository by commit id.","description":"Required role: Admin, Site Admin or the permission 'publish_by_commits'","operationId":"publishCommits","requestBody":{"description":"Publish commits from sandbox repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site to use"},"environment":{"type":"string","description":"Environment to deploy content"},"commit_ids":{"type":"array","items":{"type":"string"},"description":"List of commit ids to publish"},"comment":{"type":"string","description":"Submission comment"}},"example":{"site_id":"my-editorial","environment":"live","commit_ids":["c89ee1cb2be4b41b0966d20c12d53b68ca70d74a","0664df1ad04a9627dccb55a51ebf3704e313e40b","93ae0e5e8d084fa9b7723cf3cf7ce526f47af0a9"],"comment":"My submission comment"},"required":["site_id","environment","commit_ids"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/publish/start.json":{"post":{"tags":["publishing"],"summary":"Start Crafter Studio’s publishing for a project/site.","description":"Required role: Admin, Site Admin","operationId":"publishStart","requestBody":{"description":"Start project/site publishing request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site ID to use"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/publish/stop.json":{"post":{"tags":["publishing"],"summary":"Stop Crafter Studio’s publishing for a project/site.","description":"Required role: Admin, Site Admin","operationId":"publishStop","requestBody":{"description":"Stop project/site publishing request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site ID to use"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/dependency/get-dependant.json":{"post":{"tags":["dependency"],"summary":"Get dependant content items.","description":"Required role: N/A","operationId":"getDependant","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/templates/web/pages/home.ftl"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/dependency/get-simple-dependencies.json":{"post":{"tags":["dependency"],"summary":"Get simple dependencies.","description":"Required role: N/A","operationId":"getSimpleDependencies","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/deployment/bulk-golive.json":{"post":{"tags":["deployment"],"summary":"Bulk go live.","description":"Required role: N/A","operationId":"bulkGoLive","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website"},{"name":"environment","in":"query","schema":{"type":"string"},"description":"Environment to deploy content","required":true,"example":"Live"},{"name":"comment","in":"query","schema":{"type":"string"},"description":"Submission comment"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/preview/sync-site.json":{"post":{"tags":["preview"],"summary":"Sync preview content with repository","description":"Required role: N/A","operationId":"syncSite","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/content/change-content-type.json":{"post":{"tags":["content"],"summary":"Change template for the content.","description":"Required role: N/A","operationId":"changeContentType","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"},{"name":"contentType","in":"query","schema":{"type":"string"},"description":"Content type to change to","required":true,"example":"/page/generic"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/content/create-folder.json":{"post":{"tags":["content"],"summary":"Create folder.","description":"Required role: N/A","operationId":"createFolder","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/"},{"name":"name","in":"query","schema":{"type":"string"},"description":"Name of the new folder","required":true,"example":"newFolder"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"boolean"}},"example":{"message":true}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/services/api/1/content/rename-folder.json":{"post":{"tags":["content"],"summary":"Rename folder.","description":"Required role: N/A","operationId":"renameFolder","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/"},{"name":"name","in":"query","schema":{"type":"string"},"description":"New name of the folder","required":true,"example":"newFolder"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":"true"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/1/services/api/1/content/get-content.json":{"get":{"tags":["content"],"summary":"Get content stream.","description":"Required role: N/A","operationId":"getContent","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/health/index.xml"},{"name":"edit","in":"query","schema":{"type":"boolean"},"description":"True to make content locked","required":true,"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string"}}},"example":{"content":"<page>\n\t<content-type>/page/category-landing</content-type>\n\t<display-template>/templates/web/pages/category-landing.ftl</display-template>\n\t<no-template-required/>\n\t<merge-strategy>inherit-levels</merge-strategy>\n\t<objectGroupId>0557</objectGroupId>\n\t<objectId>05573d7a-3556-1ad0-6e34-9b085944fee2</objectId>\n\t<file-name>index.xml</file-name>\n\t<folder-name>health</folder-name>\n\t<placeInNav>true</placeInNav>\n\t<orderDefault_f>9000</orderDefault_f>\n\t<internal-name>Health</internal-name>\n\t<title_t>Health</title_t>\n\t<createdDate>2017-03-14T15:21:57.000Z</createdDate>\n\t<createdDate_dt>2017-03-14T15:21:57.000Z</createdDate_dt>\n\t<lastModifiedDate>2020-10-07T12:08:00.200Z</lastModifiedDate>\n\t<lastModifiedDate_dt>2020-10-07T12:08:00.200Z</lastModifiedDate_dt>\n\t<category_s>health</category_s>\n\t<max_articles_i>10</max_articles_i>\n\t<articles_title_t>Health</articles_title_t>\n\t<disabled>false</disabled>\n\t<header_o item-list=\"true\"/>\n\t<left_rail_o item-list=\"true\"/>\n</page>\n"}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"}}}},"/api/1/services/api/1/content/get-content-at-path.json":{"get":{"tags":["content"],"summary":"Get content stream at path.","description":"Required role: N/A","operationId":"getContentAtPath","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/health/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"contentStream":{"type":"object","properties":{"type":{"type":"integer"},"size":{"type":"integer"}}},"contentPath":{"type":"string"}}},"example":{"contentStream":{"type":3,"size":1699},"contentPath":"/site/website/health/index.xml"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-content-type.json":{"get":{"tags":["content"],"summary":"Get content type configuration.","description":"Required role: N/A","operationId":"getContentType","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string"},"description":"Content type","required":true,"example":"/page/category-landing"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentType"},"example":{"name":"/page/category-landing","label":"Category Landing","form":"/page/category-landing","formPath":"simple","type":"page","contentAsFolder":true,"useRoundedFolder":false,"modelInstancePath":"NOT-USED-BY-SIMPLE-FORM-ENGINE","allowedRoles":[],"lastUpdated":"2023-11-10T18:00:05.882948Z","copyDependencyPattern":[],"imageThumbnail":"page-category-landing.png","noThumbnail":false,"pathIncludes":["^/site/website/(?!articles/)(.*)"],"pathExcludes":[],"nodeRef":"null","quickCreate":false,"quickCreatePath":"","deleteDependencyPattern":[],"previewable":true}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-content-types.json":{"get":{"tags":["content"],"summary":"Get content types allowed for given path.","description":"Required role: N/A","operationId":"getContentTypes","parameters":[{"name":"site","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path to get content types for","required":true,"example":"/site/website/"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentType"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-item.json":{"get":{"tags":["content"],"summary":"Get content item.","description":"Required role: N/A","operationId":"getItem","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentItemV1"}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"403":{"$ref":"#/components/responses/api1Forbidden"}}}},"/api/1/services/api/1/content/get-item-orders.json":{"get":{"tags":["content"],"summary":"Get item orders.","description":"Required role: N/A","operationId":"getItemOrders","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/style/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/ContentItemV1"},"versions":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemOrder"}}}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-item-versions.json":{"get":{"tags":["content"],"summary":"Get content item version history.","description":"Required role: N/A","operationId":"getItemVersions","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemVersions"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-items-tree.json":{"get":{"tags":["content"],"summary":"Get items tree.","description":"Required role: N/A","operationId":"getItemsTree","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"},{"name":"depth","in":"query","schema":{"type":"integer"},"description":"Depth of the tree to display","required":true,"example":1}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentItemV1"}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-next-item-order.json":{"get":{"tags":["content"],"summary":"Get next item order.","description":"Required role: N/A","operationId":"getNextItemOrder","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the parent item","required":true,"example":"/site/website/index.xml"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"nextValue":{"type":"number"}}},"example":1000}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/get-pages.json":{"get":{"tags":["content"],"summary":"Get pages. Gets tree of content items for given path.","description":"Required role: N/A","operationId":"getPages","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/index.xml"},{"name":"depth","in":"query","schema":{"type":"integer"},"description":"Depth of the tree to display","required":true,"example":1},{"name":"order","in":"query","schema":{"type":"string"},"description":"Order of content items.","required":true,"example":"default"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemV1"}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/reorder-items.json":{"get":{"tags":["content"],"summary":"Reorder content items.","description":"Required role: N/A","operationId":"reorderItems","parameters":[{"name":"site_id","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/health/index.xml"},{"name":"before","in":"query","schema":{"type":"string"},"description":"Item before the item with given path","required":true,"example":1},{"name":"after","in":"query","schema":{"type":"string"},"description":"Item after the item with given path","required":true,"example":"default"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"orderValue":{"type":"number"}}},"example":10500}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/content/revert-content.json":{"get":{"tags":["content"],"summary":"Revert content item to a specific version.","description":"Required role: N/A","operationId":"revertContent","parameters":[{"name":"site","in":"query","description":"Project/Site ID to use","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","schema":{"type":"string"},"description":"Path of the content","required":true,"example":"/site/website/style/index.xml"},{"name":"version","in":"query","schema":{"type":"string"},"description":"Version to revert to","required":true,"example":"818e0f68bfccda9a9a1a788341b87ca3ba5ad3c6"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean","example":true}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"}}}},"/api/1/services/api/1/content/write-content.json":{"post":{"tags":["content"],"summary":"Write content.","description":"Required role: Author <br><br> Options:<br>WriteContentWebForm: Save content using Create/Edit web form.<br> WriteContentAssetForm: Save content using asset form (templates, javascript, css, groovy).<br> WriteContentFileUpload: File upload (multipart request)","operationId":"writeContent","parameters":[{"in":"query","name":"filter","required":true,"style":"form","explode":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/WriteContentWebForm","additionalProperties":false},{"$ref":"#/components/schemas/WriteContentAssetForm","additionalProperties":false},{"$ref":"#/components/schemas/WriteContentFileUpload","additionalProperties":false}]}}],"requestBody":{"description":"Write content request body <br> Use \"multipart/form-data\" when uploading a file (WriteContentFileUpload)","required":true,"content":{"text/plain":{"schema":{"type":"string"},"examples":{"writeContentWebForm":{"value":"<?xml version=\"1.0\" encoding=\"UTF-8\"?> <!-- ~ Copyright (C) 2007-2024 Crafter Software Corporation. All Rights Reserved. ~ ~ This program is free software: you can redistribute it and/or modify ~ it under the terms of the GNU General Public License version 3 as published by ~ the Free Software Foundation. ~ ~ This program is distributed in the hope that it will be useful, ~ but WITHOUT ANY WARRANTY; without even the implied warranty of ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the ~ GNU General Public License for more details. ~ ~ You should have received a copy of the GNU General Public License ~ along with this program.  If not, see <http://www.gnu.org/licenses/>. --><page> <content-type>/page/article</content-type> <display-template>/templates/web/pages/article.ftl</display-template> <merge-strategy>inherit-levels</merge-strategy> <objectGroupId>f1f9</objectGroupId> <objectId>f1f9c488-67e1-7ec0-d3ca-560b194e64d1</objectId> <sections_o> <item> <section_html><![CDATA[<p>Nulla sed enim ipsum. Sed ac neque a ligula malesuada volutpat. Donec et ligula rutrum, mattis mauris eget, vestibulum metus. Maecenas non vehicula neque. Nunc ac mauris id ipsum commodo tempus. Integer at dolor consequat, dignissim eros in, imperdiet dui. Aliquam condimentum turpis eget tellus ultrices tincidunt. Pellentesque id varius purus, ac tristique augue. Etiam ut pharetra purus. Vestibulum quis vehicula eros. Mauris laoreet purus nec felis ullamcorper convallis. test</p> <p>Quisque urna purus, posuere nec urna sed, ornare aliquet mauris. In faucibus vitae tellus id iaculis. Donec porttitor, elit eu elementum pulvinar, sapien ex cursus lacus, non ornare ex lectus ut elit. Donec eros ligula, suscipit eu tellus ut, tristique hendrerit tortor. Fusce sollicitudin mollis risus, ut rhoncus magna volutpat vel. Cras auctor, elit id pellentesque semper, neque nibh fermentum ante, sit amet malesuada felis magna nec enim. Vivamus sollicitudin placerat felis, vel blandit dolor sollicitudin a. Nunc vitae volutpat augue. Nunc tristique placerat tortor condimentum sagittis. Sed eu egestas ex, quis auctor neque. Nam eget tellus suscipit, vestibulum augue nec, consequat erat. Mauris malesuada nec ligula non posuere. Proin vitae posuere tortor. Phasellus vulputate quam ut dictum vulputate.</p> <p>Integer ac lectus metus. Ut aliquam ipsum ligula, quis molestie ex pretium sit amet. Morbi porttitor neque vel luctus laoreet. Mauris varius lacus a eros aliquam, in maximus nibh aliquam. Integer sodales consequat metus eget accumsan. Integer viverra mi erat, in hendrerit massa vestibulum placerat. Sed ut gravida nisl, ut cursus neque. Vestibulum tristique rutrum augue vel aliquet.</p> <p>Ut quis faucibus diam. Aliquam dolor metus, laoreet vitae lacinia a, aliquam a tellus. Vivamus sed commodo ipsum, in lacinia nisl. Sed metus diam, porta eget tortor et, vehicula hendrerit sapien. Vestibulum vehicula urna felis, id elementum libero pellentesque id. Vivamus in massa velit. Suspendisse vitae turpis fermentum lectus pellentesque laoreet. Curabitur viverra pretium turpis, eget feugiat mi blandit a. Quisque nisl urna, porta ut urna eget, mattis fringilla nisi. Ut lacus ligula, dapibus ac fermentum ac, rhoncus eget metus. Donec scelerisque, felis vitae viverra iaculis, diam sem gravida tellus, non sodales urna urna sit amet enim. Duis id justo vitae justo suscipit porta placerat vel ligula. Morbi justo nunc, rhoncus laoreet ipsum a, aliquet eleifend dui. In a quam tortor.</p> <p>Pellentesque eget eros ut dui tincidunt convallis. Pellentesque tincidunt rutrum tellus, non rhoncus dui finibus eu. Integer eu sem maximus, blandit neque eu, congue leo. Ut pretium efficitur turpis, id dapibus turpis bibendum vel. Suspendisse a nibh dictum, imperdiet est et, interdum odio. Morbi urna magna, eleifend vitae luctus ac, scelerisque sit amet nisi. Quisque maximus placerat ante et fermentum. Nulla eu aliquet arcu, vel maximus massa. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam posuere arcu ex, in sagittis orci rhoncus eu. Suspendisse potenti. Curabitur facilisis sapien et ligula tristique lacinia. Aliquam a mauris bibendum, placerat augue sit amet, hendrerit arcu. Nam in bibendum sapien. Pellentesque laoreet nisi vel metus dapibus dictum. Integer semper, velit laoreet ornare maximus, nulla orci maximus ante, a tincidunt eros risus blandit eros.</p>]]></section_html> </item> </sections_o> <file-name>index.xml</file-name> <folder-name>men-styles-for-winter</folder-name> <internal-name>Men Styles For Winter</internal-name> <title_t>Men Styles For Winter</title_t> <subject_t>Men Styles For Winter</subject_t> <author_s>John Doe</author_s> <categories_o> <item> <key>style</key> <value_smv>Style</value_smv> </item> </categories_o> <segments_o> <item> <key>guy</key> <value_smv>Guy</value_smv> </item> </segments_o> <date_dt>2021-01-05T05:00:00.000Z</date_dt> <createdDate>2017-03-3T20:57:7.000Z</createdDate> <createdDate_dt>2017-03-3T20:57:7.000Z</createdDate_dt> <lastModifiedDate>2017-03-13T20:33:5.000Z</lastModifiedDate> <lastModifiedDate_dt>2023-11-20T13:25:05.289Z</lastModifiedDate_dt> <featured_b>true</featured_b> <summary_t>Nulla sed enim ipsum. Sed ac neque a ligula malesuada volutpat. Donec et ligula rutrum, mattis mauris eget, vestibulum metus. Maecenas non vehicula neque. Nunc ac mauris id ipsum commodo tempus. Integer at dolor consequat, dignissim eros in, imperdiet dui.</summary_t> <image_s>/static-assets/images/winter-man-pic.jpg</image_s> </page>"},"writeContentAssetForm":{"value":"<#import \"/templates/system/common/cstudio-support.ftl\" as studio />\n<!DOCTYPE HTML> <!-- Editorial by HTML5 UP html5up.net | @ajlkn Free for personal and commercial use under the CCA 3.0 license (html5up.net/license) Test write-content --> <html> <head> <title>${contentModel.title_t}</title> <meta charset=\"utf-8\" /> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, user-scalable=no\" /> <!--[if lte IE 8]><script src=\"/static-assets/js/ie/html5shiv.js\"><\/script><![endif]--> <link rel=\"stylesheet\" href=\"/static-assets/css/main.css?v=${siteContext.siteName}\" /> <!--[if lte IE 9]><link rel=\"stylesheet\" href=\"/static-assets/css/ie9.css\" /><![endif]--> <!--[if lte IE 8]><link rel=\"stylesheet\" href=\"/static-assets/css/ie8.css\" /><![endif]--> <link rel=\"stylesheet\" href=\"/static-assets/css/jquery-ui.min.css\" /> </head> <body> <!-- Wrapper --> <div id=\"wrapper\">\n<!-- Main --> <div id=\"main\"> <div class=\"inner\">\n<!-- Header --> <@renderComponent component=contentModel.header_o.item />\n<!-- Banner --> <section id=\"banner\" <@studio.iceAttr iceGroup=\"hero\"/>> <div class=\"content\"> <header>${contentModel.hero_title_html}</header> ${contentModel.hero_text_html} </div> <span class=\"image object\"> <img src=\"${contentModel.hero_image_s !\"\"}\" alt=\"\" /> </span> </section>\n<!-- Section --> <section <@studio.iceAttr iceGroup=\"features\"/>> <header class=\"major\"> <h2>${contentModel.features_title_t}</h2> </header> <div class=\"features\" <@studio.componentContainerAttr target=\"features_o\" component=contentModel/>> <#if contentModel.features_o?? && contentModel.features_o.item??> <#list contentModel.features_o.item as feature> <@renderComponent component=feature /> </#list> </#if> </div> </section>\n<!-- Section --> <section> <header class=\"major\"> <h2>Featured Articles</h2> </header> <div class=\"posts\"> <#list articles as article> <article> <a href=\"${article.url}\" class=\"image\"> <#if article.image??> <#assign articleImage = article.image/> <#else> <#assign articleImage = \"/static-assets/images/placeholder.png\"/> </#if> <img src=\"${articleImage}\" alt=\"\" /> </a> <h3><a href=\"${article.url}\">${article.title}</a></h3> <p>${article.summary}</p> <ul class=\"actions\"> <li><a href=\"${article.url}\" class=\"button\">More</a></li> </ul> </article> </#list> </div> </section>\n</div> </div>\n<!-- Left Rail --> <@renderComponent component=contentModel.left\\-rail_o.item />\n</div>\n<!-- Scripts --> <script src=\"/static-assets/js/jquery.min.js\"><\/script> <script src=\"/static-assets/js/jquery-ui.min.js\"><\/script> <script src=\"/static-assets/js/skel.min.js\"><\/script> <script src=\"/static-assets/js/util.js\"><\/script> <!--[if lte IE 8]><script src=\"/static-assets/js/ie/respond.min.js\"><\/script><![endif]--> <script src=\"/static-assets/js/main.js?v=${siteContext.siteName}\"><\/script>\n<@studio.toolSupport/> </body> </html>"}}},"multipart/form-data":{"schema":{"type":"object","properties":{"site":{"type":"string","description":"the project/site id","example":"mysite"},"path":{"type":"string","description":"the folder in your site where you want to upload your file","example":"/static-assets"},"file":{"type":"string","description":"the file to be uploaded","format":"binary"}},"required":["site","path","file"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"}},"example":{"result":null}}}}},"400":{"$ref":"#/components/responses/api1BadRequest"},"401":{"$ref":"#/components/responses/api1Unauthorized"},"404":{"$ref":"#/components/responses/api1NotFound"},"500":{"$ref":"#/components/responses/api1InternalServerError"}}}},"/api/1/services/api/1/server/get-available-languages.json":{"get":{"tags":["server"],"summary":"Get available languages.","description":"Required role: N/A","operationId":"getAvailableLanguages","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailableLanguage"},"example":[{"id":"en","label":"English"},{"id":"es","label":"Español"},{"id":"kr","label":"한국어"}]}}}}}}},"/api/2/search/search":{"post":{"tags":["search"],"summary":"Performs a search for the given site","operationId":"search","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Search Parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchParams"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/SearchResult"}}}}}}}}},"/api/2/audit":{"get":{"tags":["audit"],"summary":"Get audit log","description":"Required permission \"AUDIT_LOG\"","operationId":"getAuditLog","parameters":[{"name":"siteId","in":"query","description":"Site ID (site identifier) - optional for super admin user, otherwise required","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset of first record in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of records to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"user","in":"query","description":"Filter log by user name","required":false,"schema":{"type":"string"}},{"name":"operations","in":"query","description":"Filter log by operations","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"includeParameters","in":"query","description":"Include parameters into result set if `true`. Default `false`","required":false,"schema":{"type":"boolean"}},{"name":"dateFrom","in":"query","description":"Lower boundary in date range query","required":false,"schema":{"type":"string"}},{"name":"dateTo","in":"query","description":"Upper boundary in date range query","required":false,"schema":{"type":"string"}},{"name":"target","in":"query","description":"Regular expression to filter target values","required":false,"schema":{"type":"string"}},{"name":"origin","in":"query","description":"Origin filter for audit log. Possible values `API` and `GIT`","required":false,"schema":{"type":"string"}},{"name":"clusterNodeId","in":"query","description":"Cluster node id filter for audit log","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sort result set by specified field. Possible values `date`.","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Order in sorted result. Possible values `ASC` and `DESC`","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"auditLog":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/audit/{id}":{"get":{"tags":["audit"],"summary":"Get audit log entry","operationId":"getAuditLogById","parameters":[{"name":"id","in":"path","description":"The log entry ID","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"siteId","in":"query","description":"Site ID (site identifier) - optional for super admin user, otherwise required","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"auditLog":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/version":{"get":{"tags":["monitoring"],"summary":"Get the current version information","operationId":"getVersion","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"version":{"$ref":"#/components/schemas/VersionItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/status":{"get":{"tags":["monitoring"],"summary":"Get the current status information","operationId":"getStatus","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"status":{"$ref":"#/components/schemas/StatusItem"}}}}}},"202":{"description":"Replica responding status OK. Primary will respond with status 200","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"status":{"$ref":"#/components/schemas/ClusterStatusItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/memory":{"get":{"tags":["monitoring"],"summary":"Get the current memory information","operationId":"getMemory","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"memory":{"$ref":"#/components/schemas/MemoryItem"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/log":{"get":{"tags":["monitoring"],"summary":"Get the log events for a specific time period","operationId":"getLogEvents","parameters":[{"name":"since","in":"query","description":"The time in milliseconds from which events should be fetched","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"token","in":"query","description":"Management token - not required for authenticated users","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"events":{"type":"array","items":{"$ref":"#/components/schemas/LogEvent"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/monitoring/disk":{"get":{"tags":["monitoring"],"summary":"Get disk usage statistics","operationId":"getDiskUsage","parameters":[{"name":"token","in":"query","description":"Management token - not required for authenticated users","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"disk":{"$ref":"#/components/schemas/DiskUsage"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/add_remote":{"post":{"tags":["repository"],"summary":"Add remote repository to the site content repository","description":"Required permission \"add_remote\"","operationId":"addRemoteRepository","requestBody":{"description":"Remote repository entity","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoteRepository"}}}},"responses":{"201":{"description":"Added","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/pull_from_remote":{"post":{"tags":["repository"],"summary":"Pull content from remote repository to site content repository","description":"Required permission \"pull_from_remote\"","operationId":"pullFromRemoteRepository","requestBody":{"description":"pull from remote repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"remoteName":{"type":"string","description":"Remote repository name to pull from"},"remoteBranch":{"type":"string","description":"Remote repository branch to pull from"},"mergeStrategy":{"type":"string","format":"theirs, ours, none","description":"Merge strategy to use when pulling content from remote repository"}},"required":["siteId","remoteName","remoteBranch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"type":"object","properties":{"successful":{"type":"boolean","description":"Indicates if the pull was successful"},"commitsMerged":{"type":"integer","format":"int64","description":"Total number of commits merged from the remote repository"},"mergeCommitId":{"type":"string","description":"The merge commit id"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/push_to_remote":{"post":{"tags":["repository"],"summary":"Push content to remote repository from site content repository","description":"Required permission \"push_to_remote\"","operationId":"pushToRemoteRepository","requestBody":{"description":"push to remote repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"remoteName":{"type":"string","description":"Remote repository name to push to"},"remoteBranch":{"type":"string","description":"Remote repository branch to push to"},"force":{"type":"boolean","description":"Indicates whether to force push to remote or not"}},"required":["siteId","remoteName","remoteBranch"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/remove_remote":{"post":{"tags":["repository"],"summary":"Remove remote repository from site content repository","description":"Required permission \"remove_remote\"","operationId":"removeRemoteRepository","requestBody":{"description":"remove remote repository request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"remoteName":{"type":"string","description":"Remote repository name of remote to be removed"}},"required":["siteId","remoteName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/list_remotes":{"get":{"tags":["repository"],"summary":"List remote repositories for a site","description":"Required permission \"list_remote\"","operationId":"listRemoteRepositories","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"remotes":{"type":"array","items":{"$ref":"#/components/schemas/RemoteRepositoryInfo"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/status":{"get":{"tags":["repository"],"summary":"Get status of repository for a site","description":"Required permission \"site_status\"","operationId":"repositoryStatus","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/resolve_conflict":{"post":{"tags":["repository"],"summary":"Resolve a conflict for a file by accepting ours or theirs","description":"Required permission \"resolve_conflict\"","operationId":"resolveConflict","requestBody":{"description":"resolve conflict request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"path":{"type":"string","description":"Conflicted file path"},"resolution":{"type":"string","description":"resolution mechanism to use (ours, theirs)"}},"required":["siteId","path","resolution"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/diff_conflicted_file":{"get":{"tags":["repository"],"summary":"Get the difference between ours and theirs for a conflicted file for a site","description":"Required permission \"site_diff_conflicted_file\"","operationId":"diffConflictedFile","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Path of conflicted file","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"diff":{"type":"object","properties":{"diff":{"type":"string","description":"difference between ours and theirs"},"studioVersion":{"type":"string","description":"studio's version of the file content"},"remoteVersion":{"type":"string","description":"remote repository version of the file content"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/commit_resolution":{"post":{"tags":["repository"],"summary":"Commit a resolved set of conflicts for a site","description":"Required permission \"commit_resolution\"","operationId":"commitResolution","requestBody":{"description":"Commit resolution request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"commitMessage":{"type":"string","description":"Commit message"}},"required":["siteId","commitMessage"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/cancel_failed_pull":{"post":{"tags":["repository"],"summary":"Cancel a failed/conflicted pull for a site","description":"Required permission \"cancel_failed_pull\"","operationId":"cancelFailedPull","requestBody":{"description":"cancel failed pull request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"}},"required":["siteId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/unlock":{"post":{"tags":["repository"],"summary":"Unlock local git repository","description":"Required role \"system_admin\" for global, \"admin\" for site sandbox or published","operationId":"unlockRepository","requestBody":{"description":"Unlock local git repository request","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID, do not send if unlocking the GLOBAL repository"},"repositoryType":{"type":"string","format":"GLOBAL, SANDBOX or PUBLISHED"}},"required":["repositoryType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"repositoryStatus":{"$ref":"#/components/schemas/RepositoryStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/corrupted":{"get":{"tags":["repository"],"summary":"Check if a given repository is corrupted","description":"Required role \"system_admin\" for global, \"admin\" for site sandbox or published","operationId":"isRepositoryCorrupted","parameters":[{"name":"siteId","in":"query","schema":{"type":"string"},"description":"site ID, do not send if checking the GLOBAL repository"},{"name":"repositoryType","required":true,"in":"query","schema":{"type":"string","format":"GLOBAL, SANDBOX or PUBLISHED"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"corrupted":{"type":"boolean"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/repository/repair":{"post":{"tags":["repository"],"summary":"Repair local git repository","description":"Required role \"system_admin\" for global, \"admin\" for site sandbox or published","operationId":"repairCorruptedRepository","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID, do not send if repairing the GLOBAL repository"},"repositoryType":{"type":"string","format":"GLOBAL, SANDBOX or PUBLISHED"}},"required":["repositoryType"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/model/{siteId}/definitions":{"post":{"tags":["model"],"summary":"Get all model definitions for site.","description":"Required permission \"read_configuration\". <br/>In a future release this request will accept a set of arguments which could surpass the max length of the GET request, consequently, this endpoint answers to a POST method..","operationId":"getAllModelDefinitions","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"types":{"type":"array","items":{"type":"string"},"example":["<form><title>Home</title>...","<form><title>Article</title>..."]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/get_configuration":{"get":{"tags":["configuration"],"summary":"Get configuration content for site and configuration location","description":"Required permission \"read_configuration\"","operationId":"getConfiguration","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"module","in":"query","description":"Module name (e.g. studio, engine)","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Configuration file path, relative to /config/<module>","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"environment to use","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"content":{"type":"string","description":"configuration file content"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/write_configuration":{"post":{"tags":["configuration"],"summary":"Write configuration content for site","description":"Required permission \"write_configuration\"","operationId":"writeConfiguration","requestBody":{"description":"write configuration request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"module":{"type":"string","description":"Module name (e.g. studio, engine)"},"path":{"type":"string","description":"Configuration file path, relative to /config/<module>"},"environment":{"type":"string","description":"environment to use"},"content":{"type":"string","description":"configuration file content"}},"required":["siteId","module","path","content"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/clear_cache":{"get":{"tags":["configuration"],"summary":"Clear all configuration cache for a given site","description":"Required Permission: \"write_configuration\"","operationId":"clearConfigurationCache","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/get_configuration_history":{"get":{"tags":["configuration"],"summary":"Get configuration history for site and configuration location","description":"Required permission \"read_configuration\"","operationId":"getConfigurationHistory","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"module","in":"query","description":"Module name (e.g. studio, engine)","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"Configuration file path, relative to /config/<module>","required":true,"schema":{"type":"string"}},{"name":"environment","in":"query","description":"environment to use","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"history":{"$ref":"#/components/schemas/History"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/content-type/usage":{"get":{"tags":["configuration"],"summary":"Get all usage of a given content-type","description":"Required permission \"content_read\"","operationId":"getContentTypeUsage","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"contentType","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"dependencies":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"string"},"description":"All templates associated with the given content-type"},"scripts":{"type":"array","items":{"type":"string"},"description":"All scripts associated with the given content-type"},"content":{"type":"array","items":{"type":"string"},"description":"All content types instantiated from the given content-type"}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/api/2/configuration/content-type/preview_image":{"get":{"tags":["configuration"],"summary":"Get preview image of a given content type","description":"Required permission \"content_read\"","operationId":"getContentTypePreviewImage","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"contentTypeId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"The content of the preview image file"}}},"headers":{"Content-Type":{"description":"The MIME type of the preview image file","schema":{"type":"string"}},"Content-Length":{"description":"The size in bytes of the preview image file","schema":{"type":"integer","format":"int64"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/content-type/form_controller":{"get":{"tags":["configuration"],"summary":"Get the form controller (if it exists) script of a given content type","description":"Required permission \"content_read\"","operationId":"getContentTypeFormController","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"contentTypeId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"The content of the form controller file"}}},"headers":{"Content-Type":{"description":"The MIME type of the form controller file","schema":{"type":"string"}},"Content-Length":{"description":"The size in bytes of the form controller file","schema":{"type":"integer","format":"int64"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/configuration/content-type/delete":{"post":{"tags":["configuration"],"summary":"Delete files related to a given content-type","description":"Required permission \"write_configuration\"","operationId":"deleteContentType","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"contentType":{"type":"string","description":"The content-type to delete"},"deleteDependencies":{"type":"boolean","description":"Indicates if all dependencies of the content-type should be deleted (defaults to false)"}},"required":["siteId","contentType"]}}}},"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/api/2/plugin/file":{"servers":[{"url":"http://localhost:8080/studio/1"}],"get":{"security":[],"tags":["plugin"],"summary":"Get a file for a given plugin","operationId":"getPluginFile","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The plugin type (e.g. control, data-source)","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"The plugin name (e.g. custom-input)","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","description":"The name of the file (e.g. input.js, style/main.css)","required":true,"schema":{"type":"string"}},{"name":"pluginId","in":"query","description":"The id of the plugin (e.g. org.craftercms.plugin). This is only needed for plugins installed from the\nmarketplace","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"binary","description":"The content of the file"}}},"headers":{"Content-Type":{"description":"The MIME type of the file","schema":{"type":"string"}},"Content-Length":{"description":"The size in bytes of the file","schema":{"type":"integer","format":"int64"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/plugin/get_configuration":{"get":{"tags":["plugin"],"summary":"Get configuration for the given site and plugin","description":"Required permission \"site member\"","operationId":"getPluginConfiguration","parameters":[{"name":"siteId","in":"query","description":"The id of the site","required":true,"schema":{"type":"string"}},{"name":"pluginId","in":"query","description":"The id of the plugin","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"content":{"type":"string","description":"configuration file content"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/plugin/write_configuration":{"post":{"tags":["plugin"],"summary":"Write configuration content a given site and plugin","description":"Required permission \"write_configuration\" and \"site member\"","operationId":"writePluginConfiguration","requestBody":{"description":"write configuration request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"pluginId":{"type":"string","description":"The id of the plugin"},"content":{"type":"string","description":"configuration file content"}},"required":["siteId","pluginId","content"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/plugin/script/reload":{"get":{"tags":["plugin"],"summary":"Reloads groovy classes for all plugins in a given site","operationId":"reloadClasses","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"token","in":"query","description":"Management token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/list_quick_create_content":{"get":{"tags":["content"],"summary":"Get list of content types available for Quick Create functionality","description":"Required permission \"create content\"","operationId":"quickCreateContent","parameters":[{"name":"siteId","in":"query","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/QuickCreateItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/get_delete_package":{"post":{"tags":["content"],"summary":"Get a list of delete children (will be deleted) and dependent items (will have broken references) for a given list of items to be deleted","description":"Required permission \"content_read\"","operationId":"getDeletePackage","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"paths":{"description":"Content paths to get a delete package for","type":"array","items":{"type":"string"}}},"required":["siteId","paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"object","properties":{"childItems":{"type":"array","items":{"type":"string"}},"dependentItems":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/delete":{"post":{"tags":["content"],"summary":"Delete content","description":"Required permission \"content_delete\"","operationId":"contentDelete","requestBody":{"description":"parameters for delete content","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"comment":{"type":"string","description":"deletion comment by the user performing the delete"}},"required":["siteId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/rename":{"post":{"tags":["content"],"summary":"Rename content","description":"Required permission \"content_write\"","operationId":"contentRename","requestBody":{"description":"parameters for rename content","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"path":{"type":"string","description":"full path to the item to rename"},"name":{"type":"string","description":"new item name (just the name, no path)"}},"required":["siteId","path","name"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/children_by_path":{"post":{"deprecated":true,"tags":["content"],"summary":"Get list of children for given item path","description":"Required permission \"get_children\" and \"site member\".<br/> This operation is deprecated, use /content/{siteId}/children instead.","operationId":"getChildrenByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"path":{"description":"item path to get children for","type":"string"},"localeCode":{"description":"filter children by locale code, or show source items (not translation) if translation to\nspecified locale code does not exist","type":"string"},"sortStrategy":{"description":"sort strategy (sort order) Possible values:\n  - alphabetical (default)\n  - foldersFirst (order by: folders alphabetical, files alphabetical)\n  - lastUpdated (order by: dateModified)","type":"string"},"order":{"description":"order for sort strategy ascending or descending (ASC / DESC)","type":"string","format":"ASC, DESC"},"offset":{"description":"offset of first child in response - default 0","type":"integer"},"limit":{"description":"number of children to return","type":"integer"},"keyword":{"description":"filter children by keyword","type":"string"},"systemTypes":{"description":"filter children by system type","type":"array","items":{"type":"string"}},"excludes":{"description":"exclude items by path","type":"array","items":{"type":"string"}}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"levelDescriptor":{"$ref":"#/components/schemas/SandboxItem"},"children":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/{siteId}/children":{"post":{"tags":["content"],"summary":"Get list of children for given item paths","description":"Required permission \"get_children\" and \"site member\"","operationId":"getChildrenByPaths","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"paths":{"description":"item paths to get children for","type":"array","items":{"$ref":"#/components/schemas/ChildrenByPathRequest"}}},"required":["paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"item":{"$ref":"#/components/schemas/SandboxItem"},"levelDescriptor":{"$ref":"#/components/schemas/SandboxItem"},"children":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"}}}},"missingItems":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/exists":{"get":{"tags":["content"],"summary":"Check the existence of a content path","description":"Required permission \"content_read\"","operationId":"contentExists","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"item path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"exists":{"type":"boolean"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_by_path":{"get":{"tags":["content"],"summary":"Get item details for given an item path","description":"Required permission \"get_children\"","operationId":"getDetailedItemByPath","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"item path","required":true,"schema":{"type":"string"}},{"name":"preferContent","in":"query","description":"when set to true, return an item instead of a folder if the path can match either","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"$ref":"#/components/schemas/DetailedItem"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/sandbox_items_by_path":{"post":{"tags":["content"],"summary":"Get list of items for given item paths","description":"Required permission \"get_children\" and \"site member\"","operationId":"getSandboxItemsByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"paths":{"description":"item paths to get","type":"array","items":{"type":"string"}},"preferContent":{"description":"when set to true, return an item instead of a folder if the path can match either","type":"boolean"}},"required":["siteId","paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}},"missingItems":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/descriptor":{"get":{"tags":["content"],"summary":"Get the XML descriptor for a given path","operationId":"getDescriptor","parameters":[{"name":"siteId","in":"query","description":"The site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"The path of the descriptor","required":true,"schema":{"type":"string"}},{"name":"flatten","in":"query","description":"Indicates if included descriptors should be flattened","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"xml":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/paste":{"post":{"tags":["content"],"summary":"Paste a tree of items to a target path (copy content or move content).\nTo be used by the UI in the clipboard implementation.","description":"Required permission \"Write\"","operationId":"pasteItems","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasteRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"description":"The list of pasted items","type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/duplicate":{"post":{"tags":["content"],"summary":"Duplicate the given item in the same location","description":"Required permission \"Write\"","operationId":"duplicateItem","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"path":{"type":"string","description":"The path of the item to duplicate"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"description":"the path of the new item","type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_lock_by_path":{"post":{"tags":["content"],"summary":"Lock item by path","description":"Required permission \"content_write\"","operationId":"itemLockByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"path":{"type":"string","description":"Path of item to lock"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Item already locked","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"person":{"$ref":"#/components/schemas/Person"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_unlock_by_path":{"post":{"tags":["content"],"summary":"Unlock item by path","description":"Required permission \"item_unlock\" or lock owner","operationId":"itemUnlockByPath","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"path":{"type":"string","description":"The path of the item to unlock"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Item already unlocked","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/get_content_by_commit_id":{"get":{"tags":["content"],"summary":"Get content for commit id","description":"Required permission \"content_read\"","operationId":"getContentByCommitId","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path of the content","required":true,"schema":{"type":"string"}},{"name":"commitId","in":"query","description":"commit id of the content version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"content":{"type":"string","description":"requested content"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/content/item_history":{"get":{"tags":["content"],"summary":"Get history for a content item","description":"Required permission \"content_read\"","operationId":"getItemHistory","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path of the content","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"history":{"type":"array","items":{"$ref":"#/components/schemas/ItemVersion"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dependency/dependencies":{"post":{"tags":["dependency"],"summary":"Get list of dependencies for given content paths","description":"Required permission \"content_read\"","operationId":"getDependencies","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"paths":{"description":"Content paths to get dependencies for","type":"array","items":{"type":"string"}}},"required":["siteId","paths"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"object","properties":{"hardDependencies":{"type":"array","items":{"type":"string"}},"softDependencies":{"type":"array","items":{"type":"string"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dependency/dependent_items":{"get":{"tags":["dependent_items"],"summary":"Get list of dependent items for given content path","description":"Required permission \"content_read\"","operationId":"getDependentItems","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"Site ID","type":"string"},"path":{"description":"Content path to get dependencies for","type":"string"}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DependencyItem"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/search":{"get":{"tags":["marketplace"],"summary":"Search for compatible plugins in the marketplace","operationId":"searchPlugins","parameters":[{"name":"type","in":"query","description":"Plugin type to search (e.g. blueprint, control, datasource)","schema":{"type":"string"}},{"name":"keywords","in":"query","description":"The keywords to filter plugins","schema":{"type":"string"}},{"name":"showPending","description":"Include plugins pending of approval (default to false)","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"offset","in":"query","description":"Offset for pagination","schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Limit for pagination","schema":{"type":"integer","format":"int64"}},{"name":"showIncompatible","in":"query","description":"Include incompatible plugins (defaults to false)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"items":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MarketplacePlugin"},{"$ref":"#/components/schemas/GitMarketplacePlugin"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/installed":{"get":{"tags":["marketplace"],"summary":"Get the list of marketplace plugins installed in the given site","description":"Required permission \"list_plugins\"","operationId":"getInstalledPlugins","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"plugins":{"type":"array","items":{"$ref":"#/components/schemas/PluginRecord"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/install":{"post":{"tags":["marketplace"],"summary":"Install a marketplace plugin in the given site","description":"Required permission \"install_plugins\"","operationId":"installPlugin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"The id of the site","type":"string"},"pluginId":{"description":"The id of the plugin","type":"string"},"pluginVersion":{"$ref":"#/components/schemas/Version"},"parameters":{"type":"object","description":"Object containing all parameters for the plugin. It should include all required parameters from the descriptor","additionalProperties":{"type":"string"}}},"required":["siteId","pluginId","pluginVersion"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/copy":{"post":{"tags":["marketplace"],"summary":"Copy a local plugin to a given site","description":"Required permission \"install_plugins\"","operationId":"copyPlugin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"The id of the site","type":"string"},"path":{"description":"The path of the local plugin source folder","type":"string"},"parameters":{"type":"object","description":"Object containing all parameters for the plugin. It should include all required parameters from the descriptor","additionalProperties":{"type":"string"}}},"required":["siteId","path"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/remove":{"post":{"tags":["marketplace"],"summary":"Remove a marketplace plugin from the given site","description":"Required permission \"remove_plugins\"","operationId":"removePlugin","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"description":"The id of the site","type":"string"},"pluginId":{"description":"The id of the plugin","type":"string"},"force":{"description":"Indicates if the plugin should be removed even if there are dependant items"}},"required":["siteId","pluginId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/marketplace/usage":{"get":{"tags":["marketplace"],"summary":"List dependant items for a plugin","description":"Required permission \"remove_plugins\"","operationId":"pluginUsage","parameters":[{"name":"siteId","description":"The id of the site","schema":{"type":"string"},"required":true,"in":"query"},{"name":"pluginId","description":"The id of the plugin","schema":{"type":"string"},"required":true,"in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"string"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/all":{"post":{"tags":["publishing"],"summary":"Publishes the entire project to the target (staging or live)","description":"Required permission \"Publish\"","operationId":"publishAll","requestBody":{"description":"publish all request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"publishingTarget":{"type":"string","description":"the publishing target (staging or live)"},"submissionComment":{"type":"string","description":"optional submission comment"}},"required":["siteId","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/packages":{"get":{"tags":["publishing"],"summary":"Get the list of packages in the publishing queue","description":"Required permission \"get_publishing_queue\"","operationId":"PublishingPackages","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"publishingTarget","in":"query","description":"filter by publishing target","required":false,"schema":{"type":"string"}},{"name":"path","in":"query","description":"regular expression to filter by path","required":false,"schema":{"type":"string"}},{"name":"states","in":"query","description":"filter by package state(s)","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"offset","in":"query","description":"Offset for pagination","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"limit","in":"query","description":"Limit for pagination","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/PublishingPackage"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/package":{"get":{"tags":["publishing"],"summary":"Get package details","description":"Required permission \"get_publishing_queue\"","operationId":"getPublishingPackageDetails","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"packageId","in":"query","description":"package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"package":{"$ref":"#/components/schemas/PublishingPackageDetails"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/cancel":{"post":{"tags":["publishing"],"summary":"Cancel publishing packages","description":"Required permission \"cancel_publish\"","operationId":"cancelPublishingPackages","requestBody":{"description":"cancel publishing packages request body","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"packageIds":{"type":"array","description":"packageIds","items":{"type":"string"}}},"required":["siteId","packageIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/status":{"get":{"tags":["publishing"],"summary":"Get publishing status for site","description":"Required permission \"publish_status\"","operationId":"getPublishingStatus","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingStatus":{"$ref":"#/components/schemas/PublishingStatus"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/history":{"get":{"deprecated":true,"tags":["publishing"],"summary":"Get publishing history for site","description":"Required permission \"publish\". This operation is deprecated, use /api/2/dashboard/publishing/history instead.","operationId":"getPublishingHistory","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","description":"number of days to display history for","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"num","in":"query","description":"number of items to fetch","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filterType","in":"query","description":"filter items by type (all, page, component, asset)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingStatus":{"$ref":"#/components/schemas/DeploymentHistoryGroup"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/available_targets":{"get":{"tags":["publishing"],"summary":"Get available publishing targets for site","description":"Required permission \"publish\"","operationId":"getAvailablePublishingTargets","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingTargets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Target name"},"order":{"type":"integer","format":"int32","description":"order for display in the dropdown"}}}},"published":{"type":"boolean","description":"true if site has been published at least once (initial publish; published repository exist), otherwise false"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/publish/has_initial_publish":{"get":{"tags":["publishing"],"summary":"Check if site has initial publish","description":"Required permission \"content_read\"","operationId":"hasInitialPublish","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"hasInitialPublish":{"type":"boolean","description":"true if site has been published at least once (initial publish; published repository exist), otherwise false"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/encrypt":{"post":{"tags":["security"],"summary":"Encrypt a text value","operationId":"encrypt","description":"Required permission \"encryption_tool\"","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"item":{"type":"string"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/tokens":{"get":{"tags":["security"],"summary":"Get all existing tokens for the current user","operationId":"getAccessTokens","description":"Required permission \"manage_access_token\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/AccessToken"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["security"],"summary":"Creates a new access token for the current user","operationId":"createAccessToken","description":"Required permission \"manage_access_token\"","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The label for the access token"},"expiresAt":{"type":"string","format":"date-time","description":"The date of expiration for the access token"}},"required":["label"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"token":{"$ref":"#/components/schemas/AccessToken"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/tokens/{id}":{"post":{"tags":["security"],"summary":"Updates an access token for the current user","operationId":"updateAccessToken","description":"Required permission \"manage_access_token\"","parameters":[{"name":"id","in":"path","schema":{"type":"integer","format":"int64"},"description":"The id of the access token to update","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Indicates if the access token is enabled"}},"required":["enabled"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"token":{"$ref":"#/components/schemas/AccessToken"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"delete":{"tags":["security"],"summary":"Deletes an access token for the current user","operationId":"deleteAccessToken","description":"Required permission \"manage_access_token\"","parameters":[{"name":"id","in":"path","schema":{"type":"integer","format":"int64"},"description":"The id of the access token to delete","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/security/preview/switch":{"post":{"tags":["security"],"summary":"Configures preview to use a different site. Site is expected to be set in `crafterSite` cookie","operationId":"switchPreviewSite","description":"Required permission \"LOGGED_IN\"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/activity":{"get":{"tags":["dashboard"],"summary":"Get user activities","description":"Required permission \"site_member\"","operationId":"getDashboardActivities","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"usernames","in":"query","description":"filter activities for given users only","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"actions","in":"query","description":"filter activities for given actions only","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/activity/me":{"get":{"tags":["dashboard"],"summary":"Get current user's activities","description":"Required permission \"site_member\"","operationId":"getDashboardMyActivities","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"actions","in":"query","description":"filter activities for given actions only","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/pending_approval":{"get":{"tags":["dashboard"],"summary":"Get publishing packages that are pending for approval","description":"Required permission \"site_member\"","operationId":"getDashboardContentPendingApproval","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}},{"name":"sort","schema":{"type":"string"},"in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by commas. Example: `dateModified asc, label desc`. Supported fields: `id` `dateModified` `label`. Default `dateModified desc`"},{"name":"itemType","in":"query","description":"The system types to filter the results by. Multiple types are separated by commas. Example: `renderingTemplate, asset`.Supported values: `asset` `component` `content type` `document` `file` `folder` `levelDescriptor` `page` `renderingTemplate` `script` `taxonomy`","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingItems":{"type":"array","items":{"$ref":"#/components/schemas/DetailedItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/pending_approval/{id}":{"get":{"tags":["dashboard"],"summary":"Get content items of the package that is pending for approval","description":"Required permission \"site_member\"","operationId":"getDashboardContentPendingApprovalDetail","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingPackageItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/unpublished":{"get":{"tags":["dashboard"],"summary":"Get unpublished items for site","description":"Required permission \"content_read\"","operationId":"getDashboardContentUnpublished","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by commas. Example: `dateModified asc, label desc`. Supported fields: `id` `dateModified` `label`. Default `dateModified desc`","schema":{"type":"string"}},{"name":"itemType","in":"query","description":"The system types to filter the results by. Multiple types are separated by commas. Example: `renderingTemplate, asset`. Supported values: `asset` `component` `content type` `document` `file` `folder` `levelDescriptor` `page` `renderingTemplate` `script` `taxonomy`","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"unpublishedItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/scheduled":{"get":{"tags":["dashboard"],"summary":"Get scheduled publishing items","description":"Required permission \"content_read\"","operationId":"getPublishingScheduled","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"publishingTarget","in":"query","description":"publishing target to filter results","required":false,"schema":{"type":"string"}},{"name":"approver","in":"query","description":"approver user to filter results","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"The fields to use for sorting, plus the `asc` or `desc` keyword case-insensitive. Multiple fields are separated by commas. Example: `dateScheduled asc, label desc`. Supported fields: `id` `dateScheduled` `label`. Default `dateScheduled desc`","schema":{"type":"string"}},{"name":"itemType","in":"query","description":"The system types to filter the results by. Multiple types are separated by commas. Example: `renderingTemplate, asset`. Supported values: `asset` `component` `content type` `document` `file` `folder` `levelDescriptor` `page` `renderingTemplate` `script` `taxonomy`","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingItems":{"type":"array","items":{"$ref":"#/components/schemas/DetailedItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/scheduled/{id}":{"get":{"tags":["dashboard"],"summary":"Get content items of the package that is scheduled","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingScheduledDetail","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"package ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingPackageItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/history":{"get":{"tags":["dashboard"],"summary":"Get history of published packages","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingHistory","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"publishingTarget","in":"query","description":"publishing target to filter results","required":false,"schema":{"type":"string"}},{"name":"approver","in":"query","description":"approver user to filter results","required":false,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingPackages":{"type":"array","items":{"$ref":"#/components/schemas/DashboardPublishingPackage"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/history/{id}":{"get":{"tags":["dashboard"],"summary":"Get content items of the package that was published","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingHistoryDetail","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"package ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"publishingPackageItems":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/publishing/stats":{"get":{"tags":["dashboard"],"summary":"Get publishing stats","description":"Required permission \"content_read\"","operationId":"getDashboardPublishingStats","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","description":"number of days to display stats for","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"publishingStats":{"$ref":"#/components/schemas/PublishingStats"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/expiring":{"get":{"tags":["dashboard"],"summary":"Get content that is expiring","description":"Required permission \"site_member\"","operationId":"getDashboardContentExpiring","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary to filter by date-time range","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"upper boundary to filter by date-time range","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"object","properties":{"itemName":{"type":"string","description":"internal name"},"itemPath":{"type":"string","description":"content path"},"expireDateTime":{"type":"string","format":"date-time","description":"date and time when content expires"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/dashboard/content/expired":{"get":{"tags":["dashboard"],"summary":"Get content that expired","description":"Required permission \"site_member\"","operationId":"getDashboardContentExpired","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"offset of the first result item, default 0","required":false,"schema":{"type":"integer"}},{"name":"limit","in":"query","description":"number of results to return, default 10","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"type":"object","properties":{"itemName":{"type":"string","description":"internal name"},"itemPath":{"type":"string","description":"content path"},"expiredDateTime":{"type":"string","format":"date-time","description":"date and time when content expired"}}}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/item_states":{"get":{"tags":["workflow"],"summary":"Get item workflow states for site","description":"Required permission \"get_item_states\"","operationId":"getItemStates","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path regex","required":false,"schema":{"type":"string"}},{"name":"states","in":"query","description":"states bitmap mask","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["workflow"],"summary":"Set item workflow states for site","description":"Required permission \"set_item_states\"","operationId":"setItemStates","requestBody":{"description":"List of items to set workflow state(s)","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"items":{"type":"array","description":"path(s) of item(s)","items":{"type":"string"}},"clearSystemProcessing":{"type":"boolean","description":"true if system processing is to be cleared"},"clearUserLocked":{"type":"boolean","description":"true if user lock is to be cleared"},"live":{"type":"boolean","description":"true if item is to be set as live, otherwise false"},"staged":{"type":"boolean","description":"true if item is to be set as staged, otherwise false"},"new":{"type":"boolean","description":"true if item is to be set as new, otherwise false"},"modified":{"type":"boolean","description":"true if item is to be set as modified, otherwise false"}},"required":["siteId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/update_item_states_by_query":{"post":{"tags":["workflow"],"summary":"Set item workflow states for site using query","description":"Required permission \"set_item_states\"","operationId":"updateItemStates","requestBody":{"description":"List of items to set workflow state(s)","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"object","properties":{"siteId":{"type":"string","description":"site ID"},"path":{"type":"string","description":"path regex of item(s)"},"states":{"type":"integer","format":"int64","description":"state bitmap mask to filter by state"}},"required":["siteId","paths"]},"update":{"type":"object","properties":{"clearSystemProcessing":{"type":"boolean","description":"true if system processing is to be cleared"},"clearUserLocked":{"type":"boolean","description":"true if user lock is to be cleared"},"live":{"type":"boolean","description":"true if item is to be set as live, otherwise false"},"staged":{"type":"boolean","description":"true if item is to be set as staged, otherwise false"},"new":{"type":"boolean","description":"true if item is to be set as new, otherwise false"},"modified":{"type":"boolean","description":"true if item is to be set as modified, otherwise false"}}}},"required":["query","update"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/affected_paths":{"get":{"tags":["workflow"],"summary":"Get workflow affected paths","description":"Required permission \"content_read\"","operationId":"getWorkflowAffectedPaths","parameters":[{"name":"siteId","in":"query","description":"site ID","required":true,"schema":{"type":"string"}},{"name":"path","in":"query","description":"path of the content","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"items":{"type":"array","items":{"$ref":"#/components/schemas/SandboxItem"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/request_publish":{"post":{"tags":["workflow"],"summary":"Request publish for content","description":"Required permission \"site_member\"","operationId":"workflowRequestPublish","requestBody":{"description":"parameters for request publish","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target to publish content to"},"schedule":{"type":"string","format":"datetime","description":"schedule when to publish content"},"comment":{"type":"string","description":"comment about publish request"},"sendEmailNotifications":{"type":"boolean","description":"if true, send email notifications"}},"required":["siteId","items","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/publish":{"post":{"tags":["workflow"],"summary":"Publish content","description":"Required permission \"publish\"","operationId":"workflowPublish","requestBody":{"description":"parameters for publish content","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target to publish content to"},"schedule":{"type":"string","format":"datetime","description":"schedule when to publish content"},"comment":{"type":"string","description":"submission comment by publisher"}},"required":["siteId","items","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/approve":{"post":{"tags":["workflow"],"summary":"Approve request publish submission","description":"Required permission \"publish\"","operationId":"workflowApprove","requestBody":{"description":"parameters for approve request publish submission","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"optionalDependencies":{"type":"array","description":"optional (soft) dependencies","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target to publish content to"},"schedule":{"type":"string","format":"datetime","description":"schedule when to publish content"},"comment":{"type":"string","description":"Reviewer's comment"}},"required":["siteId","items","publishingTarget"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/reject":{"post":{"tags":["workflow"],"summary":"Reject request publish submission","description":"Required permission \"publish\"","operationId":"workflowReject","requestBody":{"description":"parameters for reject request publish submission","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"items":{"type":"array","description":"path(s) of content item(s)","items":{"type":"string"}},"comment":{"type":"string","description":"Reviewer's rejection comment"}},"required":["siteId","items"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages":{"get":{"tags":["workflow"],"summary":"List workflow packages order by scheduled date","description":"Required permission \"request_publish, publish\"","operationId":"workflowListPackage","parameters":[{"name":"siteId","in":"query","description":"filter workflow packages by site","required":true,"schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"lower boundary for filtering results by scheduled date","required":false,"schema":{"type":"string","format":"date"}},{"name":"dateTo","in":"query","description":"upper boundary for filtering results by scheduled date","required":false,"schema":{"type":"string","format":"date"}},{"name":"offset","in":"query","description":"Offset of the first package in the response","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Number of packages to return","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"order","in":"query","description":"ascending or descending (ASC | DESC). Default ascending","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"total":{"type":"integer","format":"int32","description":"Total records in the system"},"offset":{"type":"integer","format":"int32","description":"Offset of first record in this response"},"limit":{"type":"integer","format":"int32","description":"Number of records returned in this response"},"packages":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowPackage"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"post":{"tags":["workflow"],"summary":"Create workflow package","description":"Required permission \"request_publish, publish\"","operationId":"workflowCreatePackage","requestBody":{"description":"parameters to create new workflow package","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"paths":{"type":"array","description":"paths of content items to add to package","items":{"type":"string"}},"publishingTarget":{"type":"string","description":"target where to publish content"},"schedule":{"type":"string","format":"datetime","description":"schedule when publishing should be performed"},"authorComment":{"type":"string","description":"author's comment about the package"},"label":{"type":"string","description":"user friendly name for the package"}},"required":["siteId","paths","publishingTarget"]}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}},"patch":{"tags":["workflow"],"summary":"Update workflow package","description":"Required permission \"request_publish, publish\"","operationId":"workflowUpdatePackage","requestBody":{"description":"Workflow package entity to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowPackage"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"package":{"$ref":"#/components/schemas/WorkflowPackage"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages/{id}":{"get":{"tags":["workflow"],"summary":"Get workflow package by id","description":"Required permission \"request_publish, publish\"","operationId":"workflowGetPackage","parameters":[{"name":"id","in":"path","description":"The workflow package ID","required":true,"schema":{"type":"string","format":"UUID"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"package":{"$ref":"#/components/schemas/WorkflowPackage"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages/approve":{"post":{"tags":["workflow"],"summary":"Approve workflow package","description":"Required permission \"publish\"","operationId":"workflowApprovePackage","requestBody":{"description":"parameters to approve a workflow package","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"packages":{"type":"array","items":{"type":"object","properties":{"packageId":{"type":"string","description":"Id of the workflow package to approve"},"approverComment":{"type":"string","description":"approver's comment about approved workflow package"}},"required":["packageId","approverComment"]}},"schedule":{"type":"string","format":"datetime","description":"approved schedule when to publish package"}},"required":["siteId","packages"]}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/workflow/packages/reject":{"post":{"tags":["workflow"],"summary":"Create workflow package","description":"Required permission \"request_publish, publish\"","operationId":"workflowRejectPackage","requestBody":{"description":"parameters to create new workflow package","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"packages":{"type":"array","items":{"type":"object","properties":{"packageId":{"type":"string","description":"Id of the workflow package to approve"},"rejectionComment":{"type":"string","description":"approver's comment about approved workflow package"}},"required":["packageId","rejectionComment"]}}},"required":["siteId","packages"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/loggers":{"get":{"tags":["loggers"],"summary":"Get all loggers and their configured priority levels","description":"Required permission \"view_log_levels or configure_log_levels\"","operationId":"loggersGetAll","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LoggerConfig"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}}}},"/api/2/loggers/logger_level":{"post":{"tags":["loggers"],"summary":"Update logger priority level","description":"Required permission \"configure_log_levels\"","operationId":"loggersUpdateLevel","requestBody":{"description":"parameters to update the logger level","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggerConfigRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"},"result":{"$ref":"#/components/schemas/LoggerConfig"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}},"components":{"schemas":{"ApiResponse":{"type":"object","description":"The response of an API operation. Possible responses are:\n  * `CODE:` 0, `MESSAGE:` OK\n  * `CODE:` 1, `MESSAGE:` Created\n  * `CODE:` 2, `MESSAGE:` Deleted\n  * `CODE:` 3, `MESSAGE:` Completed with errors\n  * `CODE:` 1000, `MESSAGE:` Internal system failure, `REMEDIAL ACTION:` Contact support\n  * `CODE:` 1001, `MESSAGE:` Invalid parameter(s), `REMEDIAL ACTION:` Check API and make sure you're sending the correct parameters\n  * `CODE:` 2000, `MESSAGE:` Unauthenticated, `REMEDIAL ACTION:` Please login first\n  * `CODE:` 2001, `MESSAGE:` Unauthorized, `REMEDIAL ACTION:` You don't have permission to perform this task, please contact your administrator\n  * `CODE:` 3000, `MESSAGE:` Organization not found, `REMEDIAL ACTION:` Check if you sent in the right Org Id\n  * `CODE:` 3001, `MESSAGE:` Organization already exists, `REMEDIAL ACTION:` Try a different organization name\n  * `CODE:` 4000, `MESSAGE:` Group not found, `REMEDIAL ACTION:` Check if you sent in the right Group Id\n  * `CODE:` 5000, `MESSAGE:` Site not found, `REMEDIAL ACTION:` Check if you sent in the right Site Id\n  * `CODE:` 5001, `MESSAGE:` Site already exists, `REMEDIAL ACTION:` Try a different site name\n  * `CODE:` 6000, `MESSAGE:` User not found, `REMEDIAL ACTION:` Check if you're using the correct User ID or username\n  * `CODE:` 6001, `MESSAGE:` User already exists, `REMEDIAL ACTION:` Try a different username\n  * `CODE:` 6002, `MESSAGE:` User is externally managed, `REMEDIAL ACTION:` Update the user in the main identity system (e.g. LDAP)\n  * `CODE:` 6003, `MESSAGE:` User password does not fulfill requirements, `REMEDIAL ACTION:` Use password that will fulfill password requirements\n  * `CODE:` 6004, `MESSAGE:` User current password does not match, `REMEDIAL ACTION:` Use correct current password\n  * `CODE:` 7000, `MESSAGE:` Content not found, `REMEDIAL ACTION:` Check if you sent in the right Content Id\n  * `CODE:` 7001, `MESSAGE:` Content already exists, `REMEDIAL ACTION:` Edit the existing item or delete it before creating it again\n  * `CODE:` 7002, `MESSAGE:` Content already locked, `REMEDIAL ACTION:` The user that locked the item or the administrator must unlock the item first\n  * `CODE:` 7003, `MESSAGE:` Content already unlocked, `REMEDIAL ACTION:` The item is already unlocked\n  * `CODE:` 7004, `MESSAGE:` Paste destination folder is invalid (did you paste the item onto itself?), `REMEDIAL ACTION:` Try pasting the content to a different folder\n  * `CODE:` 8000, `MESSAGE:` Publishing is disabled, `REMEDIAL ACTION:` Advise the user to enable publishing\n  * `CODE:` 9000, `MESSAGE:` Search is unreachable, `REMEDIAL ACTION:` Advise the user that the search engine is not reachable\n  * `CODE:` 10000, `MESSAGE:` LoV not found, `REMEDIAL ACTION:` Check if you sent in the right LoV Id\n  * `CODE:` 11000, `MESSAGE:` Cluster member not found, `REMEDIAL ACTION:` Check if you sent in the right Cluster Member Id\n  * `CODE:` 11001, `MESSAGE:` Cluster member already exists, `REMEDIAL ACTION:` Get the list of cluster members to validate\n  * `CODE:` 12000, `MESSAGE:` Remote repository not found, `REMEDIAL ACTION:` Check if you sent in the right remote repository name\n  * `CODE:` 12001, `MESSAGE:` Remote repository already exists, `REMEDIAL ACTION:` Get the list of remote repositories to validate\n  * `CODE:` 12002, `MESSAGE:` Pull from remote repository resulted in conflict, `REMEDIAL ACTION:` Resolve conflicts before continuing work with repository\n  * `CODE:` 12003, `MESSAGE:` Remote is invalid. Not added to remote repositories, `REMEDIAL ACTION:` Add new remote repository with valid parameters.\n  * `CODE:` 12004, `MESSAGE:` Failed to remove remote repository, `REMEDIAL ACTION:` Contact your system administrator.\n  * `CODE:` 12005, `MESSAGE:` Push to remote repository failed, `REMEDIAL ACTION:` Check your repository settings or contact your system administrator.\n  * `CODE:` 12006, `MESSAGE:` Remove remote repository failed, `REMEDIAL ACTION:` The remote repository is a cluster node repository. It can't be removed.\n  * `CODE:` 12007, `MESSAGE:` Remote repository authentication failed, `REMEDIAL ACTION:` Recreate the remote repository with the correct authentication credentials and make sure you have write access.\n  * `CODE:` 40000, `MESSAGE:` Marketplace service is not initialized, `REMEDIAL ACTION:` Contact your system administrator.\n  * `CODE:` 40001, `MESSAGE:` Marketplace server is unreachable, `REMEDIAL ACTION:` Check the configuration to make sure the Marketplace URL is correct\n  * `CODE:` 40002, `MESSAGE:` Plugin is already installed, `REMEDIAL ACTION:` Check that the site id, plugin id and plugin version are correct\n  * `CODE:` 40003, `MESSAGE:` Error installing plugin, `REMEDIAL ACTION:` Check the plugin requirements\n  * `CODE:` 50003, `MESSAGE:` Target path does not exist in site repository, `REMEDIAL ACTION:` Check if you sent in the right Studio Path\n  * `CODE:` 52000, `MESSAGE:` AWS is unreachable, `REMEDIAL ACTION:` Advise the user that AWS engine is not reachable\n  * `CODE:` 53000, `MESSAGE:` Logger not found, `REMEDIAL ACTION:` Check if you sent in the right logger name or add 'createIfAbsent=true' parameter to create the logger if it does not exist","properties":{"code":{"type":"integer","format":"int32","description":"The response code"},"message":{"type":"string","description":"The detailed message of the response"},"remedialAction":{"type":"string","description":"What the user can do in order to address the issue indicated by the response"},"documentationUrl":{"type":"string","description":"A URL to documentation related to the response"}}},"UpdateUserRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID, unique and immutable"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"}},"required":["id","username","password","firstName","lastName","email","enabled","externallyManaged"]},"CreateUserRequest":{"type":"object","properties":{"username":{"type":"string","description":"Username, unique"},"password":{"type":"string","description":"User's password (not returned to caller)"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"},"externallyManaged":{"type":"boolean","description":"Indicates if a user is managed in by an external system (LDAP, SAML, etc.)"}},"required":["id","username","password","firstName","lastName","email","enabled","externallyManaged"]},"UserResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID, unique and immutable"},"username":{"type":"string","description":"Username, unique"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"},"externallyManaged":{"type":"boolean","description":"Indicates if a user is managed in by an external system (LDAP, SAML, etc.)"}},"required":["id","username","firstName","lastName","email","enabled","externallyManaged"]},"AuthenticatedUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"User ID, unique and immutable"},"username":{"type":"string","description":"Username, unique"},"firstName":{"type":"string","description":"User's first name"},"lastName":{"type":"string","description":"User's last name"},"email":{"type":"string","description":"User's email address"},"enabled":{"type":"boolean","description":"Indicates if the user is enabled"},"externallyManaged":{"type":"boolean","description":"Indicates if a user is managed in by an external system (LDAP, SAML, etc.)"},"authenticationType":{"type":"string","description":"The authentication type used to log in the user. Possible values are: DB, LDAP, AUTH_HEADERS"}},"required":["id","username","firstName","lastName","email","enabled","externallyManaged","authenticationType"]},"Group":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Group ID, unique and immutable"},"name":{"type":"string","description":"Group name, unique"},"desc":{"type":"string","description":"Group description"}},"required":["id","name"]},"UpdateGroupRequest":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Group ID, unique and immutable"},"desc":{"type":"string","description":"Group description"}},"required":["id","name"]},"Site":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID, unique and immutable"},"state":{"type":"string","description":"Site state, one of: INITIALIZING, READY, DELETING, DELETED"},"uuid":{"type":"string","description":"Site UUID unique and immutable"},"name":{"type":"string","description":"site name"},"desc":{"type":"string","description":"Site description"}},"required":["siteId"]},"MenuItem":{"type":"object","properties":{"id":{"type":"string","description":"Menu item ID, unique and immutable"},"label":{"type":"string","description":"Menu item label"},"icon":{"type":"string","description":"Menu item icon as a Font Awesome id, example: fa-smile"}},"required":["id","label","icon"]},"S3Item":{"type":"object","properties":{"name":{"type":"string","description":"Name of the item"},"url":{"type":"string","description":"URL of the item"},"folder":{"type":"boolean","description":"Indicates if the item is a folder"}},"required":["name","url","folder"]},"MediaConvertResult":{"type":"object","properties":{"jobId":{"type":"string","description":"The id of the triggered job"},"jobArn":{"type":"string","description":"The full ARN of the triggered job"},"urls":{"type":"array","description":"The list of files that will be generated by the triggered job","items":{"type":"string"}}},"required":["jobId","jobArn","urls"]},"WebDavItem":{"type":"object","properties":{"name":{"type":"string","description":"Name of the item"},"url":{"type":"string","description":"URL of the item"},"folder":{"type":"boolean","description":"Indicates if the item is a folder"}},"required":["name","url","folder"]},"ClusterMember":{"type":"object","properties":{"primary":{"type":"boolean","description":"True for primary node, false for replicas"},"localAddress":{"type":"string","description":"Cluster Member local IP address, immutable"},"state":{"type":"string","description":"Cluster Member state","enum":["ACTIVE","INACTIVE"]},"gitUrl":{"type":"string","description":"Git URL, unique"},"gitRemoteName":{"type":"string","description":"Git Remote Name, unique"}},"required":["localAddress","state","gitUrl","gitRemoteName","primary"]},"Version":{"type":"object","properties":{"major":{"type":"integer","format":"int32","description":"The major version"},"minor":{"type":"integer","format":"int32","description":"The minor version"},"patch":{"type":"integer","format":"int32","description":"The patch version"}},"required":["major","minor"]},"Link":{"type":"object","properties":{"name":{"type":"string","description":"The name of the link"},"url":{"type":"string","description":"The URL of the link"}},"required":["name","url"]},"Asset":{"type":"object","properties":{"title":{"type":"string","description":"The title of the asset"},"description":{"type":"string","description":"The description of the asset"},"url":{"type":"string","description":"The URL of the asset"}},"required":["title","url"]},"Parameter":{"type":"object","properties":{"label":{"type":"string","description":"The label to use for the parameter"},"name":{"type":"string","description":"The name of the parameter (must be camelCase)"},"description":{"type":"string","description":"The description of the parameter"},"defaultValue":{"type":"string","description":"The default value of the parameter"},"type":{"type":"string","description":"The type of the parameter. Currently supported values are STRING, PASSWORD"},"required":{"type":"boolean","description":"Indicates if the parameter is required"}}},"PluginDescriptor":{"type":"object","properties":{"descriptorVersion":{"type":"integer","description":"The version of the plugin descriptor"},"plugin":{"$ref":"#/components/schemas/Plugin"}}},"Plugin":{"type":"object","properties":{"type":{"type":"string","description":"The type of plugin"},"id":{"type":"string","format":"package name","description":"The plugin id"},"name":{"type":"string","description":"The plugin name"},"tags":{"type":"array","description":"The plugin tags","items":{"type":"string"}},"version":{"$ref":"#/components/schemas/Version"},"description":{"type":"string","description":"The plugin description"},"website":{"$ref":"#/components/schemas/Link"},"media":{"type":"object","properties":{"screenshots":{"type":"array","description":"The screenshots of the plugin","items":{"$ref":"#/components/schemas/Asset"}},"videos":{"type":"array","description":"The videos of the plugin","items":{"$ref":"#/components/schemas/Asset"}}}},"developer":{"type":"object","properties":{"people":{"type":"array","description":"The people that worked on the plugin","items":{"$ref":"#/components/schemas/Link"}},"company":{"$ref":"#/components/schemas/Link"}}},"license":{"$ref":"#/components/schemas/Link"},"crafterCmsVersions":{"type":"array","description":"The supported CrafterCMS versions of the plugin","items":{"$ref":"#/components/schemas/Version"}},"crafterCmsEditions":{"type":"array","description":"The supported CrafterCMS editions of the plugin","items":{"type":"string"}},"parameters":{"type":"array","description":"The parameters supported by the plugin","items":{"$ref":"#/components/schemas/Parameter"}}}},"MarketplacePlugin":{"allOf":[{"$ref":"#/components/schemas/Plugin"},{"type":"object","properties":{"status":{"description":"The status of this version of the plugin (possible values are 'PENDING' approval and 'APPROVED')","type":"string"},"source":{"description":"The source of the plugin","type":"string"},"compatible":{"description":"Indicates if the plugin is compatible","type":"boolean"}}}]},"MarketplaceRemotePlugin":{"allOf":[{"$ref":"#/components/schemas/MarketplacePlugin"},{"type":"object","properties":{"url":{"type":"string"}}}]},"GitMarketplacePlugin":{"allOf":[{"$ref":"#/components/schemas/MarketplaceRemotePlugin"},{"type":"object","properties":{"ref":{"type":"string"}}}]},"CreateSiteFromMarketplace":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID to use"},"description":{"type":"string","description":"Site description"},"sandboxBranch":{"type":"string","description":"Name for sandbox branch (default master)"},"remoteName":{"type":"string","description":"Remote repository name (default origin)"},"blueprintId":{"type":"string","description":"The ID of the blueprint to use"},"blueprintVersion":{"$ref":"#/components/schemas/Version"},"siteParams":{"type":"object","description":"Object containing all parameters for the blueprint. It should include all required parameters from the descriptor","additionalProperties":{"type":"string"}}},"required":["siteId","blueprintId","blueprintVersion"]},"PluginRecord":{"type":"object","properties":{"id":{"type":"string","description":"The id of the plugin"},"version":{"$ref":"#/components/schemas/Version"},"pluginUrl":{"type":"string","description":"The URL of the plugin"},"installationDate":{"type":"string","format":"date-time","description":"The date when the plugin was installed"},"files":{"type":"array","description":"The list of installed files","items":{"$ref":"#/components/schemas/FileRecord"}}}},"FileRecord":{"type":"object","properties":{"path":{"type":"string","description":"The path where the file was copied during installation"}}},"SearchParams":{"type":"object","properties":{"query":{"type":"string","description":"The main Lucene query to execute"},"keywords":{"type":"string","description":"The keywords to search in the files"},"path":{"type":"string","description":"Regular expression to filter the paths"},"offset":{"type":"integer","format":"int64","description":"The offset to paginate the results (defaults to 0)"},"limit":{"type":"integer","format":"int64","description":"The limit to paginate the results (defaults to 10)"},"sortBy":{"type":"string","description":"The name of the field to sort the results (defaults to sort by relevance)"},"sortOrder":{"type":"string","description":"The order to sort the results (defaults to DESC)"},"orOperator":{"type":"boolean","description":"Indicates if the filters should use an OR instead of an AND operator (defaults to false)"},"filters":{"type":"object","description":"Object containing facets to filter the search results. Facets can be simple key-value pairs like \"MIME Type\":\"text/css\" or nested objects for range facets like \"Width\": { \"min\": 0, \"max\": 150 }. Both keys and\n values can be taken from the facets object of a previous search.","additionalProperties":true}}},"SearchResult":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"Total number of results found"},"items":{"type":"array","description":"List of items based on the pagination parameters","items":{"$ref":"#/components/schemas/SearchResultItem"}},"facets":{"type":"array","description":"List of facets based on the results found","items":{"$ref":"#/components/schemas/SearchFacet"}}}},"SearchResultItem":{"type":"object","properties":{"path":{"type":"string","description":"The path of the file"},"name":{"type":"string","description":"The internal name of the file"},"type":{"type":"string","description":"The type of the file"},"mimeType":{"type":"string","description":"The MIME type of the file"},"previewUrl":{"type":"string","description":"The preview URL of the file"},"lastModifier":{"type":"string","description":"The last user that modified the file"},"lastModified":{"type":"string","format":"date-time","description":"The last date that the file was modified"},"size":{"type":"integer","format":"int64","description":"The size of the file, in bytes"},"snippets":{"type":"array","description":"Snippets relevant to the search query","items":{"type":"string"}}}},"SearchFacet":{"type":"object","properties":{"name":{"type":"string","description":"The label of the facet"},"range":{"type":"boolean","description":"Indicates if the values of the facet are ranges"},"date":{"type":"boolean","description":"Indicates if the values of the facet are dates"},"values":{"type":"object","description":"The values and counts of the facet. If the facet is a range the values will be of type SearchFacetRange, otherwise it will be a single integer.","properties":{"facet1":{"type":"object","properties":{"value1":{"type":"integer"}}},"facet2":{"$ref":"#/components/schemas/SearchFacetRange"}}}}},"SearchFacetRange":{"type":"object","properties":{"count":{"type":"integer","format":"int64","description":"The number of files that match the range"},"from":{"type":"object","description":"The starting limit of the range"},"to":{"type":"object","description":"The ending limit of the range"}}},"AuditLog":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Audit log entry ID"},"organizationId":{"type":"integer","format":"int64","description":"Organization ID"},"siteId":{"type":"string","format":"string","description":"Site Identifier"},"siteName":{"type":"string","format":"string","description":"Site name"},"operation":{"type":"string","description":"Operation that was executed"},"operationTimestamp":{"type":"string","description":"Timestamp when operation was executed"},"origin":{"type":"string","description":"Origin of operation (UI/API or Git)"},"primaryTargetId":{"type":"string","description":"Target ID upon which operation was executed"},"primaryTargetType":{"type":"string","description":"Type of the target"},"primaryTargetSubtype":{"type":"string","description":"Subtype of the target"},"primaryTargetValue":{"type":"string","description":"Value of the target (e.g. content's path)"},"actorId":{"type":"string","description":"Actor ID which invoked operation"},"actorDetails":{"type":"string","description":"Details of the actor which invoked"},"clusterNodeId":{"type":"string","description":"Cluster node Id"},"parameters":{"type":"array","description":"Additional parameters of audit log","items":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID upon which operation was executed"},"targetType":{"type":"string","description":"Type of the target"},"targetValue":{"type":"string","description":"Value of the target (e.g. content's path)"}},"required":["targetId","targetType","targetValue"]}}},"required":["id","organizationId","siteId","siteName","operation","operationTimestamp","origin","primaryTargetId","primaryTargetType","primaryTargetValue","actorId"]},"VersionItem":{"type":"object","properties":{"packageName":{"type":"string","description":"The name of the current package"},"packageVersion":{"type":"string","description":"The version of the current package"},"packageBuild":{"type":"string","description":"The build of the current package"},"packageBuildDate":{"type":"string","format":"date-time","description":"The build date of the current package"},"osName":{"type":"string","description":"The name of the operating system"},"osVersion":{"type":"string","description":"The version of the operating system"},"osArch":{"type":"string","description":"The architecture of the operating system"},"javaVersion":{"type":"string","description":"The version of java being used"},"javaVendor":{"type":"string","description":"The name of the JVM vendor"},"javaVm":{"type":"string","description":"The name of the JVM"}}},"StatusItem":{"type":"object","properties":{"uptime":{"type":"integer","format":"int64","description":"The time in seconds that the JVM has been up"},"startup":{"type":"string","format":"date-time","description":"The date and time when the JVM started"}}},"ClusterStatusItem":{"type":"object","properties":{"uptime":{"type":"integer","format":"int64","description":"The time in seconds that the JVM has been up"},"startup":{"type":"string","format":"date-time","description":"The date and time when the JVM started"},"age":{"type":"integer","format":"int64","description":"The time in seconds that the cluster node has been up"},"role":{"type":"string","description":"Role that the node has in the cluster. Possible values PRIMARY, REPLICA, UNASSIGNED"},"readyToTakeTraffic":{"type":"boolean","description":"True if the cluster node is ready to take traffic. Typically it is a Primary node"},"readyToBecomePrimary":{"type":"boolean","description":"True if the cluster node is a Replica and in sync with the Primary node"}}},"MemoryItem":{"type":"object","properties":{"totalJvmMemory":{"type":"integer","format":"int64","description":"The memory in bytes used by the JVM"},"freeJvmMemory":{"type":"integer","format":"int64","description":"The remaining memory in bytes for the JVM"},"maxJvmMemory":{"type":"integer","format":"int64","description":"The maximum memory in bytes available to the JVM"},"totalOsMemory":{"type":"integer","format":"int64","description":"The total memory in bytes available for the operating system"},"freeOsMemory":{"type":"integer","format":"int64","description":"The remaining memory in bytes for the operating system"},"totalSwapMemory":{"type":"integer","format":"int64","description":"The total memory in bytes available for swap space"},"freeSwapMemory":{"type":"integer","format":"int64","description":"The remaining memory in bytes for swap space"}}},"LogEvent":{"type":"object","properties":{"exception":{"type":"string","description":"The exception message if any"},"site":{"type":"string","description":"The site name"},"level":{"type":"string","description":"The level of the log event"},"thread":{"type":"string","description":"The name of the thread"},"message":{"type":"string","description":"The message of the log event"},"timestamp":{"type":"string","format":"datetime","description":"The timestamp of the log event"},"timestampm":{"type":"integer","format":"int64","description":"The time in milliseconds of the log event"}}},"DiskUsage":{"type":"object","properties":{"diskUsage":{"type":"integer","format":"int32","description":"The disk usage percentage","example":75},"totalSpace":{"type":"integer","format":"int64","description":"The total disk space in bytes"},"freeSpace":{"type":"integer","format":"int64","description":"The free disk space in bytes"},"usedSpace":{"type":"integer","format":"int64","description":"The used disk space in bytes"},"alarm":{"type":"boolean","description":"True if free space is too low"},"highWaterMark":{"type":"integer","format":"int32","description":"The high water mark percentage for disk usage","example":90},"lowWaterMark":{"type":"integer","format":"int32","description":"The low water mark percentage for disk usage","example":85},"alarmDate":{"type":"string","format":"date-time","description":"The date and time when the disk usage alarm was triggered"},"lastCheck":{"type":"string","format":"date-time","description":"The date and time when the last disk usage check was performed"},"lastCleanup":{"type":"string","format":"date-time","description":"The date and time when the last disk cleanup was performed"}}},"RemoteRepository":{"type":"object","properties":{"siteId":{"type":"string","description":"site identifier"},"remoteName":{"type":"string","description":"remote repository name"},"remoteUrl":{"type":"string","format":"URL","description":"URL to access remote repository"},"authenticationType":{"type":"string","description":"Authentication type to use to access remote repository\nPossible values:\n\n  - none: no authentication\n\n  - basic: username and password authentication\n\n  - token: token authentication\n\n  - key: key-based authentication"},"remoteUsername":{"type":"string","description":"username to use to access remote repository"},"remotePassword":{"type":"string","description":"password to use to access remote repository"},"remoteToken":{"type":"string","description":"token to use to access remote repository"},"remotePrivateKey":{"type":"string","description":"private key to access"}},"required":["siteId","remoteName","remoteUrl","authenticationType"]},"RemoteRepositoryInfo":{"type":"object","properties":{"name":{"type":"string","description":"remote repository name"},"url":{"type":"string","description":"remote repository url"},"fetch":{"type":"string","description":"remote repository fetch references"},"push_url":{"type":"string","description":"remote repository push url"},"branches":{"type":"array","items":{"type":"string","description":"remote repository branch name"}},"reachable":{"type":"boolean","description":"true if remote repository is reachable, otherwise false"},"unreachableReason":{"type":"string","description":"reason why remote is unreachable"},"removable":{"type":"boolean","description":"true if remote repository can be removed, otherwise false"}}},"QuickCreateItem":{"type":"object","properties":{"siteId":{"type":"string","description":"site id"},"label":{"type":"string","description":"user friendly label for content type name"},"contentTypeId":{"type":"string","description":"content type id"},"path":{"type":"string","description":"path expression to generate path for quick create"}}},"RepositoryStatus":{"type":"object","properties":{"conflicting":{"type":"array","description":"list of conflicting files","items":{"type":"string"}},"uncommittedChanges":{"type":"array","description":"list of added files","items":{"type":"string"}},"clean":{"type":"boolean","description":"true if there are no conflicts or uncommitted changes"}}},"History":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/ContentItem"},"versions":{"type":"array","description":"list of versions","items":{"$ref":"#/components/schemas/ItemVersion"}}}},"ContentItem":{"type":"object","description":"API v1 object"},"PublishingPackage":{"type":"object","properties":{"id":{"type":"string","description":"package ID"},"siteId":{"type":"string","description":"site ID"},"schedule":{"type":"string","format":"datetime","description":"scheduled date and time"},"approver":{"type":"string","description":"user that approved publishing package"},"state":{"type":"string","description":"package state"},"publishingTarget":{"type":"string","description":"publishing target where package will be published"},"comment":{"type":"string","description":"submission comment"}},"required":["id","siteId","schedule","approver","state","publishingTarget"]},"PublishingPackageDetails":{"type":"object","properties":{"id":{"type":"string","description":"package ID"},"siteId":{"type":"string","description":"site ID"},"schedule":{"type":"string","format":"datetime","description":"scheduled date and time"},"approver":{"type":"string","description":"user that approved publishing package"},"state":{"type":"string","description":"package state"},"publishingTarget":{"type":"string","description":"publishing target where package will be published"},"comment":{"type":"string","description":"submission comment"},"items":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"content item path"},"contentTypeClass":{"type":"string","description":"content type class"},"mimeType":{"type":"string","description":"mime-type"}}}}},"required":["id","schedule","approver","state","publishingTarget","items"]},"PublishingStatus":{"type":"object","properties":{"enabled":{"type":"boolean","description":"true if publishing for site is enabled, otherwise false"},"status":{"type":"string","description":"publishing status for site"},"lockOwner":{"type":"string","description":"studio instance owner of publishing lock"},"lockTTL":{"type":"string","description":"TTL timestamp for publishing lock"},"totalItems":{"type":"integer","format":"int32","description":"total number of item being published right now"},"numberOfItems":{"type":"integer","format":"int32","description":"number of items published so far"},"submissionId":{"type":"string","description":"identifier of a submission being published"},"publishingTarget":{"type":"string","description":"publishing target for package"},"published":{"type":"boolean","description":"true if site has been published at least once (initial publish; published repository exist), otherwise false"}},"required":["enabled","status","message","lockOwner","lockTTL"]},"DeploymentHistoryGroup":{"type":"object","properties":{"internalName":{"type":"string","description":"user friendly label"},"numberOfChildren":{"type":"integer","format":"int32","description":"number of items in the group"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ContentItem"}},"publishingTarget":{"type":"string","description":"publishing target where item was published"}},"required":["internalName","numberOfChildren","children","publishingTarget"]},"DependencyItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"}},"required":["id","label","path"]},"SandboxItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"parentId":{"type":"integer","format":"int64","description":"parent item ID"},"contentTypeId":{"type":"string","description":"content type of content item"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"},"previewUrl":{"type":"string","description":"url for previewing content item"},"systemType":{"type":"string","description":"one of predefined type values (page, component, asset, levelDescriptor, folder ...)"},"mimeType":{"type":"string","description":"mime-type of content item file"},"state":{"type":"integer","format":"int64","description":"bitmap of states\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: New, `DESCRIPTION`: The item is new and never been published\n  * `BIT ORDER (little-endian)`: 1: `FLAG`: Modified, `DESCRIPTION`: The item has been published in the past and has been modified in the sandbox\n  * `BIT ORDER (little-endian)`: 2: `FLAG`: Deleted, `DESCRIPTION`: The item is deleted\n  * `BIT ORDER (little-endian)`: 3: `FLAG`: User Locked, `DESCRIPTION`: The item is locked by a user\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: System Processing, `DESCRIPTION`: The item is locked by the system for processing\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: In Workflow, `DESCRIPTION`: The item has been submitted for review\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Scheduled, `DESCRIPTION`: The item has been scheduled for review or publishing ounce approved\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Publishing, `DESCRIPTION`: The item is being published\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Destination, `DESCRIPTION`: If the item is being published, the destination is staging if 0, and live if 1\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Staged, `DESCRIPTION`: The item has been pushed to the staging publishing target\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Live, `DESCRIPTION`: The item has been pushed to the live publishing target\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Disabled, `DESCRIPTION`: The item has been disabled\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Reserved 12, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Reserved 11, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Reserved 10, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Reserved 9, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Reserved 8, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Reserved 7, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Reserved 6, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Reserved 5, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Reserved 4, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Reserved 3, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Reserved 2, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Reserved 1, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Translation Up To Date, `DESCRIPTION`: This item is a translation of another and it’s up to date\n  * `BIT ORDER (little-endian)`: 25, `FLAG`: Translation Pending, `DESCRIPTION`: This item is a translation of another and it’s pending translation\n  * `BIT ORDER (little-endian)`: 26, `FLAG`: Translation in Progress, `DESCRIPTION`: This item is a translation of another and is currently being translated"},"lockOwner":{"$ref":"#/components/schemas/Person","description":"user that locked item for editing"},"localeCode":{"type":"string","description":"locale of content item"},"translationSourceId":{"type":"string","description":"ID of content item that is original for translation that current item represents"},"creator":{"$ref":"#/components/schemas/Person","description":"user that created the item"},"dateCreated":{"type":"string","format":"datetime","description":"timestamp when item was created"},"modifier":{"$ref":"#/components/schemas/Person","description":"last user that modified item"},"dateModified":{"type":"string","format":"datetime","description":"timestamp when was item last modified"},"submitter":{"$ref":"#/components/schemas/Person","description":"user that submitted item for review (if any)"},"dateSubmitted":{"type":"string","format":"datetime","description":"timestamp when item was submitted for review (if any)"},"sizeInBytes":{"type":"integer","format":"int64","description":"size of content item in the repository"},"expiresOn":{"type":"string","format":"datetime","description":"timestamp when the item will expire, can be null if not present/set"},"availableActions":{"type":"integer","format":"int64","description":"available actions bitmap\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: Content: Read, `DESCRIPTION`: Read content\n  * `BIT ORDER (little-endian)`: 1, `FLAG`: Content: Copy, `DESCRIPTION`: Copy content\n  * `BIT ORDER (little-endian)`: 2, `FLAG`: Content: Read Version History, `DESCRIPTION`: Read version history for content\n  * `BIT ORDER (little-endian)`: 3, `FLAG`: Content: Get Dependencies, `DESCRIPTION`: Get content dependencies\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: Publish: Request, `DESCRIPTION`: Request publish for content\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: Content: Create, `DESCRIPTION`: Create content\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Content: Paste, `DESCRIPTION`: Paste content\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Content: Edit, `DESCRIPTION`: Update content\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Content: Rename, `DESCRIPTION`: Rename or move content\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Content: Cut, `DESCRIPTION`: Cut content\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Content: Upload, `DESCRIPTION`: Upload content\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Content: Duplicate, `DESCRIPTION`: Duplicate content\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Content: Change Type, `DESCRIPTION`: Change content type\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Content: Revert, `DESCRIPTION`: Revert content\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Content: Edit controller, `DESCRIPTION`: Edit controller for content type\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Content: Edit template, `DESCRIPTION`: Edit rendering template\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Content: Create folder, `DESCRIPTION`: Create folder\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Content: Delete, `DESCRIPTION`: Delete content\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Content: Delete controller, `DESCRIPTION`: Delete content type controller\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Content: Delete template, `DESCRIPTION`: Delete rendering template\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Publish: Publish, `DESCRIPTION`: Publish content\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Publish: Approve, `DESCRIPTION`: Approve publish request\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Publish: Schedule, `DESCRIPTION`: Schedule publish\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Publish: Reject, `DESCRIPTION`: Reject publish request\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Content: Unlock, `DESCRIPTION`: Unlock content item"},"childrenCount":{"type":"integer","format":"int32","description":"number of children of the item"}},"required":["id","label","contentTypeId","path","previewUrl","systemType","mimeType","state","lockOwner","createdDate","creator","modifier","lastModifiedDate","commitId","availableActions"]},"DetailedItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"parentId":{"type":"integer","format":"int64","description":"parent item ID"},"contentTypeId":{"type":"string","description":"content type of content item"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"},"previewUrl":{"type":"string","description":"url for previewing content item"},"systemType":{"type":"string","format":"page, component, asset, levelDescriptor, folder","description":"type of item in CrafterCMS domain"},"mimeType":{"type":"string","description":"mime-type of content item file"},"state":{"type":"integer","format":"int64","description":"bitmap of states\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: New, `DESCRIPTION`: The item is new and never been published\n  * `BIT ORDER (little-endian)`: 1: `FLAG`: Modified, `DESCRIPTION`: The item has been published in the past and has been modified in the sandbox\n  * `BIT ORDER (little-endian)`: 2: `FLAG`: Deleted, `DESCRIPTION`: The item is deleted\n  * `BIT ORDER (little-endian)`: 3: `FLAG`: User Locked, `DESCRIPTION`: The item is locked by a user\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: System Processing, `DESCRIPTION`: The item is locked by the system for processing\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: In Workflow, `DESCRIPTION`: The item has been submitted for review\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Scheduled, `DESCRIPTION`: The item has been scheduled for review or publishing ounce approved\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Publishing, `DESCRIPTION`: The item is being published\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Destination, `DESCRIPTION`: If the item is being published, the destination is staging if 0, and live if 1\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Staged, `DESCRIPTION`: The item has been pushed to the staging publishing target\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Live, `DESCRIPTION`: The item has been pushed to the live publishing target\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Disabled, `DESCRIPTION`: The item has been disabled\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Reserved 12, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Reserved 11, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Reserved 10, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Reserved 9, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Reserved 8, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Reserved 7, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Reserved 6, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Reserved 5, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Reserved 4, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Reserved 3, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Reserved 2, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Reserved 1, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Translation Up To Date, `DESCRIPTION`: This item is a translation of another and it’s up to date\n  * `BIT ORDER (little-endian)`: 25, `FLAG`: Translation Pending, `DESCRIPTION`: This item is a translation of another and it’s pending translation\n  * `BIT ORDER (little-endian)`: 26, `FLAG`: Translation in Progress, `DESCRIPTION`: This item is a translation of another and is currently being translated"},"lockOwner":{"$ref":"#/components/schemas/Person","description":"user that locked item for editing"},"localeCode":{"type":"string","description":"locale of content item"},"translationSourceId":{"type":"string","description":"ID of content item that is original for translation that current item represents"},"expiresOn":{"type":"string","format":"datetime","description":"timestamp when the item will expire, can be null if not present/set"},"availableActions":{"type":"integer","format":"int64","description":"available actions bitmap\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: Content: Read, `DESCRIPTION`: Read content\n  * `BIT ORDER (little-endian)`: 1, `FLAG`: Content: Copy, `DESCRIPTION`: Copy content\n  * `BIT ORDER (little-endian)`: 2, `FLAG`: Content: Read Version History, `DESCRIPTION`: Read version history for content\n  * `BIT ORDER (little-endian)`: 3, `FLAG`: Content: Get Dependencies, `DESCRIPTION`: Get content dependencies\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: Publish: Request, `DESCRIPTION`: Request publish for content\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: Content: Create, `DESCRIPTION`: Create content\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Content: Paste, `DESCRIPTION`: Paste content\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Content: Edit, `DESCRIPTION`: Update content\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Content: Rename, `DESCRIPTION`: Rename or move content\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Content: Cut, `DESCRIPTION`: Cut content\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Content: Upload, `DESCRIPTION`: Upload content\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Content: Duplicate, `DESCRIPTION`: Duplicate content\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Content: Change Type, `DESCRIPTION`: Change content type\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Content: Revert, `DESCRIPTION`: Revert content\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Content: Edit controller, `DESCRIPTION`: Edit controller for content type\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Content: Edit template, `DESCRIPTION`: Edit rendering template\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Content: Create folder, `DESCRIPTION`: Create folder\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Content: Delete, `DESCRIPTION`: Delete content\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Content: Delete controller, `DESCRIPTION`: Delete content type controller\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Content: Delete template, `DESCRIPTION`: Delete rendering template\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Publish: Publish, `DESCRIPTION`: Publish content\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Publish: Approve, `DESCRIPTION`: Approve publish request\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Publish: Schedule, `DESCRIPTION`: Schedule publish\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Publish: Reject, `DESCRIPTION`: Reject publish request\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Content: Unlock, `DESCRIPTION`: Unlock content item"},"sandbox":{"type":"object","description":"metadata of content item version stored in sandbox repository","properties":{"creator":{"$ref":"#/components/schemas/Person","description":"user that created the item"},"dateCreated":{"type":"string","format":"datetime","description":"timestamp when item was created"},"modifier":{"$ref":"#/components/schemas/Person","description":"last user that modified sandbox version of item"},"dateModified":{"type":"string","format":"datetime","description":"timestamp when was item last modified in sandbox"},"submitter":{"$ref":"#/components/schemas/Person","description":"user that submitted item for publishing"},"dateSubmitted":{"type":"string","format":"datetime","description":"timestamp when item was submitted for review (if any)"},"sizeInBytes":{"type":"integer","format":"int64","description":"size of content item in the repository"}}},"staging":{"type":"object","description":"metadata of content item version stored in staging repository","properties":{"dateScheduled":{"type":"string","format":"datetime","description":"timestamp when is item scheduled for publishing to staging repository"},"datePublished":{"type":"string","format":"datetime","description":"timestamp when was item last time published to staging repository"},"publisher":{"type":"string","description":"username of last user that published item to staging repository"},"commitId":{"type":"string","description":"commit id of last modification in the staging repository"}}},"live":{"type":"object","description":"metadata of content item version stored in live repository","properties":{"dateScheduled":{"type":"string","format":"datetime","description":"timestamp when is item scheduled for publishing to live repository"},"datePublished":{"type":"string","format":"datetime","description":"timestamp when was item last time published to live repository"},"publisher":{"type":"string","description":"username of last user that published item to live repository"},"commitId":{"type":"string","description":"commit id of last modification in the live repository"}}},"childrenCount":{"type":"integer","format":"int32","description":"number of children of the item"}},"required":["id","label","contentTypeId","path","previewUrl","systemType","mimeType","state","lockOwner","staging","availableActions"]},"LocalizationItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"content item ID"},"label":{"type":"string","description":"user friendly display name for content item"},"parentId":{"type":"integer","format":"int64","description":"parent item ID"},"path":{"type":"string","description":"path where content item is stored inside repository (with filename)"},"previewUrl":{"type":"string","description":"url for previewing content item"},"systemType":{"type":"string","description":"one of predefined type values (page, component, asset, level descriptor, folder ...)"},"mimeType":{"type":"string","description":"mime-type of content item file"},"state":{"type":"integer","format":"int64","description":"bitmap of states\n  * `BIT ORDER (little-endian)`: 0, `FLAG`: New, `DESCRIPTION`: The item is new and never been published\n  * `BIT ORDER (little-endian)`: 1: `FLAG`: Modified, `DESCRIPTION`: The item has been published in the past and has been modified in the sandbox\n  * `BIT ORDER (little-endian)`: 2: `FLAG`: Deleted, `DESCRIPTION`: The item is deleted\n  * `BIT ORDER (little-endian)`: 3: `FLAG`: User Locked, `DESCRIPTION`: The item is locked by a user\n  * `BIT ORDER (little-endian)`: 4, `FLAG`: System Processing, `DESCRIPTION`: The item is locked by the system for processing\n  * `BIT ORDER (little-endian)`: 5, `FLAG`: In Workflow, `DESCRIPTION`: The item has been submitted for review\n  * `BIT ORDER (little-endian)`: 6, `FLAG`: Scheduled, `DESCRIPTION`: The item has been scheduled for review or publishing ounce approved\n  * `BIT ORDER (little-endian)`: 7, `FLAG`: Publishing, `DESCRIPTION`: The item is being published\n  * `BIT ORDER (little-endian)`: 8, `FLAG`: Destination, `DESCRIPTION`: If the item is being published, the destination is staging if 0, and live if 1\n  * `BIT ORDER (little-endian)`: 9, `FLAG`: Staged, `DESCRIPTION`: The item has been pushed to the staging publishing target\n  * `BIT ORDER (little-endian)`: 10, `FLAG`: Live, `DESCRIPTION`: The item has been pushed to the live publishing target\n  * `BIT ORDER (little-endian)`: 11, `FLAG`: Disabled, `DESCRIPTION`: The item has been disabled\n  * `BIT ORDER (little-endian)`: 12, `FLAG`: Reserved 12, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 13, `FLAG`: Reserved 11, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 14, `FLAG`: Reserved 10, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 15, `FLAG`: Reserved 9, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 16, `FLAG`: Reserved 8, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 17, `FLAG`: Reserved 7, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 18, `FLAG`: Reserved 6, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 19, `FLAG`: Reserved 5, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 20, `FLAG`: Reserved 4, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 21, `FLAG`: Reserved 3, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 22, `FLAG`: Reserved 2, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 23, `FLAG`: Reserved 1, `DESCRIPTION`: Reserved value for future use\n  * `BIT ORDER (little-endian)`: 24, `FLAG`: Translation Up To Date, `DESCRIPTION`: This item is a translation of another and it’s up to date\n  * `BIT ORDER (little-endian)`: 25, `FLAG`: Translation Pending, `DESCRIPTION`: This item is a translation of another and it’s pending translation\n  * `BIT ORDER (little-endian)`: 26, `FLAG`: Translation in Progress, `DESCRIPTION`: This item is a translation of another and is currently being translated"},"lockOwner":{"type":"string","description":"username of user that locked item for editing"},"localeCode":{"type":"string","description":"locale of content item"},"translationSourceId":{"type":"string","description":"ID of content item that is original for translation that current item represents"}},"required":["id","label","contentTypeId","path","previewUrl","systemType","mimeType","state","lockOwner","localeCode"]},"ContentValidationRequest":{"type":"object","properties":{"actions":{"type":"array","description":"The list of actions to verify","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of action, possible values: CREATE, RENAME, MOVE, COPY\n"},"source":{"type":"string","description":"The source value, only needed for recursive COPY, MOVE and RENAME actions"},"target":{"type":"string","description":"The target value"},"recursive":{"type":"boolean","description":"Indicates if all child items should be verified too","default":false},"contentMetadata":{"type":"object","properties":{"fileSize":{"type":"integer","format":"int64","description":"The size of the file in bytes, only needed for CREATE actions"},"contentType":{"type":"string","description":"The id of the crafter content type, only needed for CREATE actions"}}}},"required":["type","target"]}}},"required":["siteId","actions"]},"ContentValidationResult":{"type":"object","properties":{"actions":{"type":"array","description":"The list of results","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of action"},"target":{"type":"string","description":"The target value"},"allowed":{"type":"boolean","description":"Indicates if the operation is allowed"},"modifiedValue":{"type":"string","description":"The adjusted value if available"},"message":{"type":"string","description":"A detail message for the validation result"}}}}}},"ChildrenByPathRequest":{"type":"object","properties":{"path":{"description":"item path to get children for","type":"string"},"localeCode":{"description":"filter children by locale code, or show source items (not translation) if translation to\nspecified locale code does not exist","type":"string"},"sortStrategy":{"description":"sort strategy (sort order) Possible values:\n  - alphabetical (default)\n  - foldersFirst (order by: folders alphabetical, files alphabetical)\n  - lastUpdated (order by: dateModified)","type":"string"},"order":{"description":"order for sort strategy ascending or descending (ASC / DESC)","type":"string","format":"ASC, DESC"},"offset":{"description":"offset of first child in response - default 0","type":"integer"},"limit":{"description":"number of children to return","type":"integer"},"keyword":{"description":"filter children by keyword","type":"string"},"systemTypes":{"description":"filter children by system type\n\nNote that this parameter does not honor \"levelDescriptor\" as a valid type","type":"array","items":{"type":"string"}},"excludes":{"description":"exclude items by path","type":"array","items":{"type":"string"}}}},"PasteItem":{"type":"object","properties":{"path":{"type":"string","description":"The path of the item"},"children":{"type":"array","description":"The child items","items":{"$ref":"#/components/schemas/PasteItem"}}},"required":["path"]},"PasteRequest":{"type":"object","properties":{"siteId":{"type":"string","description":"The id of the site"},"operation":{"type":"string","description":"Indicate the type of operation","enum":["COPY","CUT"]},"targetPath":{"type":"string","description":"The target path for the operation"},"item":{"$ref":"#/components/schemas/PasteItem"}},"required":["siteId","target","item"]},"AccessToken":{"type":"object","properties":{"token":{"type":"string","description":"Value of the access token, only visible when the token is created"},"expiresAt":{"type":"string","format":"date-time","description":"Date of expiration of the access token"},"id":{"type":"integer","format":"int64","description":"Id of the access token"},"label":{"type":"string","description":"The label of the access token"},"enabled":{"type":"boolean","description":"Indicates if the access token is enabled"},"createdOn":{"type":"string","format":"date-time","description":"Date of creation of the access token"}}},"WorkflowPackage":{"type":"object","properties":{"id":{"type":"string","description":"workflow package ID"},"siteId":{"type":"string","description":"site identifier"},"status":{"type":"string","description":"workflow package status"},"author":{"type":"string","description":"username of the author"},"reviewer":{"type":"string","description":"username of the reviewer"},"schedule":{"type":"string","format":"datetime","description":"scheduled date and time to publish the package"},"publishingTarget":{"type":"string","description":"name of the publishing target where package will be published"},"authorComment":{"type":"string","description":"author's comment"},"reviewerComment":{"type":"string","description":"reviewer's comment"},"label":{"type":"string","description":"user friendly label for package"}},"required":["id","siteId","status","author","publishingTarget"]},"Activity":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"activity ID"},"person":{"$ref":"#/components/schemas/Person"},"actionType":{"type":"string","description":"operation performed by user\n  * CREATE\n  * UPDATE\n  * DELETE\n  * MOVE\n  * REQUEST_PUBLISH\n  * APPROVE\n  * APPROVE_SCHEDULED\n  * REJECT\n  * REVERT\n  * PUBLISH\n  * INITIAL_PUBLISH\n  * UNKNOWN"},"item":{"type":"object","description":"item that operation was performed against","properties":{"id":{"type":"integer","format":"int64","description":"The id of the item"},"path":{"type":"string","description":"The path of the item"},"label":{"type":"string","description":"The label of the item"},"previewUrl":{"type":"string","description":"The preview URL of the item"}}},"package":{"type":"object","description":"package that operation was performed against","properties":{"id":{"type":"string","format":"UUID","description":"The id of the package"}}}},"required":["id","person","actionType"]},"Person":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"user ID"},"username":{"type":"string","description":"user's username"},"firstName":{"type":"string","description":"user's first name"},"lastName":{"type":"string","description":"user's last name"},"avatar":{"type":"string","format":"CLOB","description":"user's avatar"}},"required":["id","username","firstName","lastName"]},"DashboardPublishingPackage":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"package id"},"label":{"type":"string","description":"user friendly name of the package"},"comment":{"type":"string","description":"submission comment by publisher"},"submitter":{"$ref":"#/components/schemas/Person"},"size":{"type":"integer","format":"int32","description":"number of items in the package"},"publishingTarget":{"type":"string","description":"publishing target where package will be published"},"schedule":{"type":"string","format":"date-time","description":"date and time when package will be published"}},"required":["id","label","submitter","size","publishingTarget"]},"PublishingStats":{"type":"object","properties":{"numberOfPublishes":{"type":"integer","format":"int32","description":"Number of published content for given unit of time"},"numberOfNewAndPublishedItems":{"type":"integer","format":"int32","description":"Number of newly created and published items for given unit of time"},"numberOfEditedAndPublishedItems":{"type":"integer","format":"int32","description":"Number of edited and published items for given unit of time"}},"required":["numberOfPublishes","numberOfNewAndPublishedItems","numberOfEditedAndPublishedItems"]},"LoggerConfig":{"type":"object","properties":{"name":{"type":"string","description":"the logger name"},"level":{"type":"string","description":"the logger priority level (off|error|warn|info|debug|trace|all)"}},"required":["name","level"]},"LoggerConfigRequest":{"allOf":[{"$ref":"#/components/schemas/LoggerConfig"},{"type":"object","properties":{"createIfAbsent":{"type":"boolean","description":"if true, the logger will be created in case it does not exist yet. If false, a 404 status code will be returned if logger is not in the registry."}}}]},"ItemVersion":{"type":"object","properties":{"versionNumber":{"type":"string","description":"the commit id"},"path":{"type":"string","description":"the path of the item"},"oldPath":{"type":"string","description":"the old path of the item (will be the same as path if the item has not been renamed)"},"committer":{"type":"string","description":"the committer of the commit according to git log"},"author":{"$ref":"#/components/schemas/Person","description":"corresponds to the Studio user author of the commit (if any)"},"comment":{"type":"string","description":"the comment of the commit"},"revertible":{"type":"boolean","description":"true if a revert to this version will be allowed"},"modifiedDate":{"type":"string","format":"date-time","description":"the date of the commit"}}},"DuplicateSiteRequest":{"type":"object","properties":{"siteName":{"type":"string","description":"The name of the new site"},"siteId":{"type":"string","description":"The ID of the new site"},"description":{"type":"string","description":"The description of the new site"},"sandboxBranch":{"type":"string","description":"The sandbox branch to be used in the new site sandbox repository"},"readOnlyBlobStores":{"type":"boolean","description":"If true, the blob stores will be read-only in the copied site.","default":false}}},"ContentType":{"type":"object","properties":{"name":{"type":"string","description":"The site content name"},"label":{"type":"string","description":"The content type display name"},"form":{"type":"string","description":"The content type form"},"formPath":{"type":"string","description":"The content type form path"},"type":{"type":"string","description":"The type, e.g. page, component, etc"},"contentAsFolder":{"type":"boolean","description":"Indicates whether to create content in a folder wrapper e.g. pageUrl: 101 means 101/index.xml instead of 101.xml"},"useRoundedFolder":{"type":"boolean","description":"Indicates whether use rounded folder to arrange content"},"modelInstancePath":{"type":"string","description":"The path to the model instance file (WCM)"},"allowedRoles":{"type":"array","items":{"type":"string"},"description":"The list of roles allowed"},"lastUpdated":{"type":"string","description":"The date the content type was last updated"},"copyDependencyPattern":{"type":"array","items":{"type":"string"},"description":"The list of copy association patterns"},"imageThumbnail":{"type":"string","description":"The thumbnail image file to be displayed"},"noThumbnail":{"type":"boolean","description":"Indicates whether content type has a thumbnail"},"pathIncludes":{"type":"array","items":{"type":"string"},"description":"The the list of included paths"},"pathExcludes":{"type":"array","items":{"type":"string"},"description":"The the list of excluded paths"},"nodeRef":{"type":"string","description":"The configuration noderef this content type is associated with"},"quickCreate":{"type":"boolean","description":"Indicates whether the content type is available from the quick create button"},"quickCreatePath":{"type":"string","description":"The destination path pattern of content type"},"deleteDependencyPattern":{"type":"array","items":{"type":"string"},"description":"The list of delete association patterns that this content type is dependent on for deleting indexes in webproject"},"previewable":{"type":"boolean","description":"Indicates whether the content type is previewable"}}},"ContentItemV1":{"type":"object","properties":{"name":{"type":"string","description":"The item name"},"internalName":{"type":"string","description":"The item internal name"},"contentType":{"type":"string","description":"The item content type"},"uri":{"type":"string","description":"The content type uri"},"path":{"type":"string","description":"The content type form path"},"browserUri":{"type":"string"},"navigation":{"type":"boolean"},"floating":{"type":"boolean"},"hideInAuthoring":{"type":"boolean"},"previewable":{"type":"boolean"},"lockOwner":{"type":"string"},"user":{"type":"string"},"userFirstName":{"type":"string"},"userLastName":{"type":"string"},"nodeRef":{"type":"string"},"metaDescription":{"type":"string"},"site":{"type":"string"},"page":{"type":"boolean"},"component":{"type":"boolean"},"document":{"type":"boolean"},"asset":{"type":"boolean"},"isContainer":{"type":"boolean"},"container":{"type":"boolean"},"disabled":{"type":"boolean"},"savedAsDraft":{"type":"boolean"},"submitted":{"type":"boolean"},"submittedForDeletion":{"type":"boolean"},"scheduled":{"type":"boolean"},"published":{"type":"boolean"},"deleted":{"type":"boolean"},"inProgress":{"type":"boolean"},"live":{"type":"boolean"},"inFlight":{"type":"boolean"},"isDisabled":{"type":"boolean"},"isSavedAsDraft":{"type":"boolean"},"isInProgress":{"type":"boolean"},"isLive":{"type":"boolean"},"isSubmittedForDeletion":{"type":"boolean"},"isScheduled":{"type":"boolean"},"isPublished":{"type":"boolean"},"isNavigation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isNew":{"type":"boolean"},"isSubmitted":{"type":"boolean"},"isFloating":{"type":"boolean"},"isPage":{"type":"boolean"},"isPreviewable":{"type":"boolean"},"isComponent":{"type":"boolean"},"isDocument":{"type":"boolean"},"isAsset":{"type":"boolean"},"isInFlight":{"type":"boolean"},"eventDate":{"type":"string"},"endpoint":{"type":"string"},"timezone":{"type":"string"},"numOfChildren":{"type":"number"},"scheduledDate":{"type":"string"},"publishedDate":{"type":"string"},"mandatoryParent":{"type":"string"},"isLevelDescriptor":{"type":"boolean"},"categoryRoot":{"type":"string"},"lastEditDate":{"type":"string"},"form":{"type":"string"},"formPagePath":{"type":"string"},"renderingTemplates":{"type":"array","items":{"type":"string"}},"folder":{"type":"boolean"},"submissionComment":{"type":"string"},"components":{"type":"string"},"documents":{"type":"string"},"levelDescriptors":{"type":"string"},"pages":{"type":"string"},"parentPath":{"type":"string"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemOrder"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/ContentItemV1"}},"size":{"type":"number"},"sizeUnit":{"type":"string"},"mimeType":{"type":"string"},"levelDescriptor":{"type":"boolean"},"newFile":{"type":"boolean"},"reference":{"type":"boolean"},"new":{"type":"boolean"}}},"ContentItemOrder":{"type":"object","properties":{"name":{"type":"string","description":"The item name"},"id":{"type":"string","description":"The item id"},"disabled":{"type":"string","description":"Indicates whether the item is disabled"},"order":{"type":"string","description":"The item's order"},"placeInNav":{"type":"string","description":"Indicates whether the item is placed in the navigation"}}},"ContentItemVersions":{"type":"object","properties":{"lastModifiedDate":{"type":"string","description":"The item's last modified date"},"lastModifier":{"type":"string","description":"The user that last modified the item"},"versionNumber":{"type":"string","description":"The item's version number"},"contentItem":{"type":"string","description":"The item content"},"comment":{"type":"string","description":"The comment"}}},"WriteContentWebForm":{"type":"object","properties":{"site_id":{"type":"string","description":"Project/Site to use","example":"mysite"},"path":{"type":"string","description":"Path of the content","example":"/site/website/index.xml"},"fileName":{"type":"string","description":"File name of the content","example":"index.xml"},"contentType":{"type":"string","description":"Content type of the content","example":"/page/home"},"edit":{"type":"string","description":"True if it is edit, otherwise it is create","example":"index.xml"},"user":{"type":"string","description":"User that executes action","example":"admin"},"oldContentPath":{"type":"string","description":"If renaming, content old path"},"draft":{"type":"string","description":"True if saving as draft"},"unlock":{"type":"string","description":"False to keep content locked, otherwise true","example":"true"}},"required":["site_id","path","fileName","contentType","unlock"]},"WriteContentAssetForm":{"type":"object","properties":{"site":{"type":"string","description":"Project/Site to use","example":"mysite"},"path":{"type":"string","description":"Path of the content","example":"/site/website/index.xml"},"fileName":{"type":"string","description":"File name of the content","example":"index.xml"},"contentType":{"type":"string","description":"Content type of the content","example":"/page/home"},"user":{"type":"string","description":"User that executes action","example":"admin"},"isImage":{"type":"string","description":"True if it is image"},"allowedWidth":{"type":"integer","description":"Allowed image width"},"allowedHeight":{"type":"integer","description":"Allowed image height"},"allowLessSize":{"type":"string","description":"Allow less size"},"draft":{"type":"string","description":"True if saving as draft"},"unlock":{"type":"string","description":"false to keep content locked, otherwise true"},"systemAsset":{"type":"string","description":"true if it is private asset"}},"required":["site","path","fileName","unlock"]},"WriteContentFileUpload":{"type":"object","properties":{"site":{"type":"string","description":"Project/Site to use","example":"mysite"},"path":{"type":"string","description":"Path of the content","example":"/site/website/index.xml"},"fileName":{"type":"string","description":"File name of the content","example":"index.xml"},"contentType":{"type":"string","description":"Content type of the content","example":"/page/home"},"user":{"type":"string","description":"User that executes action","example":"admin"},"isImage":{"type":"string","description":"True if it is image"},"allowedWidth":{"type":"integer","description":"Allowed image width"},"allowedHeight":{"type":"integer","description":"Allowed image height"},"allowLessSize":{"type":"string","description":"Allow less size"},"draft":{"type":"string","description":"True if saving as draft"},"unlock":{"type":"string","description":"false to keep content locked, otherwise true"}},"required":["site","path","fileName","unlock"]},"AvailableLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The language code, e.g. ja"},"label":{"type":"string","description":"The language display name"}}}},"responses":{"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"Conflict":{"description":"Resource already exists","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"RequestTimeout":{"description":"Request Timeout (408)","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"InternalServerError":{"description":"Internal system failure","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"ServiceUnavailable":{"description":"Service unavailable (503)","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"$ref":"#/components/schemas/ApiResponse"}}}}}},"api1OK":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"OK"}}}}},"api1NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Site not found"}}}}},"api1BadRequest":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"examples":{"invalidParameter":{"value":{"message":"Invalid parameter: site_id"}},"pathMissing":{"value":{"message":"Path must be provided"}},"siteMissing":{"value":{"message":"Site must be provided"}}}}}},"api1Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Forbidden"}}}}},"api1Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Unauthorized"}}}}},"api1Conflict":{"description":"Resource already exists","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Site already exists"}}}}},"api1InternalServerError":{"description":"Internal system failure","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Internal server error. ACTUAL_EXCEPTION"}}}}}},"securitySchemes":{"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"basicAuth":{"type":"http","scheme":"basic"}},"links":{},"callbacks":{}},"security":[{"jwtAuth":[]},{"basicAuth":[]}]}},"searchIndex":{"store":["tag/groups","tag/groups/operation/getGroups","tag/groups/operation/createGroup","tag/groups/operation/updateGroup","tag/groups/operation/deleteGroup","tag/groups/operation/getGroup","tag/groups/operation/getGroupMembers","tag/groups/operation/addGroupMembers","tag/groups/operation/removeGroupMembers","tag/users","tag/users/operation/getUsers","tag/users/operation/createUser","tag/users/operation/updateUser","tag/users/operation/deleteUser","tag/users/operation/getUser","tag/users/operation/enableUser","tag/users/operation/disableUser","tag/users/operation/getUserSites","tag/users/operation/getUserSiteRoles","tag/users/operation/resetUserPassword","tag/users/operation/setUserPassword","tag/users/operation/getCurrentUser","tag/users/operation/getCurrentUserSites","tag/users/operation/getCurrentUserSiteRoles","tag/users/operation/getCurrentUserSitePermissions","tag/users/operation/hasCurrentUserSitePermissions","tag/users/operation/getCurrentUserGlobalPermissions","tag/users/operation/hasCurrentUserGlobalPermissions","tag/users/operation/getCurrentUserSsoLogoutUrl","tag/users/operation/currentUserChangePassword","tag/users/operation/getUserProperties","tag/users/operation/updateUserProperties","tag/users/operation/deleteUserProperties","tag/users/operation/forgotPassword","tag/users/operation/validateToken","tag/ui","tag/ui/operation/getGlobalMenu","tag/ui/operation/getActiveEnv","tag/aws","tag/aws/operation/listItems","tag/aws/operation/uploadItem","tag/aws/operation/uploadVideo","tag/cluster","tag/cluster/operation/getClusterMembers","tag/cluster/operation/getClusterMode","tag/sites","tag/sites/operation/availableBlueprints","tag/sites/operation/createSiteFromMarketplace","tag/sites/operation/updateSite","tag/sites/operation/deleteSite","tag/sites/operation/unlockSite","tag/sites/operation/validate","tag/sites/operation/duplicateSite","tag/sites/operation/createSite","tag/sites/operation/deleteSiteAPI1","tag/sites/operation/projectExists","tag/sites/operation/getCannedMessage","tag/sites/operation/getSite","tag/sites/operation/monitorContent","tag/search","tag/search/operation/search","tag/audit","tag/audit/operation/getAuditLog","tag/audit/operation/getAuditLogById","tag/monitoring","tag/monitoring/operation/getVersion","tag/monitoring/operation/getStatus","tag/monitoring/operation/getMemory","tag/monitoring/operation/getLogEvents","tag/monitoring/operation/getDiskUsage","tag/repository","tag/repository/operation/addRemoteRepository","tag/repository/operation/pullFromRemoteRepository","tag/repository/operation/pushToRemoteRepository","tag/repository/operation/removeRemoteRepository","tag/repository/operation/listRemoteRepositories","tag/repository/operation/repositoryStatus","tag/repository/operation/resolveConflict","tag/repository/operation/diffConflictedFile","tag/repository/operation/commitResolution","tag/repository/operation/cancelFailedPull","tag/repository/operation/unlockRepository","tag/repository/operation/isRepositoryCorrupted","tag/repository/operation/repairCorruptedRepository","tag/content","tag/content/operation/changeContentType","tag/content/operation/createFolder","tag/content/operation/renameFolder","tag/content/operation/getContent","tag/content/operation/getContentAtPath","tag/content/operation/getContentType","tag/content/operation/getContentTypes","tag/content/operation/getItem","tag/content/operation/getItemOrders","tag/content/operation/getItemVersions","tag/content/operation/getItemsTree","tag/content/operation/getNextItemOrder","tag/content/operation/getPages","tag/content/operation/reorderItems","tag/content/operation/revertContent","tag/content/operation/writeContent","tag/content/operation/quickCreateContent","tag/content/operation/getDeletePackage","tag/content/operation/contentDelete","tag/content/operation/contentRename","tag/content/operation/getChildrenByPath","tag/content/operation/getChildrenByPaths","tag/content/operation/contentExists","tag/content/operation/getDetailedItemByPath","tag/content/operation/getSandboxItemsByPath","tag/content/operation/getDescriptor","tag/content/operation/pasteItems","tag/content/operation/duplicateItem","tag/content/operation/itemLockByPath","tag/content/operation/itemUnlockByPath","tag/content/operation/getContentByCommitId","tag/content/operation/getItemHistory","tag/configuration","tag/configuration/operation/getConfiguration","tag/configuration/operation/writeConfiguration","tag/configuration/operation/clearConfigurationCache","tag/configuration/operation/getConfigurationHistory","tag/configuration/operation/getContentTypeUsage","tag/configuration/operation/getContentTypePreviewImage","tag/configuration/operation/getContentTypeFormController","tag/configuration/operation/deleteContentType","tag/plugin","tag/plugin/operation/getPluginFile","tag/plugin/operation/getPluginConfiguration","tag/plugin/operation/writePluginConfiguration","tag/plugin/operation/reloadClasses","tag/dependency","tag/dependency/operation/getDependant","tag/dependency/operation/getSimpleDependencies","tag/dependency/operation/getDependencies","tag/marketplace","tag/marketplace/operation/searchPlugins","tag/marketplace/operation/getInstalledPlugins","tag/marketplace/operation/installPlugin","tag/marketplace/operation/copyPlugin","tag/marketplace/operation/removePlugin","tag/marketplace/operation/pluginUsage","tag/webdav","tag/webdav/operation/listItemsWebdav","tag/webdav/operation/uploadItemWebdav","tag/publishing","tag/publishing/operation/publishCommits","tag/publishing/operation/publishStart","tag/publishing/operation/publishStop","tag/publishing/operation/publishAll","tag/publishing/operation/PublishingPackages","tag/publishing/operation/getPublishingPackageDetails","tag/publishing/operation/cancelPublishingPackages","tag/publishing/operation/getPublishingStatus","tag/publishing/operation/getPublishingHistory","tag/publishing/operation/getAvailablePublishingTargets","tag/publishing/operation/hasInitialPublish","tag/security","tag/security/operation/encrypt","tag/security/operation/getAccessTokens","tag/security/operation/createAccessToken","tag/security/operation/updateAccessToken","tag/security/operation/deleteAccessToken","tag/security/operation/switchPreviewSite","tag/dashboard","tag/dashboard/operation/getDashboardActivities","tag/dashboard/operation/getDashboardMyActivities","tag/dashboard/operation/getDashboardContentPendingApproval","tag/dashboard/operation/getDashboardContentPendingApprovalDetail","tag/dashboard/operation/getDashboardContentUnpublished","tag/dashboard/operation/getPublishingScheduled","tag/dashboard/operation/getDashboardPublishingScheduledDetail","tag/dashboard/operation/getDashboardPublishingHistory","tag/dashboard/operation/getDashboardPublishingHistoryDetail","tag/dashboard/operation/getDashboardPublishingStats","tag/dashboard/operation/getDashboardContentExpiring","tag/dashboard/operation/getDashboardContentExpired","tag/workflow","tag/workflow/operation/getItemStates","tag/workflow/operation/setItemStates","tag/workflow/operation/updateItemStates","tag/workflow/operation/getWorkflowAffectedPaths","tag/workflow/operation/workflowRequestPublish","tag/workflow/operation/workflowPublish","tag/workflow/operation/workflowApprove","tag/workflow/operation/workflowReject","tag/workflow/operation/workflowListPackage","tag/workflow/operation/workflowCreatePackage","tag/workflow/operation/workflowUpdatePackage","tag/workflow/operation/workflowGetPackage","tag/workflow/operation/workflowApprovePackage","tag/workflow/operation/workflowRejectPackage","tag/loggers","tag/loggers/operation/loggersGetAll","tag/loggers/operation/loggersUpdateLevel","tag/server","tag/server/operation/getAvailableLanguages","tag/deployment","tag/deployment/operation/bulkGoLive","tag/preview","tag/preview/operation/syncSite","tag/model","tag/model/operation/getAllModelDefinitions","tag/dependent_items","tag/dependent_items/operation/getDependentItems"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,4.371]],["description/0",[0,3.444,1,4.281,2,2.384]],["title/1",[0,4.371]],["description/1",[3,0.22,4,0.414,5,4.099,6,3.846]],["title/2",[0,3.766,7,3.643]],["description/2",[3,0.22,4,0.414,6,3.846,8,4.952]],["title/3",[0,3.766,9,4.055]],["description/3",[3,0.22,4,0.414,6,3.846,10,4.438]],["title/4",[11,3.766,12,6.025]],["description/4",[3,0.22,4,0.414,6,3.846,13,4.438]],["title/5",[0,3.766,14,4.435]],["description/5",[3,0.22,4,0.414,5,4.099,15,4.952]],["title/6",[0,3.308,16,3.562,17,3.896]],["description/6",[3,0.22,4,0.414,5,4.099,18,4.099]],["title/7",[0,2.95,17,3.474,19,4.23,20,4.23]],["description/7",[3,0.22,4,0.414,10,4.438,18,4.099]],["title/8",[0,2.95,17,3.474,20,4.23,21,3.907]],["description/8",[3,0.22,4,0.414,13,4.438,18,4.099]],["title/9",[22,2.761]],["description/9",[1,4.281,2,2.384,22,2.176]],["title/10",[22,2.761]],["description/10",[3,0.22,4,0.414,23,3.846,24,3.846]],["title/11",[7,3.643,22,2.379]],["description/11",[3,0.22,4,0.414,24,3.846,25,4.952]],["title/12",[9,4.055,22,2.379]],["description/12",[3,0.22,4,0.414,24,3.846,26,3.846]],["title/13",[11,3.766,27,4.988]],["description/13",[3,0.22,4,0.414,24,3.846,28,4.952]],["title/14",[14,3.474,22,2.596,29,4.719]],["description/14",[3,0.22,4,0.414,23,3.846,30,4.952]],["title/15",[27,4.988,31,6.025]],["description/15",[3,0.22,4,0.414,26,3.846,32,4.952]],["title/16",[27,4.988,33,5.4]],["description/16",[3,0.22,4,0.414,26,3.846,34,4.952]],["title/17",[17,3.474,22,1.863,35,1.257,36,3.474]],["description/17",[3,0.22,4,0.414,23,3.846,37,4.952]],["title/18",[17,3.474,22,1.863,35,1.257,38,1.686]],["description/18",[3,0.22,4,0.414,23,3.846,39,4.952]],["title/19",[22,2.09,40,5.293,41,3.896]],["description/19",[3,0.22,4,0.414,26,3.846,42,4.952]],["title/20",[22,2.09,41,3.896,43,4.382]],["description/20",[3,0.22,4,0.414,44,4.099,45,4.952]],["title/21",[22,2.09,46,2.381,47,3.308]],["description/21",[3,0.22,4,0.414,48,2.539,49,4.952]],["title/22",[22,1.681,35,1.134,36,3.134,46,1.915,47,2.661]],["description/22",[3,0.22,4,0.414,48,2.539,50,4.952]],["title/23",[22,1.681,35,1.134,38,1.521,46,1.915,47,2.661]],["description/23",[3,0.22,4,0.414,48,2.539,51,4.952]],["title/24",[4,0.356,22,1.681,35,1.134,46,1.915,47,2.661]],["description/24",[3,0.22,4,0.414,48,2.539,52,4.952]],["title/25",[4,0.324,22,1.531,46,1.745,47,2.424,53,2.723,54,1.531]],["description/25",[3,0.22,4,0.414,48,2.539,55,4.952]],["title/26",[22,1.863,46,2.123,47,2.95,56,3.314]],["description/26",[3,0.22,4,0.414,48,2.539,57,4.952]],["title/27",[4,0.298,22,1.406,46,1.602,47,2.226,53,2.501,54,1.406,56,2.501]],["description/27",[3,0.22,4,0.414,48,2.539,58,4.952]],["title/28",[22,1.3,46,1.481,47,2.058,59,2.951,60,3.292,61,3.292,62,2.951,63,2.951]],["description/28",[3,0.081,4,0.152,22,0.718,33,1.629,47,1.136,48,0.932,59,1.629,62,3.659,63,1.629,64,3.113,65,1.629,66,1.818,67,1.338,68,1.818,69,1.818,70,1.818,71,1.818,72,1.818]],["title/29",[22,1.863,41,3.474,43,3.907,46,2.123]],["description/29",[3,0.22,4,0.414,48,2.539,73,4.952]],["title/30",[22,1.863,46,2.123,74,4.719,75,3.907]],["description/30",[3,0.22,4,0.414,48,2.539,76,4.099]],["title/31",[9,3.176,22,1.863,46,2.123,75,3.907]],["description/31",[3,0.22,4,0.414,48,2.539,76,4.099]],["title/32",[11,2.95,22,1.863,46,2.123,75,3.907]],["description/32",[3,0.22,4,0.414,48,2.539,76,4.099]],["title/33",[41,4.435,77,5.4]],["description/33",[3,0.22,4,0.414,44,4.099,78,4.952]],["title/34",[41,3.474,77,4.23,79,4.719,80,3.474]],["description/34",[3,0.22,4,0.414,44,4.099,81,4.952]],["title/35",[82,5.789]],["description/35",[2,2.384,82,4.562,83,5.51]],["title/36",[22,1.531,46,1.745,56,2.723,84,3.879,85,1.455,86,2.855]],["description/36",[3,0.22,4,0.414,48,2.539,87,4.952]],["title/37",[46,2.123,65,4.23,88,3.907,89,4.719]],["description/37",[3,0.22,4,0.414,48,2.539,90,4.952]],["title/38",[91,6.267]],["description/38",[2,2.687,91,5.567]],["title/39",[85,1.77,92,2.544,93,3.907,94,3.907]],["description/39",[3,0.22,4,0.414,95,4.952,96,4.952]],["title/40",[93,3.907,94,3.907,97,3.666,98,3.056]],["description/40",[3,0.22,4,0.414,99,4.438,100,4.952]],["title/41",[93,2.949,94,2.949,97,2.767,98,2.307,101,3.562,102,3.562,103,3.562]],["description/41",[3,0.22,4,0.414,99,4.438,104,4.952]],["title/42",[105,5.432]],["description/42",[1,4.281,2,2.384,105,4.281]],["title/43",[16,4.055,105,4.681]],["description/43",[3,0.22,4,0.414,106,4.438,107,4.952]],["title/44",[67,3.134,105,3.308,108,3.134,109,4.258,110,4.258]],["description/44",[3,0.22,4,0.414,106,4.438,111,4.952]],["title/45",[35,1.863]],["description/45",[1,4.281,2,2.384,35,1.468]],["title/46",[86,4.435,112,5.4]],["description/46",[3,0.22,4,0.414,48,2.539,113,4.952]],["title/47",[7,2.854,35,1.257,112,4.23,114,3.176]],["description/47",[115,7.116]],["title/48",[9,2.866,35,1.134,54,1.681,116,4.258,117,4.258]],["description/48",[3,0.22,4,0.414,118,4.438,119,4.438]],["title/49",[11,3.766,35,1.605]],["description/49",[3,0.22,4,0.414,119,4.438,120,4.952]],["title/50",[35,1.134,121,3.525,122,5.06,123,3.308]],["description/50",[3,0.22,4,0.414,118,4.438,124,4.952]],["title/51",[35,1.033,125,3.879,126,3.879,127,3.879,128,3.879,129,3.879]],["description/51",[130,7.116]],["title/52",[35,1.605,131,5.4]],["description/52",[132,7.116]],["title/53",[7,2.854,108,3.474,133,3.314,134,3.907]],["description/53",[3,0.22,38,1.769,135,3.095,136,4.952]],["title/54",[11,2.95,108,3.474,133,3.314,134,3.907]],["description/54",[3,0.22,38,1.769,135,3.095,137,4.952]],["title/55",[53,2.99,108,3.134,133,2.99,138,3.134,139,3.308]],["description/55",[3,0.183,16,2.771,38,1.471,135,2.573,138,3.03,140,4.117]],["title/56",[141,5.4,142,6.025]],["description/56",[3,0.245,38,1.968,143,5.51]],["title/57",[108,3.896,133,3.716,138,3.896]],["description/57",[3,0.245,38,1.968,144,5.51]],["title/58",[145,5.293,146,1.672,147,4.382]],["description/58",[3,0.22,38,1.769,148,4.952,149,4.952]],["title/59",[150,5.432]],["description/59",[2,2.687,150,4.825]],["title/60",[35,1.257,54,1.863,150,3.666,151,4.719]],["description/60",[152,7.116]],["title/61",[153,5.432]],["description/61",[2,2.384,153,4.281,154,4.281]],["title/62",[153,4.681,154,4.681]],["description/62",[3,0.22,4,0.414,155,4.952,156,4.952]],["title/63",[153,4.112,154,4.112,157,5.293]],["description/63",[158,7.116]],["title/64",[147,5.789]],["description/64",[2,2.687,147,5.142]],["title/65",[46,2.381,159,4.382,160,4.382]],["description/65",[161,7.116]],["title/66",[46,2.381,160,4.382,162,4.382]],["description/66",[163,7.116]],["title/67",[46,2.381,160,4.382,164,5.293]],["description/67",[165,7.116]],["title/68",[154,3.308,166,4.258,167,3.816,168,4.258,169,4.258]],["description/68",[170,7.116]],["title/69",[171,5.293,172,4.744,173,5.293]],["description/69",[174,7.116]],["title/70",[175,3.871]],["description/70",[2,2.687,175,3.439]],["title/71",[19,3.476,35,1.033,146,1.225,175,3.162,176,2.855]],["description/71",[3,0.22,4,0.414,177,4.952,178,4.952]],["title/72",[35,0.949,146,1.693,175,2.968,176,2.622,179,3.192]],["description/72",[3,0.22,4,0.414,180,4.952,181,4.952]],["title/73",[35,0.949,146,1.693,175,2.968,176,2.622,182,3.562]],["description/73",[3,0.22,4,0.414,183,4.952,184,4.952]],["title/74",[21,3.211,35,1.033,146,1.225,175,3.162,176,2.855]],["description/74",[3,0.22,4,0.414,185,4.952,186,4.952]],["title/75",[35,1.257,92,2.544,175,2.613,176,3.474]],["description/75",[3,0.22,4,0.414,187,4.952,188,4.952]],["title/76",[35,1.41,162,4.382,175,2.93]],["description/76",[3,0.22,4,0.414,189,4.952,190,4.952]],["title/77",[98,2.512,191,3.476,192,3.211,193,3.476,194,3.476,195,3.476]],["description/77",[3,0.22,4,0.414,196,4.952,197,4.952]],["title/78",[35,0.949,98,2.307,192,2.949,194,3.192,195,3.192,198,3.192,199,3.562]],["description/78",[3,0.22,4,0.414,200,4.952,201,4.952]],["title/79",[35,1.134,191,3.816,192,3.525,202,3.525,203,3.134]],["description/79",[3,0.22,4,0.414,204,4.952,205,4.952]],["title/80",[35,1.257,179,4.23,206,4.23,207,4.719]],["description/80",[3,0.22,4,0.414,208,4.952,209,4.952]],["title/81",[67,3.474,121,3.907,175,2.613,210,4.23]],["description/81",[3,0.146,35,0.875,38,1.174,56,2.307,135,2.054,211,2.72,212,2.552,213,1.155,214,3.286]],["title/82",[53,3.314,54,1.863,175,2.613,215,4.719]],["description/82",[3,0.146,35,0.875,38,1.174,56,2.307,135,2.054,211,2.72,212,2.552,213,1.155,216,3.286]],["title/83",[67,3.474,175,2.613,210,4.23,217,4.719]],["description/83",[3,0.146,35,0.875,38,1.174,56,2.307,135,2.054,211,2.72,212,2.552,213,1.155,218,3.286]],["title/84",[146,2.209]],["description/84",[2,2.687,146,1.962]],["title/85",[43,4.382,146,1.672,219,4.744]],["description/85",[3,0.22,38,1.769,220,2.321,221,4.952]],["title/86",[7,3.643,222,5.4]],["description/86",[3,0.22,38,1.769,220,2.321,223,4.952]],["title/87",[222,5.4,224,5.4]],["description/87",[3,0.22,38,1.769,220,2.321,225,4.952]],["title/88",[146,1.904,226,5.4]],["description/88",[3,0.22,38,1.769,220,2.321,227,4.952]],["title/89",[146,1.672,226,4.744,228,2.782]],["description/89",[3,0.22,38,1.769,220,2.321,229,4.952]],["title/90",[146,1.672,230,3.896,231,3.013]],["description/90",[3,0.22,38,1.769,220,2.321,232,4.952]],["title/91",[54,1.681,146,1.345,228,2.238,230,3.134,233,4.258]],["description/91",[3,0.22,38,1.769,220,2.321,234,4.952]],["title/92",[85,2.26,146,1.904]],["description/92",[3,0.22,38,1.769,220,2.321,235,4.952]],["title/93",[85,2.26,236,4.988]],["description/93",[3,0.22,38,1.769,220,2.321,237,4.952]],["title/94",[85,1.77,146,1.491,159,3.907,238,3.474]],["description/94",[3,0.22,38,1.769,220,2.321,239,4.952]],["title/95",[85,2.26,240,4.988]],["description/95",[3,0.22,38,1.769,220,2.321,241,4.952]],["title/96",[85,1.986,236,4.382,242,5.293]],["description/96",[3,0.22,38,1.769,220,2.321,243,4.952]],["title/97",[54,1.406,85,1.336,146,1.125,228,1.872,240,2.949,244,3.562,245,3.562]],["description/97",[3,0.22,38,1.769,220,2.321,246,4.952]],["title/98",[85,1.986,146,1.672,247,5.293]],["description/98",[3,0.22,38,1.769,220,2.321,248,4.952]],["title/99",[85,1.597,146,1.345,159,3.525,167,3.816,249,4.258]],["description/99",[3,0.22,38,1.769,220,2.321,250,4.952]],["title/100",[146,1.904,251,4.435]],["description/100",[3,0.066,38,0.531,97,1.154,98,0.962,146,0.826,219,1.332,252,1.486,253,1.486,254,1.486,255,2.613,256,1.835,257,1.486,258,1.486,259,1.486,260,1.486,261,1.486,262,1.332,263,1.486,264,1.486,265,1.486,266,1.486,267,1.486,268,1.094,269,1.486]],["title/101",[7,2.154,86,2.622,92,1.92,146,1.125,230,2.622,270,3.562,271,3.562]],["description/101",[3,0.2,4,0.376,7,2.719,146,1.42,272,4.496]],["title/102",[11,3.231,54,0.998,85,1.538,92,2.21,273,2.093,274,1.637,275,2.528,276,2.528]],["description/102",[3,0.22,4,0.414,277,2.48,278,4.952]],["title/103",[11,3.766,146,1.904]],["description/103",[3,0.22,4,0.414,279,4.952,280,4.952]],["title/104",[146,1.904,224,5.4]],["description/104",[3,0.22,4,0.414,281,4.438,282,4.952]],["title/105",[54,1.681,85,1.597,92,2.296,228,2.238,273,3.525]],["description/105",[2,1.253,3,0.129,4,0.242,35,0.772,256,2.033,283,2.25,284,2.896,285,2.596,286,2.896,287,2.596,288,2.896]],["title/106",[54,1.681,85,1.597,92,2.296,228,2.238,273,3.525]],["description/106",[3,0.183,4,0.344,16,2.771,35,1.097,283,3.198,289,4.117]],["title/107",[53,3.314,139,3.666,146,1.491,228,2.48]],["description/107",[3,0.22,4,0.414,277,2.48,290,4.952]],["title/108",[54,1.681,85,2.293,228,2.238,291,3.816]],["description/108",[3,0.22,4,0.414,283,3.846,292,4.952]],["title/109",[54,1.681,85,2.293,92,2.296,228,2.238]],["description/109",[3,0.183,4,0.344,16,2.771,35,1.097,283,3.198,293,4.117]],["title/110",[54,1.863,228,2.48,294,4.719,295,4.719]],["description/110",[296,7.116]],["title/111",[82,1.978,85,0.896,146,1.237,228,1.256,240,1.978,256,1.678,297,2.389,298,1.978,299,2.141,300,2.389,301,2.389,302,2.389]],["description/111",[3,0.22,4,0.414,251,3.645,303,4.952]],["title/112",[54,1.681,85,1.597,131,3.816,304,4.258,305,3.525]],["description/112",[3,0.22,4,0.414,251,3.645,306,4.952]],["title/113",[85,1.986,122,4.382,228,2.782]],["description/113",[3,0.22,4,0.414,281,4.438,307,4.952]],["title/114",[85,1.986,121,4.382,228,2.782]],["description/114",[3,0.183,4,0.344,122,3.408,308,4.117,309,4.117,310,4.117]],["title/115",[14,3.896,146,1.672,202,4.382]],["description/115",[3,0.22,4,0.414,277,2.48,311,4.952]],["title/116",[85,1.986,146,1.672,238,3.896]],["description/116",[3,0.22,4,0.414,277,2.48,312,4.952]],["title/117",[231,3.981]],["description/117",[2,2.687,231,3.536]],["title/118",[35,1.134,146,1.345,231,3.48,305,3.525]],["description/118",[3,0.22,4,0.414,313,4.099,314,4.952]],["title/119",[35,1.257,146,1.491,231,2.687,251,3.474]],["description/119",[3,0.22,4,0.414,315,3.846,316,4.952]],["title/120",[35,1.134,54,1.681,231,2.424,317,4.258,318,4.258]],["description/120",[3,0.22,4,0.414,315,3.846,319,4.952]],["title/121",[35,1.134,231,3.48,238,3.134,305,3.525]],["description/121",[3,0.22,4,0.414,313,4.099,320,4.952]],["title/122",[54,2.09,172,4.744,321,4.744]],["description/122",[3,0.22,4,0.414,277,2.48,322,4.952]],["title/123",[54,1.681,146,1.345,230,3.134,323,3.308,324,4.258]],["description/123",[3,0.22,4,0.414,277,2.48,325,4.952]],["title/124",[54,1.406,139,2.767,146,1.125,230,2.622,262,3.192,326,3.562,327,3.562]],["description/124",[3,0.22,4,0.414,277,2.48,328,4.952]],["title/125",[11,2.661,54,1.681,98,2.758,321,3.816,329,4.258]],["description/125",[3,0.22,4,0.414,315,3.846,330,4.952]],["title/126",[331,3.981]],["description/126",[2,2.687,331,3.536]],["title/127",[54,2.09,98,3.428,331,3.013]],["description/127",[332,7.116]],["title/128",[35,1.257,54,1.863,231,2.687,331,2.687]],["description/128",[3,0.2,4,0.376,16,3.026,35,1.198,333,4.496]],["title/129",[35,1.033,54,1.531,146,1.225,231,2.208,251,2.855,331,2.208]],["description/129",[3,0.183,4,0.344,16,2.771,35,1.097,315,3.198,334,4.117]],["title/130",[35,1.033,54,1.531,331,2.208,335,3.879,336,3.879,337,3.879]],["description/130",[338,7.116]],["title/131",[274,4.529]],["description/131",[2,2.687,274,4.022]],["title/132",[85,1.986,146,1.672,274,3.428]],["description/132",[3,0.22,38,1.769,220,2.321,339,4.952]],["title/133",[274,3.902,340,6.025]],["description/133",[3,0.22,38,1.769,220,2.321,341,4.952]],["title/134",[54,1.681,92,2.296,146,1.345,228,2.238,274,2.758]],["description/134",[3,0.22,4,0.414,277,2.48,342,4.952]],["title/135",[114,4.706]],["description/135",[2,2.687,114,4.18]],["title/136",[114,3.176,150,3.666,331,2.687,343,4.719]],["description/136",[344,7.116]],["title/137",[35,1.033,54,1.531,92,2.091,114,2.611,331,2.208,345,3.476]],["description/137",[3,0.22,4,0.414,346,4.952,347,4.438]],["title/138",[35,1.134,54,1.681,114,2.866,331,2.424,345,3.816]],["description/138",[3,0.22,4,0.414,347,4.438,348,4.438]],["title/139",[35,1.134,54,1.681,67,3.134,299,3.816,331,2.424]],["description/139",[3,0.22,4,0.414,348,4.438,349,4.952]],["title/140",[21,3.525,35,1.134,54,1.681,114,2.866,331,2.424]],["description/140",[3,0.22,4,0.414,350,4.438,351,4.952]],["title/141",[85,1.77,92,2.544,274,3.056,331,2.687]],["description/141",[3,0.22,4,0.414,350,4.438,352,4.952]],["title/142",[353,5.432]],["description/142",[2,2.687,353,4.825]],["title/143",[85,1.77,92,2.544,353,3.666,354,3.666]],["description/143",[3,0.22,4,0.414,355,4.952,356,4.952]],["title/144",[97,3.666,98,3.056,353,3.666,354,3.666]],["description/144",[3,0.22,4,0.414,357,4.952,358,4.952]],["title/145",[213,2.458]],["description/145",[2,2.687,213,2.184]],["title/146",[14,2.855,175,2.147,202,4.729,212,3.013,213,1.364]],["description/146",[3,0.157,4,0.295,35,0.939,38,1.258,135,3.323,359,3.523,360,3.523]],["title/147",[133,2.99,138,3.134,213,1.497,361,4.258,362,3.816]],["description/147",[3,0.183,35,1.097,38,1.471,135,3.729,363,4.117]],["title/148",[133,2.99,138,3.134,213,1.497,362,3.816,364,4.258]],["description/148",[3,0.183,35,1.097,38,1.471,135,3.729,365,4.117]],["title/149",[134,3.211,213,1.364,298,3.211,366,3.879,367,3.879,368,3.476]],["description/149",[3,0.22,4,0.414,213,1.741,369,4.952]],["title/150",[92,2.544,213,1.659,370,2.544,371,4.719]],["description/150",[3,0.22,4,0.414,372,4.438,373,4.438]],["title/151",[291,5.4,370,3.248]],["description/151",[3,0.22,4,0.414,372,4.438,373,4.438]],["title/152",[206,4.744,213,1.861,370,2.854]],["description/152",[3,0.22,4,0.414,374,4.952,375,4.952]],["title/153",[35,1.41,162,4.382,213,1.861]],["description/153",[3,0.22,4,0.414,376,4.952,377,4.952]],["title/154",[35,1.41,213,1.861,238,3.896]],["description/154",[2,1.421,3,0.146,4,0.275,213,1.155,256,2.307,285,2.945,287,2.945,378,2.945,379,3.286]],["title/155",[35,1.257,86,3.474,213,1.659,298,3.907]],["description/155",[3,0.22,4,0.414,213,1.741,380,4.952]],["title/156",[35,1.257,53,3.314,213,1.659,381,4.719]],["description/156",[3,0.22,4,0.414,277,2.48,382,4.952]],["title/157",[383,6.267]],["description/157",[2,2.687,383,5.567]],["title/158",[384,5.293,385,5.293,386,5.293]],["description/158",[3,0.22,4,0.414,387,4.952,388,4.952]],["title/159",[22,1.863,46,2.123,80,3.474,139,3.666]],["description/159",[3,0.22,4,0.414,389,3.846,390,4.438]],["title/160",[7,2.345,22,1.531,36,2.855,46,1.745,80,2.855,391,3.879]],["description/160",[3,0.22,4,0.414,389,3.846,390,4.438]],["title/161",[9,2.866,22,1.681,36,3.134,46,1.915,80,3.134]],["description/161",[3,0.22,4,0.414,389,3.846,392,4.438]],["title/162",[11,2.661,22,1.681,36,3.134,46,1.915,80,3.134]],["description/162",[3,0.22,4,0.414,389,3.846,392,4.438]],["title/163",[35,1.206,198,2.563,203,2.105,231,1.628,256,2.008,323,2.222,393,2.86,394,2.86,395,2.86]],["description/163",[3,0.22,4,0.414,48,2.539,396,4.952]],["title/164",[397,6.267]],["description/164",[2,2.687,397,5.567]],["title/165",[22,2.379,88,4.988]],["description/165",[3,0.22,4,0.414,398,3.333,399,4.952]],["title/166",[46,2.381,88,4.382,400,5.293]],["description/166",[3,0.22,4,0.414,398,3.333,401,4.952]],["title/167",[213,1.659,370,2.544,402,4.23,403,3.666]],["description/167",[3,0.22,4,0.414,398,3.333,404,4.952]],["title/168",[85,1.597,146,1.345,370,2.296,402,3.816,403,3.308]],["description/168",[3,0.22,4,0.414,398,3.333,405,4.952]],["title/169",[35,1.41,85,1.986,406,5.293]],["description/169",[3,0.22,4,0.414,277,2.48,407,4.952]],["title/170",[85,1.986,213,1.861,408,4.382]],["description/170",[3,0.22,4,0.414,277,2.48,409,4.952]],["title/171",[85,1.77,146,1.491,370,2.544,408,3.907]],["description/171",[3,0.22,4,0.414,277,2.48,410,4.952]],["title/172",[213,1.861,238,3.896,370,2.854]],["description/172",[3,0.22,4,0.414,277,2.48,378,4.438]],["title/173",[85,1.77,146,1.491,213,1.659,370,2.544]],["description/173",[3,0.22,4,0.414,277,2.48,411,4.952]],["title/174",[213,2.118,412,6.025]],["description/174",[3,0.22,4,0.414,277,2.48,413,4.952]],["title/175",[146,1.904,414,5.4]],["description/175",[3,0.22,4,0.414,398,3.333,415,4.438]],["title/176",[146,1.904,414,5.4]],["description/176",[3,0.22,4,0.414,398,3.333,415,4.438]],["title/177",[416,3.981]],["description/177",[2,2.687,416,3.536]],["title/178",[35,1.257,85,1.77,123,3.666,416,2.687]],["description/178",[3,0.22,4,0.414,417,4.952,418,4.438]],["title/179",[35,1.134,85,1.597,123,3.308,203,3.134,416,2.424]],["description/179",[3,0.22,4,0.414,418,4.438,419,4.438]],["title/180",[35,0.949,85,1.336,123,2.767,203,2.622,256,2.501,416,2.027,420,3.562]],["description/180",[3,0.22,4,0.414,419,4.438,421,4.952]],["title/181",[228,2.782,416,3.013,422,5.293]],["description/181",[3,0.22,4,0.414,277,2.48,423,4.952]],["title/182",[146,1.672,213,1.861,268,3.896]],["description/182",[3,0.22,4,0.414,398,3.333,424,4.952]],["title/183",[146,1.904,213,2.118]],["description/183",[3,0.22,4,0.414,213,1.741,425,4.952]],["title/184",[213,1.659,268,3.474,403,3.666,426,4.23]],["description/184",[3,0.22,4,0.414,213,1.741,427,4.952]],["title/185",[141,4.23,213,1.659,268,3.474,426,4.23]],["description/185",[3,0.22,4,0.414,213,1.741,428,4.952]],["title/186",[92,2.091,236,3.211,370,2.091,408,3.211,416,2.208,429,3.879]],["description/186",[3,0.2,4,0.376,213,1.581,430,3.309,431,3.722]],["title/187",[7,3.201,370,2.854,416,3.013]],["description/187",[3,0.2,4,0.376,213,1.581,430,3.309,431,3.722]],["title/188",[9,3.562,370,2.854,416,3.013]],["description/188",[3,0.2,4,0.376,213,1.581,430,3.309,431,3.722]],["title/189",[14,3.896,370,2.854,416,3.013]],["description/189",[3,0.2,4,0.376,213,1.581,430,3.309,432,4.496]],["title/190",[370,2.854,403,4.112,416,3.013]],["description/190",[3,0.22,4,0.414,213,1.741,433,4.952]],["title/191",[7,3.201,370,2.854,416,3.013]],["description/191",[3,0.2,4,0.376,213,1.581,430,3.309,434,4.496]],["title/192",[435,5.432]],["description/192",[2,2.384,231,3.137,435,4.281]],["title/193",[231,2.687,435,3.666,436,4.23,437,4.23]],["description/193",[3,0.2,4,0.376,438,4.496,439,4.029,440,4.496]],["title/194",[9,3.176,435,3.666,436,4.23,437,4.23]],["description/194",[3,0.22,4,0.414,439,4.438,441,4.952]],["title/195",[354,5.432]],["description/195",[2,2.687,354,4.825]],["title/196",[86,4.435,442,6.025]],["description/196",[3,0.22,38,1.769,220,2.321,443,4.952]],["title/197",[444,6.993]],["description/197",[]],["title/198",[368,4.744,445,5.293,446,5.293]],["description/198",[3,0.22,38,1.769,220,2.321,447,4.952]],["title/199",[323,5.432]],["description/199",[]],["title/200",[146,1.491,175,2.613,323,3.666,448,4.719]],["description/200",[3,0.22,38,1.769,220,2.321,449,4.952]],["title/201",[450,6.267]],["description/201",[]],["title/202",[35,1.41,450,4.744,451,5.293]],["description/202",[3,0.084,4,0.158,193,1.692,203,1.39,268,2.367,313,1.563,452,1.888,453,1.888,454,1.888,455,1.888,456,1.888,457,1.888,458,1.888,459,1.888,460,1.888,461,1.888,462,1.888,463,1.888,464,1.888]],["title/203",[465,6.993]],["description/203",[]],["title/204",[54,1.531,85,1.455,92,2.091,146,1.225,228,2.039,274,2.512]],["description/204",[3,0.22,4,0.414,277,2.48,466,4.952]]],"invertedIndex":[["",{"_index":64,"title":{},"description":{"28":{}}}],["accept",{"_index":193,"title":{"77":{}},"description":{"202":{}}}],["access",{"_index":36,"title":{"17":{},"22":{},"160":{},"161":{},"162":{}},"description":{}}],["action",{"_index":127,"title":{"51":{}},"description":{}}],["activ",{"_index":88,"title":{"37":{},"165":{},"166":{}},"description":{}}],["add",{"_index":19,"title":{"7":{},"71":{}},"description":{}}],["add_remot",{"_index":177,"title":{},"description":{"71":{}}}],["admin",{"_index":135,"title":{},"description":{"53":{},"54":{},"55":{},"81":{},"82":{},"83":{},"146":{},"147":{},"148":{}}}],["affect",{"_index":422,"title":{"181":{}},"description":{}}],["allow",{"_index":233,"title":{"91":{}},"description":{}}],["anonym",{"_index":44,"title":{},"description":{"20":{},"33":{},"34":{}}}],["answer",{"_index":461,"title":{},"description":{"202":{}}}],["api/1/services/api/1/content/change-content-type.json",{"_index":221,"title":{},"description":{"85":{}}}],["api/1/services/api/1/content/create-folder.json",{"_index":223,"title":{},"description":{"86":{}}}],["api/1/services/api/1/content/get-content-at-path.json",{"_index":229,"title":{},"description":{"89":{}}}],["api/1/services/api/1/content/get-content-type.json",{"_index":232,"title":{},"description":{"90":{}}}],["api/1/services/api/1/content/get-content-types.json",{"_index":234,"title":{},"description":{"91":{}}}],["api/1/services/api/1/content/get-content.json",{"_index":227,"title":{},"description":{"88":{}}}],["api/1/services/api/1/content/get-item-orders.json",{"_index":237,"title":{},"description":{"93":{}}}],["api/1/services/api/1/content/get-item-versions.json",{"_index":239,"title":{},"description":{"94":{}}}],["api/1/services/api/1/content/get-item.json",{"_index":235,"title":{},"description":{"92":{}}}],["api/1/services/api/1/content/get-items-tree.json",{"_index":241,"title":{},"description":{"95":{}}}],["api/1/services/api/1/content/get-next-item-order.json",{"_index":243,"title":{},"description":{"96":{}}}],["api/1/services/api/1/content/get-pages.json",{"_index":246,"title":{},"description":{"97":{}}}],["api/1/services/api/1/content/rename-folder.json",{"_index":225,"title":{},"description":{"87":{}}}],["api/1/services/api/1/content/reorder-items.json",{"_index":248,"title":{},"description":{"98":{}}}],["api/1/services/api/1/content/revert-content.json",{"_index":250,"title":{},"description":{"99":{}}}],["api/1/services/api/1/content/write-content.json",{"_index":269,"title":{},"description":{"100":{}}}],["api/1/services/api/1/dependency/get-dependant.json",{"_index":339,"title":{},"description":{"132":{}}}],["api/1/services/api/1/dependency/get-simple-dependencies.json",{"_index":341,"title":{},"description":{"133":{}}}],["api/1/services/api/1/deployment/bulk-golive.json",{"_index":447,"title":{},"description":{"198":{}}}],["api/1/services/api/1/preview/sync-site.json",{"_index":449,"title":{},"description":{"200":{}}}],["api/1/services/api/1/publish/commits.json",{"_index":360,"title":{},"description":{"146":{}}}],["api/1/services/api/1/publish/start.json",{"_index":363,"title":{},"description":{"147":{}}}],["api/1/services/api/1/publish/stop.json",{"_index":365,"title":{},"description":{"148":{}}}],["api/1/services/api/1/server/get-available-languages.json",{"_index":443,"title":{},"description":{"196":{}}}],["api/1/services/api/1/site/create.json",{"_index":136,"title":{},"description":{"53":{}}}],["api/1/services/api/1/site/delete-site.json",{"_index":137,"title":{},"description":{"54":{}}}],["api/1/services/api/1/site/exists.json",{"_index":140,"title":{},"description":{"55":{}}}],["api/1/services/api/1/site/get-canned-message.json",{"_index":143,"title":{},"description":{"56":{}}}],["api/1/services/api/1/site/get.json",{"_index":144,"title":{},"description":{"57":{}}}],["api/1/services/api/1/site/monitor-content.json",{"_index":149,"title":{},"description":{"58":{}}}],["api/2/audit",{"_index":156,"title":{},"description":{"62":{}}}],["api/2/audit/{id",{"_index":158,"title":{},"description":{"63":{}}}],["api/2/aws/mediaconvert/upload",{"_index":104,"title":{},"description":{"41":{}}}],["api/2/aws/s3/list",{"_index":96,"title":{},"description":{"39":{}}}],["api/2/aws/s3/upload",{"_index":100,"title":{},"description":{"40":{}}}],["api/2/clust",{"_index":107,"title":{},"description":{"43":{}}}],["api/2/cluster/mod",{"_index":111,"title":{},"description":{"44":{}}}],["api/2/configuration/clear_cach",{"_index":319,"title":{},"description":{"120":{}}}],["api/2/configuration/content-type/delet",{"_index":330,"title":{},"description":{"125":{}}}],["api/2/configuration/content-type/form_control",{"_index":328,"title":{},"description":{"124":{}}}],["api/2/configuration/content-type/preview_imag",{"_index":325,"title":{},"description":{"123":{}}}],["api/2/configuration/content-type/usag",{"_index":322,"title":{},"description":{"122":{}}}],["api/2/configuration/get_configur",{"_index":314,"title":{},"description":{"118":{}}}],["api/2/configuration/get_configuration_histori",{"_index":320,"title":{},"description":{"121":{}}}],["api/2/configuration/write_configur",{"_index":316,"title":{},"description":{"119":{}}}],["api/2/content/children_by_path",{"_index":288,"title":{},"description":{"105":{}}}],["api/2/content/delet",{"_index":280,"title":{},"description":{"103":{}}}],["api/2/content/descriptor",{"_index":296,"title":{},"description":{"110":{}}}],["api/2/content/dupl",{"_index":306,"title":{},"description":{"112":{}}}],["api/2/content/exist",{"_index":290,"title":{},"description":{"107":{}}}],["api/2/content/get_content_by_commit_id",{"_index":311,"title":{},"description":{"115":{}}}],["api/2/content/get_delete_packag",{"_index":278,"title":{},"description":{"102":{}}}],["api/2/content/item_by_path",{"_index":292,"title":{},"description":{"108":{}}}],["api/2/content/item_histori",{"_index":312,"title":{},"description":{"116":{}}}],["api/2/content/item_lock_by_path",{"_index":307,"title":{},"description":{"113":{}}}],["api/2/content/item_unlock_by_path",{"_index":310,"title":{},"description":{"114":{}}}],["api/2/content/list_quick_create_cont",{"_index":272,"title":{},"description":{"101":{}}}],["api/2/content/past",{"_index":303,"title":{},"description":{"111":{}}}],["api/2/content/renam",{"_index":282,"title":{},"description":{"104":{}}}],["api/2/content/sandbox_items_by_path",{"_index":293,"title":{},"description":{"109":{}}}],["api/2/content/{siteid}/children",{"_index":289,"title":{},"description":{"106":{}}}],["api/2/dashboard/act",{"_index":399,"title":{},"description":{"165":{}}}],["api/2/dashboard/activity/m",{"_index":401,"title":{},"description":{"166":{}}}],["api/2/dashboard/content/expir",{"_index":415,"title":{},"description":{"175":{},"176":{}}}],["api/2/dashboard/content/pending_approv",{"_index":404,"title":{},"description":{"167":{}}}],["api/2/dashboard/content/pending_approval/{id",{"_index":405,"title":{},"description":{"168":{}}}],["api/2/dashboard/content/unpublish",{"_index":407,"title":{},"description":{"169":{}}}],["api/2/dashboard/publishing/histori",{"_index":378,"title":{},"description":{"154":{},"172":{}}}],["api/2/dashboard/publishing/history/{id",{"_index":411,"title":{},"description":{"173":{}}}],["api/2/dashboard/publishing/schedul",{"_index":409,"title":{},"description":{"170":{}}}],["api/2/dashboard/publishing/scheduled/{id",{"_index":410,"title":{},"description":{"171":{}}}],["api/2/dashboard/publishing/stat",{"_index":413,"title":{},"description":{"174":{}}}],["api/2/dependency/depend",{"_index":342,"title":{},"description":{"134":{}}}],["api/2/dependency/dependent_item",{"_index":466,"title":{},"description":{"204":{}}}],["api/2/group",{"_index":6,"title":{},"description":{"1":{},"2":{},"3":{},"4":{}}}],["api/2/groups/{id",{"_index":15,"title":{},"description":{"5":{}}}],["api/2/groups/{id}/memb",{"_index":18,"title":{},"description":{"6":{},"7":{},"8":{}}}],["api/2/logg",{"_index":440,"title":{},"description":{"193":{}}}],["api/2/loggers/logger_level",{"_index":441,"title":{},"description":{"194":{}}}],["api/2/marketplace/copi",{"_index":349,"title":{},"description":{"139":{}}}],["api/2/marketplace/instal",{"_index":347,"title":{},"description":{"137":{},"138":{}}}],["api/2/marketplace/remov",{"_index":351,"title":{},"description":{"140":{}}}],["api/2/marketplace/search",{"_index":344,"title":{},"description":{"136":{}}}],["api/2/marketplace/usag",{"_index":352,"title":{},"description":{"141":{}}}],["api/2/model/{siteid}/definit",{"_index":464,"title":{},"description":{"202":{}}}],["api/2/monitoring/disk",{"_index":174,"title":{},"description":{"69":{}}}],["api/2/monitoring/log",{"_index":170,"title":{},"description":{"68":{}}}],["api/2/monitoring/memori",{"_index":165,"title":{},"description":{"67":{}}}],["api/2/monitoring/statu",{"_index":163,"title":{},"description":{"66":{}}}],["api/2/monitoring/vers",{"_index":161,"title":{},"description":{"65":{}}}],["api/2/plugin/fil",{"_index":332,"title":{},"description":{"127":{}}}],["api/2/plugin/get_configur",{"_index":333,"title":{},"description":{"128":{}}}],["api/2/plugin/script/reload",{"_index":338,"title":{},"description":{"130":{}}}],["api/2/plugin/write_configur",{"_index":334,"title":{},"description":{"129":{}}}],["api/2/publish/al",{"_index":369,"title":{},"description":{"149":{}}}],["api/2/publish/available_target",{"_index":380,"title":{},"description":{"155":{}}}],["api/2/publish/cancel",{"_index":375,"title":{},"description":{"152":{}}}],["api/2/publish/has_initial_publish",{"_index":382,"title":{},"description":{"156":{}}}],["api/2/publish/histori",{"_index":379,"title":{},"description":{"154":{}}}],["api/2/publish/packag",{"_index":373,"title":{},"description":{"150":{},"151":{}}}],["api/2/publish/statu",{"_index":377,"title":{},"description":{"153":{}}}],["api/2/repository/add_remot",{"_index":178,"title":{},"description":{"71":{}}}],["api/2/repository/cancel_failed_pul",{"_index":209,"title":{},"description":{"80":{}}}],["api/2/repository/commit_resolut",{"_index":205,"title":{},"description":{"79":{}}}],["api/2/repository/corrupt",{"_index":216,"title":{},"description":{"82":{}}}],["api/2/repository/diff_conflicted_fil",{"_index":201,"title":{},"description":{"78":{}}}],["api/2/repository/list_remot",{"_index":188,"title":{},"description":{"75":{}}}],["api/2/repository/pull_from_remot",{"_index":181,"title":{},"description":{"72":{}}}],["api/2/repository/push_to_remot",{"_index":184,"title":{},"description":{"73":{}}}],["api/2/repository/remove_remot",{"_index":186,"title":{},"description":{"74":{}}}],["api/2/repository/repair",{"_index":218,"title":{},"description":{"83":{}}}],["api/2/repository/resolve_conflict",{"_index":197,"title":{},"description":{"77":{}}}],["api/2/repository/statu",{"_index":190,"title":{},"description":{"76":{}}}],["api/2/repository/unlock",{"_index":214,"title":{},"description":{"81":{}}}],["api/2/search/search",{"_index":152,"title":{},"description":{"60":{}}}],["api/2/security/encrypt",{"_index":388,"title":{},"description":{"158":{}}}],["api/2/security/preview/switch",{"_index":396,"title":{},"description":{"163":{}}}],["api/2/security/token",{"_index":390,"title":{},"description":{"159":{},"160":{}}}],["api/2/security/tokens/{id",{"_index":392,"title":{},"description":{"161":{},"162":{}}}],["api/2/sites/available_blueprint",{"_index":113,"title":{},"description":{"46":{}}}],["api/2/sites/create_site_from_marketplac",{"_index":115,"title":{},"description":{"47":{}}}],["api/2/sites/{siteid",{"_index":119,"title":{},"description":{"48":{},"49":{}}}],["api/2/sites/{siteid}/dupl",{"_index":132,"title":{},"description":{"52":{}}}],["api/2/sites/{siteid}/policy/valid",{"_index":130,"title":{},"description":{"51":{}}}],["api/2/sites/{siteid}/unlock",{"_index":124,"title":{},"description":{"50":{}}}],["api/2/ui/system/active_environ",{"_index":90,"title":{},"description":{"37":{}}}],["api/2/ui/views/global_menu",{"_index":87,"title":{},"description":{"36":{}}}],["api/2/us",{"_index":24,"title":{},"description":{"10":{},"11":{},"12":{},"13":{}}}],["api/2/users/dis",{"_index":34,"title":{},"description":{"16":{}}}],["api/2/users/en",{"_index":32,"title":{},"description":{"15":{}}}],["api/2/users/forgot_password",{"_index":78,"title":{},"description":{"33":{}}}],["api/2/users/m",{"_index":49,"title":{},"description":{"21":{}}}],["api/2/users/me/change_password",{"_index":73,"title":{},"description":{"29":{}}}],["api/2/users/me/global/has_permiss",{"_index":58,"title":{},"description":{"27":{}}}],["api/2/users/me/global/permiss",{"_index":57,"title":{},"description":{"26":{}}}],["api/2/users/me/logout/sso/url",{"_index":72,"title":{},"description":{"28":{}}}],["api/2/users/me/properti",{"_index":76,"title":{},"description":{"30":{},"31":{},"32":{}}}],["api/2/users/me/sit",{"_index":50,"title":{},"description":{"22":{}}}],["api/2/users/me/sites/{site}/has_permiss",{"_index":55,"title":{},"description":{"25":{}}}],["api/2/users/me/sites/{site}/permiss",{"_index":52,"title":{},"description":{"24":{}}}],["api/2/users/me/sites/{site}/rol",{"_index":51,"title":{},"description":{"23":{}}}],["api/2/users/set_password",{"_index":45,"title":{},"description":{"20":{}}}],["api/2/users/validate_token",{"_index":81,"title":{},"description":{"34":{}}}],["api/2/users/{id",{"_index":30,"title":{},"description":{"14":{}}}],["api/2/users/{id}/reset_password",{"_index":42,"title":{},"description":{"19":{}}}],["api/2/users/{id}/sit",{"_index":37,"title":{},"description":{"17":{}}}],["api/2/users/{id}/sites/{site}/rol",{"_index":39,"title":{},"description":{"18":{}}}],["api/2/webdav/list",{"_index":356,"title":{},"description":{"143":{}}}],["api/2/webdav/upload",{"_index":358,"title":{},"description":{"144":{}}}],["api/2/workflow/affected_path",{"_index":423,"title":{},"description":{"181":{}}}],["api/2/workflow/approv",{"_index":427,"title":{},"description":{"184":{}}}],["api/2/workflow/item_st",{"_index":418,"title":{},"description":{"178":{},"179":{}}}],["api/2/workflow/packag",{"_index":431,"title":{},"description":{"186":{},"187":{},"188":{}}}],["api/2/workflow/packages/approv",{"_index":433,"title":{},"description":{"190":{}}}],["api/2/workflow/packages/reject",{"_index":434,"title":{},"description":{"191":{}}}],["api/2/workflow/packages/{id",{"_index":432,"title":{},"description":{"189":{}}}],["api/2/workflow/publish",{"_index":425,"title":{},"description":{"183":{}}}],["api/2/workflow/reject",{"_index":428,"title":{},"description":{"185":{}}}],["api/2/workflow/request_publish",{"_index":424,"title":{},"description":{"182":{}}}],["api/2/workflow/update_item_states_by_queri",{"_index":421,"title":{},"description":{"180":{}}}],["approv",{"_index":403,"title":{"167":{},"168":{},"184":{},"190":{}},"description":{}}],["argument",{"_index":455,"title":{},"description":{"202":{}}}],["asset",{"_index":261,"title":{},"description":{"100":{}}}],["audit",{"_index":153,"title":{"61":{},"62":{},"63":{}},"description":{"61":{}}}],["audit_log",{"_index":155,"title":{},"description":{"62":{}}}],["authent",{"_index":47,"title":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{}},"description":{"28":{}}}],["author",{"_index":252,"title":{},"description":{"100":{}}}],["avail",{"_index":86,"title":{"36":{},"46":{},"101":{},"155":{},"196":{}},"description":{}}],["aw",{"_index":91,"title":{"38":{}},"description":{"38":{}}}],["between",{"_index":199,"title":{"78":{}},"description":{}}],["blueprint",{"_index":112,"title":{"46":{},"47":{}},"description":{}}],["br/>in",{"_index":452,"title":{},"description":{"202":{}}}],["br><br",{"_index":253,"title":{},"description":{"100":{}}}],["broken",{"_index":275,"title":{"102":{}},"description":{}}],["bucket",{"_index":94,"title":{"39":{},"40":{},"41":{}},"description":{}}],["bulk",{"_index":445,"title":{"198":{}},"description":{}}],["cach",{"_index":318,"title":{"120":{}},"description":{}}],["cancel",{"_index":206,"title":{"80":{},"152":{}},"description":{}}],["cancel_failed_pul",{"_index":208,"title":{},"description":{"80":{}}}],["cancel_publish",{"_index":374,"title":{},"description":{"152":{}}}],["chang",{"_index":43,"title":{"20":{},"29":{},"85":{}},"description":{}}],["check",{"_index":53,"title":{"25":{},"27":{},"55":{},"82":{},"107":{},"156":{}},"description":{}}],["children",{"_index":273,"title":{"102":{},"105":{},"106":{}},"description":{}}],["class",{"_index":337,"title":{"130":{}},"description":{}}],["clear",{"_index":317,"title":{"120":{}},"description":{}}],["clipboard",{"_index":301,"title":{"111":{}},"description":{}}],["cluster",{"_index":105,"title":{"42":{},"43":{},"44":{}},"description":{"42":{}}}],["commit",{"_index":202,"title":{"79":{},"115":{},"146":{}},"description":{}}],["commit_resolut",{"_index":204,"title":{},"description":{"79":{}}}],["compat",{"_index":343,"title":{"136":{}},"description":{}}],["compliant",{"_index":128,"title":{"51":{}},"description":{}}],["configur",{"_index":231,"title":{"90":{},"117":{},"118":{},"119":{},"120":{},"121":{},"128":{},"129":{},"163":{},"193":{}},"description":{"117":{},"192":{}}}],["configure_log_level",{"_index":439,"title":{},"description":{"193":{},"194":{}}}],["conflict",{"_index":192,"title":{"77":{},"78":{},"79":{}},"description":{}}],["consequ",{"_index":459,"title":{},"description":{"202":{}}}],["content",{"_index":146,"title":{"58":{},"71":{},"72":{},"73":{},"74":{},"84":{},"85":{},"88":{},"89":{},"90":{},"91":{},"92":{},"94":{},"97":{},"98":{},"99":{},"100":{},"101":{},"103":{},"104":{},"107":{},"111":{},"115":{},"116":{},"118":{},"119":{},"123":{},"124":{},"129":{},"132":{},"134":{},"168":{},"171":{},"173":{},"175":{},"176":{},"182":{},"183":{},"200":{},"204":{}},"description":{"84":{},"100":{},"101":{}}}],["content-typ",{"_index":321,"title":{"122":{},"125":{}},"description":{}}],["content/{siteid}/children",{"_index":286,"title":{},"description":{"105":{}}}],["content_delet",{"_index":279,"title":{},"description":{"103":{}}}],["content_read",{"_index":277,"title":{},"description":{"102":{},"107":{},"115":{},"116":{},"122":{},"123":{},"124":{},"134":{},"156":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"181":{},"204":{}}}],["content_writ",{"_index":281,"title":{},"description":{"104":{},"113":{}}}],["control",{"_index":326,"title":{"124":{}},"description":{}}],["cooki",{"_index":395,"title":{"163":{}},"description":{}}],["copi",{"_index":299,"title":{"111":{},"139":{}},"description":{}}],["corrupt",{"_index":215,"title":{"82":{}},"description":{}}],["crafter",{"_index":133,"title":{"53":{},"54":{},"55":{},"57":{},"147":{},"148":{}},"description":{}}],["craftersit",{"_index":394,"title":{"163":{}},"description":{}}],["creat",{"_index":7,"title":{"2":{},"11":{},"47":{},"53":{},"86":{},"101":{},"160":{},"187":{},"191":{}},"description":{"101":{}}}],["create/edit",{"_index":257,"title":{},"description":{"100":{}}}],["create_group",{"_index":8,"title":{},"description":{"2":{}}}],["create_us",{"_index":25,"title":{},"description":{"11":{}}}],["css",{"_index":264,"title":{},"description":{"100":{}}}],["current",{"_index":46,"title":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"36":{},"37":{},"65":{},"66":{},"67":{},"159":{},"160":{},"161":{},"162":{},"166":{}},"description":{}}],["dashboard",{"_index":397,"title":{"164":{}},"description":{"164":{}}}],["date",{"_index":429,"title":{"186":{}},"description":{}}],["definit",{"_index":451,"title":{"202":{}},"description":{}}],["delet",{"_index":11,"title":{"4":{},"13":{},"32":{},"49":{},"54":{},"102":{},"103":{},"125":{},"162":{}},"description":{}}],["delete_group",{"_index":13,"title":{},"description":{"4":{},"8":{}}}],["delete_sit",{"_index":120,"title":{},"description":{"49":{}}}],["delete_us",{"_index":28,"title":{},"description":{"13":{}}}],["depend",{"_index":274,"title":{"102":{},"131":{},"132":{},"133":{},"134":{},"141":{},"204":{}},"description":{"131":{}}}],["dependent_item",{"_index":465,"title":{"203":{}},"description":{}}],["deploy",{"_index":444,"title":{"197":{}},"description":{}}],["deprec",{"_index":285,"title":{},"description":{"105":{},"154":{}}}],["descript",{"_index":117,"title":{"48":{}},"description":{}}],["descriptor",{"_index":295,"title":{"110":{}},"description":{}}],["detail",{"_index":291,"title":{"108":{},"151":{}},"description":{}}],["differ",{"_index":198,"title":{"78":{},"163":{}},"description":{}}],["disabl",{"_index":33,"title":{"16":{}},"description":{"28":{}}}],["disk",{"_index":171,"title":{"69":{}},"description":{}}],["duplic",{"_index":131,"title":{"52":{},"112":{}},"description":{}}],["edit_sit",{"_index":118,"title":{},"description":{"48":{},"50":{}}}],["enabl",{"_index":31,"title":{"15":{}},"description":{}}],["encrypt",{"_index":384,"title":{"158":{}},"description":{}}],["encryption_tool",{"_index":387,"title":{},"description":{"158":{}}}],["endpoint",{"_index":460,"title":{},"description":{"202":{}}}],["entir",{"_index":366,"title":{"149":{}},"description":{}}],["entiti",{"_index":69,"title":{},"description":{"28":{}}}],["entri",{"_index":157,"title":{"63":{}},"description":{}}],["environ",{"_index":89,"title":{"37":{}},"description":{}}],["event",{"_index":166,"title":{"68":{}},"description":{}}],["exist",{"_index":139,"title":{"55":{},"107":{},"124":{},"159":{}},"description":{}}],["expect",{"_index":393,"title":{"163":{}},"description":{}}],["expir",{"_index":414,"title":{"175":{},"176":{}},"description":{}}],["failed/conflict",{"_index":207,"title":{"80":{}},"description":{}}],["file",{"_index":98,"title":{"40":{},"41":{},"77":{},"78":{},"125":{},"127":{},"144":{}},"description":{"100":{}}}],["folder",{"_index":222,"title":{"86":{},"87":{}},"description":{}}],["forgot",{"_index":77,"title":{"33":{},"34":{}},"description":{}}],["form",{"_index":262,"title":{"124":{}},"description":{"100":{}}}],["form.<br",{"_index":259,"title":{},"description":{"100":{}}}],["function",{"_index":271,"title":{"101":{}},"description":{}}],["futur",{"_index":453,"title":{},"description":{"202":{}}}],["get",{"_index":245,"title":{"97":{}},"description":{}}],["get_children",{"_index":283,"title":{},"description":{"105":{},"106":{},"108":{},"109":{}}}],["get_item_st",{"_index":417,"title":{},"description":{"178":{}}}],["get_publishing_queu",{"_index":372,"title":{},"description":{"150":{},"151":{}}}],["git",{"_index":210,"title":{"81":{},"83":{}},"description":{}}],["given",{"_index":54,"title":{"25":{},"27":{},"48":{},"60":{},"82":{},"91":{},"97":{},"102":{},"105":{},"106":{},"108":{},"109":{},"110":{},"112":{},"120":{},"122":{},"123":{},"124":{},"125":{},"127":{},"128":{},"129":{},"130":{},"134":{},"137":{},"138":{},"139":{},"140":{},"204":{}},"description":{}}],["global",{"_index":56,"title":{"26":{},"27":{},"36":{}},"description":{"81":{},"82":{},"83":{}}}],["go",{"_index":446,"title":{"198":{}},"description":{}}],["groovi",{"_index":336,"title":{"130":{}},"description":{}}],["groovy).<br",{"_index":265,"title":{},"description":{"100":{}}}],["group",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"5":{},"6":{},"7":{},"8":{}},"description":{"0":{}}}],["group(",{"_index":12,"title":{"4":{}},"description":{}}],["histori",{"_index":238,"title":{"94":{},"116":{},"121":{},"154":{},"172":{}},"description":{}}],["id",{"_index":14,"title":{"5":{},"14":{},"115":{},"146":{},"189":{}},"description":{}}],["imag",{"_index":324,"title":{"123":{}},"description":{}}],["implement",{"_index":302,"title":{"111":{}},"description":{}}],["indic",{"_index":126,"title":{"51":{}},"description":{}}],["inform",{"_index":160,"title":{"65":{},"66":{},"67":{}},"description":{}}],["initi",{"_index":381,"title":{"156":{}},"description":{}}],["instal",{"_index":345,"title":{"137":{},"138":{}},"description":{}}],["install_plugin",{"_index":348,"title":{},"description":{"138":{},"139":{}}}],["instanc",{"_index":109,"title":{"44":{}},"description":{}}],["instead",{"_index":287,"title":{},"description":{"105":{},"154":{}}}],["item",{"_index":85,"title":{"36":{},"39":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"102":{},"105":{},"106":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"116":{},"132":{},"141":{},"143":{},"168":{},"169":{},"170":{},"171":{},"173":{},"178":{},"179":{},"180":{},"204":{}},"description":{}}],["item_unlock",{"_index":308,"title":{},"description":{"114":{}}}],["javascript",{"_index":263,"title":{},"description":{"100":{}}}],["job",{"_index":103,"title":{"41":{}},"description":{}}],["languag",{"_index":442,"title":{"196":{}},"description":{}}],["length",{"_index":458,"title":{},"description":{"202":{}}}],["level",{"_index":437,"title":{"193":{},"194":{}},"description":{}}],["list",{"_index":92,"title":{"39":{},"75":{},"101":{},"102":{},"105":{},"106":{},"109":{},"134":{},"137":{},"141":{},"143":{},"150":{},"186":{},"204":{}},"description":{}}],["list_plugin",{"_index":346,"title":{},"description":{"137":{}}}],["list_remot",{"_index":187,"title":{},"description":{"75":{}}}],["live",{"_index":368,"title":{"149":{},"198":{}},"description":{}}],["local",{"_index":67,"title":{"44":{},"81":{},"83":{},"139":{}},"description":{"28":{}}}],["locat",{"_index":305,"title":{"112":{},"118":{},"121":{}},"description":{}}],["lock",{"_index":122,"title":{"50":{},"113":{}},"description":{"114":{}}}],["log",{"_index":154,"title":{"62":{},"63":{},"68":{}},"description":{"61":{}}}],["logged_in",{"_index":48,"title":{},"description":{"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"36":{},"37":{},"46":{},"163":{}}}],["logger",{"_index":435,"title":{"192":{},"193":{},"194":{}},"description":{"192":{}}}],["logout",{"_index":62,"title":{"28":{}},"description":{"28":{}}}],["manag",{"_index":1,"title":{},"description":{"0":{},"9":{},"42":{},"45":{}}}],["manage_access_token",{"_index":389,"title":{},"description":{"159":{},"160":{},"161":{},"162":{}}}],["marketplac",{"_index":114,"title":{"47":{},"135":{},"136":{},"137":{},"138":{},"140":{}},"description":{"135":{}}}],["max",{"_index":457,"title":{},"description":{"202":{}}}],["mediaconvert",{"_index":102,"title":{"41":{}},"description":{}}],["member",{"_index":16,"title":{"6":{},"43":{}},"description":{"55":{},"106":{},"109":{},"128":{},"129":{}}}],["member\".<br",{"_index":284,"title":{},"description":{"105":{}}}],["member(",{"_index":20,"title":{"7":{},"8":{}},"description":{}}],["memori",{"_index":164,"title":{"67":{}},"description":{}}],["menu",{"_index":84,"title":{"36":{}},"description":{}}],["method",{"_index":463,"title":{},"description":{"202":{}}}],["mode",{"_index":110,"title":{"44":{}},"description":{}}],["model",{"_index":450,"title":{"201":{},"202":{}},"description":{}}],["monitor",{"_index":147,"title":{"58":{},"64":{}},"description":{"64":{}}}],["move",{"_index":300,"title":{"111":{}},"description":{}}],["multipart",{"_index":267,"title":{},"description":{"100":{}}}],["n/a",{"_index":220,"title":{},"description":{"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"132":{},"133":{},"196":{},"198":{},"200":{}}}],["name",{"_index":116,"title":{"48":{}},"description":{}}],["new",{"_index":391,"title":{"160":{}},"description":{}}],["next",{"_index":242,"title":{"96":{}},"description":{}}],["none",{"_index":148,"title":{},"description":{"58":{}}}],["null",{"_index":70,"title":{},"description":{"28":{}}}],["oper",{"_index":2,"title":{},"description":{"0":{},"9":{},"35":{},"38":{},"42":{},"45":{},"59":{},"61":{},"64":{},"70":{},"84":{},"105":{},"117":{},"126":{},"131":{},"135":{},"142":{},"145":{},"154":{},"157":{},"164":{},"177":{},"192":{},"195":{}}}],["options:<br>writecontentwebform",{"_index":254,"title":{},"description":{"100":{}}}],["order",{"_index":236,"title":{"93":{},"96":{},"186":{}},"description":{}}],["our",{"_index":194,"title":{"77":{},"78":{}},"description":{}}],["owner",{"_index":309,"title":{},"description":{"114":{}}}],["packag",{"_index":370,"title":{"150":{},"151":{},"152":{},"167":{},"168":{},"171":{},"172":{},"173":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{}},"description":{}}],["page",{"_index":244,"title":{"97":{}},"description":{}}],["password",{"_index":41,"title":{"19":{},"20":{},"29":{},"33":{},"34":{}},"description":{}}],["past",{"_index":297,"title":{"111":{}},"description":{}}],["path",{"_index":228,"title":{"89":{},"91":{},"97":{},"105":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"113":{},"114":{},"134":{},"181":{},"204":{}},"description":{}}],["pend",{"_index":402,"title":{"167":{},"168":{}},"description":{}}],["perform",{"_index":151,"title":{"60":{}},"description":{}}],["period",{"_index":169,"title":{"68":{}},"description":{}}],["permiss",{"_index":4,"title":{"24":{},"25":{},"27":{}},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"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":{},"36":{},"37":{},"39":{},"40":{},"41":{},"43":{},"44":{},"46":{},"48":{},"49":{},"50":{},"62":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"128":{},"129":{},"134":{},"137":{},"138":{},"139":{},"140":{},"141":{},"143":{},"144":{},"146":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"193":{},"194":{},"202":{},"204":{}}}],["plugin",{"_index":331,"title":{"126":{},"127":{},"128":{},"129":{},"130":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{}},"description":{"126":{}}}],["polici",{"_index":129,"title":{"51":{}},"description":{}}],["post",{"_index":462,"title":{},"description":{"202":{}}}],["preview",{"_index":323,"title":{"123":{},"163":{},"199":{},"200":{}},"description":{}}],["prioriti",{"_index":436,"title":{"193":{},"194":{}},"description":{}}],["project",{"_index":134,"title":{"53":{},"54":{},"149":{}},"description":{}}],["project/sit",{"_index":138,"title":{"55":{},"57":{},"147":{},"148":{}},"description":{"55":{}}}],["projects/sit",{"_index":145,"title":{"58":{}},"description":{}}],["properti",{"_index":75,"title":{"30":{},"31":{},"32":{}},"description":{}}],["provid",{"_index":61,"title":{"28":{}},"description":{}}],["publish",{"_index":213,"title":{"145":{},"146":{},"147":{},"148":{},"149":{},"150":{},"152":{},"153":{},"154":{},"155":{},"156":{},"167":{},"170":{},"172":{},"173":{},"174":{},"182":{},"183":{},"184":{},"185":{}},"description":{"81":{},"82":{},"83":{},"145":{},"149":{},"154":{},"155":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{}}}],["publish_by_commit",{"_index":359,"title":{},"description":{"146":{}}}],["publish_statu",{"_index":376,"title":{},"description":{"153":{}}}],["pull",{"_index":179,"title":{"72":{},"80":{}},"description":{}}],["pull_from_remot",{"_index":180,"title":{},"description":{"72":{}}}],["push",{"_index":182,"title":{"73":{}},"description":{}}],["push_to_remot",{"_index":183,"title":{},"description":{"73":{}}}],["queri",{"_index":420,"title":{"180":{}},"description":{}}],["queue",{"_index":371,"title":{"150":{}},"description":{}}],["quick",{"_index":270,"title":{"101":{}},"description":{}}],["read_clust",{"_index":106,"title":{},"description":{"43":{},"44":{}}}],["read_configur",{"_index":313,"title":{},"description":{"118":{},"121":{},"202":{}}}],["read_group",{"_index":5,"title":{},"description":{"1":{},"5":{},"6":{}}}],["read_us",{"_index":23,"title":{},"description":{"10":{},"14":{},"17":{},"18":{}}}],["reason",{"_index":142,"title":{"56":{}},"description":{}}],["redirect",{"_index":66,"title":{},"description":{"28":{}}}],["refer",{"_index":276,"title":{"102":{}},"description":{}}],["reject",{"_index":141,"title":{"56":{},"185":{}},"description":{}}],["relat",{"_index":329,"title":{"125":{}},"description":{}}],["releas",{"_index":454,"title":{},"description":{"202":{}}}],["reload",{"_index":335,"title":{"130":{}},"description":{}}],["remot",{"_index":176,"title":{"71":{},"72":{},"73":{},"74":{},"75":{}},"description":{}}],["remov",{"_index":21,"title":{"8":{},"74":{},"140":{}},"description":{}}],["remove_plugin",{"_index":350,"title":{},"description":{"140":{},"141":{}}}],["remove_remot",{"_index":185,"title":{},"description":{"74":{}}}],["renam",{"_index":224,"title":{"87":{},"104":{}},"description":{}}],["reorder",{"_index":247,"title":{"98":{}},"description":{}}],["repair",{"_index":217,"title":{"83":{}},"description":{}}],["repositori",{"_index":175,"title":{"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"81":{},"82":{},"83":{},"146":{},"200":{}},"description":{"70":{}}}],["request",{"_index":268,"title":{"182":{},"184":{},"185":{}},"description":{"100":{},"202":{}}}],["request_publish",{"_index":430,"title":{},"description":{"186":{},"187":{},"188":{},"189":{},"191":{}}}],["requir",{"_index":3,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{},"8":{},"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":{},"36":{},"37":{},"39":{},"40":{},"41":{},"43":{},"44":{},"46":{},"48":{},"49":{},"50":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"62":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{},"108":{},"109":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{},"128":{},"129":{},"132":{},"133":{},"134":{},"137":{},"138":{},"139":{},"140":{},"141":{},"143":{},"144":{},"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{},"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"178":{},"179":{},"180":{},"181":{},"182":{},"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"193":{},"194":{},"196":{},"198":{},"200":{},"202":{},"204":{}}}],["reset",{"_index":40,"title":{"19":{}},"description":{}}],["resolv",{"_index":191,"title":{"77":{},"79":{}},"description":{}}],["resolve_conflict",{"_index":196,"title":{},"description":{"77":{}}}],["respons",{"_index":68,"title":{},"description":{"28":{}}}],["retriev",{"_index":74,"title":{"30":{}},"description":{}}],["revert",{"_index":249,"title":{"99":{}},"description":{}}],["role",{"_index":38,"title":{"18":{},"23":{}},"description":{"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"81":{},"82":{},"83":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"132":{},"133":{},"146":{},"147":{},"148":{},"196":{},"198":{},"200":{}}}],["s3",{"_index":93,"title":{"39":{},"40":{},"41":{}},"description":{}}],["s3_read",{"_index":95,"title":{},"description":{"39":{}}}],["s3_write",{"_index":99,"title":{},"description":{"40":{},"41":{}}}],["same",{"_index":304,"title":{"112":{}},"description":{}}],["sandbox",{"_index":212,"title":{"146":{}},"description":{"81":{},"82":{},"83":{}}}],["save",{"_index":255,"title":{},"description":{"100":{}}}],["schedul",{"_index":408,"title":{"170":{},"171":{},"186":{}},"description":{}}],["script",{"_index":327,"title":{"124":{}},"description":{}}],["search",{"_index":150,"title":{"59":{},"60":{},"136":{}},"description":{"59":{}}}],["secur",{"_index":383,"title":{"157":{}},"description":{"157":{}}}],["server",{"_index":354,"title":{"143":{},"144":{},"195":{}},"description":{"195":{}}}],["servic",{"_index":60,"title":{"28":{}},"description":{}}],["set",{"_index":203,"title":{"79":{},"163":{},"179":{},"180":{}},"description":{"202":{}}}],["set_item_st",{"_index":419,"title":{},"description":{"179":{},"180":{}}}],["simpl",{"_index":340,"title":{"133":{}},"description":{}}],["site",{"_index":35,"title":{"17":{},"18":{},"22":{},"23":{},"24":{},"45":{},"47":{},"48":{},"49":{},"50":{},"51":{},"52":{},"60":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"78":{},"79":{},"80":{},"118":{},"119":{},"120":{},"121":{},"128":{},"129":{},"130":{},"137":{},"138":{},"139":{},"140":{},"153":{},"154":{},"155":{},"156":{},"163":{},"169":{},"178":{},"179":{},"180":{},"202":{}},"description":{"45":{},"81":{},"82":{},"83":{},"105":{},"106":{},"109":{},"128":{},"129":{},"146":{},"147":{},"148":{}}}],["site_diff_conflicted_fil",{"_index":200,"title":{},"description":{"78":{}}}],["site_memb",{"_index":398,"title":{},"description":{"165":{},"166":{},"167":{},"168":{},"175":{},"176":{},"182":{}}}],["site_statu",{"_index":189,"title":{},"description":{"76":{}}}],["specif",{"_index":167,"title":{"68":{},"99":{}},"description":{}}],["specifi",{"_index":17,"title":{"6":{},"7":{},"8":{},"17":{},"18":{}},"description":{}}],["sso",{"_index":59,"title":{"28":{}},"description":{"28":{}}}],["stage",{"_index":367,"title":{"149":{}},"description":{}}],["start",{"_index":361,"title":{"147":{}},"description":{}}],["stat",{"_index":412,"title":{"174":{}},"description":{}}],["state",{"_index":123,"title":{"50":{},"178":{},"179":{},"180":{}},"description":{}}],["statist",{"_index":173,"title":{"69":{}},"description":{}}],["statu",{"_index":162,"title":{"66":{},"76":{},"153":{}},"description":{}}],["stop",{"_index":364,"title":{"148":{}},"description":{}}],["stream",{"_index":226,"title":{"88":{},"89":{}},"description":{}}],["studio",{"_index":108,"title":{"44":{},"53":{},"54":{},"55":{},"57":{}},"description":{}}],["studio’",{"_index":362,"title":{"147":{},"148":{}},"description":{}}],["submiss",{"_index":426,"title":{"184":{},"185":{}},"description":{}}],["support",{"_index":83,"title":{},"description":{"35":{}}}],["surpass",{"_index":456,"title":{},"description":{"202":{}}}],["sync",{"_index":448,"title":{"200":{}},"description":{}}],["system",{"_index":65,"title":{"37":{}},"description":{"28":{}}}],["system_admin",{"_index":211,"title":{},"description":{"81":{},"82":{},"83":{}}}],["target",{"_index":298,"title":{"111":{},"149":{},"155":{}},"description":{}}],["templat",{"_index":219,"title":{"85":{}},"description":{"100":{}}}],["text",{"_index":385,"title":{"158":{}},"description":{}}],["their",{"_index":195,"title":{"77":{},"78":{}},"description":{}}],["through",{"_index":71,"title":{},"description":{"28":{}}}],["time",{"_index":168,"title":{"68":{}},"description":{}}],["token",{"_index":80,"title":{"34":{},"159":{},"160":{},"161":{},"162":{}},"description":{}}],["tree",{"_index":240,"title":{"95":{},"97":{},"111":{}},"description":{}}],["trigger",{"_index":101,"title":{"41":{}},"description":{}}],["type",{"_index":230,"title":{"90":{},"91":{},"101":{},"123":{},"124":{}},"description":{}}],["ui",{"_index":82,"title":{"35":{},"111":{}},"description":{"35":{}}}],["unlock",{"_index":121,"title":{"50":{},"81":{},"114":{}},"description":{}}],["unpublish",{"_index":406,"title":{"169":{}},"description":{}}],["updat",{"_index":9,"title":{"3":{},"12":{},"31":{},"48":{},"161":{},"188":{},"194":{}},"description":{}}],["update_group",{"_index":10,"title":{},"description":{"3":{},"7":{}}}],["update_us",{"_index":26,"title":{},"description":{"12":{},"15":{},"16":{},"19":{}}}],["upload",{"_index":97,"title":{"40":{},"41":{},"144":{}},"description":{"100":{}}}],["url",{"_index":63,"title":{"28":{}},"description":{"28":{}}}],["us",{"_index":256,"title":{"111":{},"163":{},"180":{}},"description":{"100":{},"105":{},"154":{}}}],["usag",{"_index":172,"title":{"69":{},"122":{}},"description":{}}],["user",{"_index":22,"title":{"9":{},"10":{},"11":{},"12":{},"14":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"36":{},"159":{},"160":{},"161":{},"162":{},"165":{}},"description":{"9":{},"28":{}}}],["user'",{"_index":400,"title":{"166":{}},"description":{}}],["user(",{"_index":27,"title":{"13":{},"15":{},"16":{}},"description":{}}],["usernam",{"_index":29,"title":{"14":{}},"description":{}}],["valid",{"_index":79,"title":{"34":{}},"description":{}}],["valu",{"_index":386,"title":{"158":{}},"description":{}}],["verifi",{"_index":125,"title":{"51":{}},"description":{}}],["version",{"_index":159,"title":{"65":{},"94":{},"99":{}},"description":{}}],["view_log_level",{"_index":438,"title":{},"description":{"193":{}}}],["web",{"_index":258,"title":{},"description":{"100":{}}}],["webdav",{"_index":353,"title":{"142":{},"143":{},"144":{}},"description":{"142":{}}}],["webdav_read",{"_index":355,"title":{},"description":{"143":{}}}],["webdav_writ",{"_index":357,"title":{},"description":{"144":{}}}],["workflow",{"_index":416,"title":{"177":{},"178":{},"179":{},"180":{},"181":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{}},"description":{"177":{}}}],["write",{"_index":251,"title":{"100":{},"119":{},"129":{}},"description":{"111":{},"112":{}}}],["write_configur",{"_index":315,"title":{},"description":{"119":{},"120":{},"125":{},"129":{}}}],["writecontentassetform",{"_index":260,"title":{},"description":{"100":{}}}],["writecontentfileupload",{"_index":266,"title":{},"description":{"100":{}}}],["xml",{"_index":294,"title":{"110":{}},"description":{}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/source/conf.py b/source/conf.py
index 1335be384..4e0b89496 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -29,7 +29,7 @@
 # The short X.Y version.
 version = u'current'
 # The full version, including alpha/beta/rc tags.
-release = u'4.4.4'
+release = u'4.5.0'
 
 
 # -- General configuration ---------------------------------------------------
diff --git a/source/index.rst b/source/index.rst
index ee8d00a1e..8adc9d963 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.4.4
+:last-updated: 4.5.0
 
 ########################
 CrafterCMS Documentation
@@ -71,7 +71,7 @@ CrafterCMS is used by three main constituencies:
 =========================
 Latest CrafterCMS Release
 =========================
-The latest version of CrafterCMS is `version 4.4.4 <https://craftercms.com/download>`__.
+The latest version of CrafterCMS is `version 4.5.0 <https://craftercms.com/download>`__.
 
 Start exploring the latest version of CrafterCMS in a few minutes using Docker by simply running the following command:
 
diff --git a/source/reference/modules/studio.rst b/source/reference/modules/studio.rst
index 52fc2a2cb..2e9c2b3db 100644
--- a/source/reference/modules/studio.rst
+++ b/source/reference/modules/studio.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.4.3
+:last-updated: 4.5.0
 
 .. highlight:: xml
 
@@ -3202,7 +3202,7 @@ The following section of Studio's configuration overrides allows you to configur
     # studio.validation.regex.USERNAME: "^[a-zA-Z][\\w.\\-@+]+$"
     # studio.validation.regex.GROUP_NAME: "^[a-zA-Z][\\w.\\-]*$"
     # studio.validation.regex.ALPHANUMERIC: "^[a-zA-Z0-9]*$"
-    # studio.validation.regex.SEARCH_KEYWORDS: "^[\\w\\s\\-\\\"\\.\\*]*$"
+    # studio.validation.regex.SEARCH_KEYWORDS: "^[\\w\\s\\-\\\"\\'\\.!@#$%&\\*\\/\\(\\)\\[\\]\\p{IsLatin}]*$"
     # studio.validation.regex.CONTENT_PATH_WRITE: "^/?([\\w\\- ]+/?)*(((crafter\\-level\\-descriptor\\.level)|([\\w\\- ]))+\\.[\\w]+)?$"
     # studio.validation.regex.CONTENT_PATH_READ: "^/?([\\w\\p{IsLatin}@$%^&{}\\[\\]()+\\-=,.:~'`]+(\\s*[\\w\\p{IsLatin}/@$%^&{}\\[\\]()+\\-=,.:~'`])*(/?))*$"
     # studio.validation.regex.CONTENT_FILE_NAME_WRITE: "^((crafter\\-level\\-descriptor\\.level)|([a-z0-9_\\-])+)\\.xml$"
diff --git a/source/release-notes/4-5-0.rst b/source/release-notes/4-5-0.rst
new file mode 100644
index 000000000..5ac646d71
--- /dev/null
+++ b/source/release-notes/4-5-0.rst
@@ -0,0 +1,64 @@
+.. index:: CrafterCMS version 4.5.0 Release Notes
+
+------------------------
+CrafterCMS Version 4.5.0
+------------------------
+
+Released *TBD, 2025*
+
+.. important::
+
+    Please see :ref:`Breaking changes <breaking-changes-4-x>` for breaking changes and other
+    things to consider before upgrading
+
+    For instructions on how to update your CrafterCMS install, please see :ref:`upgrading-craftercms`
+
+^^^^^^^^^^^^
+New Features
+^^^^^^^^^^^^
+* New Groovy sandbox whitelists |br|
+  See :ref:`Deployer Groovy Sandbox <deployer-groovy-sandbox-configuration>`,
+  :ref:`Engine Groovy Sandbox <groovy-sandbox-configuration>` and
+  :ref:`Studio Groovy Sandbox <studio-groovy-sandbox-configuration>` for more information on configuring the whitelists.
+
+* Improved serverless performance |enterpriseOnly| |br|
+  Improved startup and first page load speeds by using Redis/ValKey as a cache in front of S3.
+
+^^^^^^^^^^^^
+Enhancements
+^^^^^^^^^^^^
+* `New configurable properties for search connection pool max values for total connections and connections per route <https://github.com/craftercms/craftercms/issues/8344>`__ |br|
+  See the :ref:`Deployer <deployer-search-connection-pool>`, :ref:`Engine <engine-search-connection-pool>`,
+  and :ref:`Studio <studio-search>` search configuration sections for more information.
+
+* `Improved query performance and OpenSearch caching <https://github.com/craftercms/craftercms/issues/8350>`__ |br|
+  CrafterCMS by default now excludes disabled and expired content from search results via default filters. See :ref:`engine-search-default-filters` for more 
+  information on enabling/disabling the default filters.
+
+* `Search input field is now in focus when clicking the search button <https://github.com/craftercms/craftercms/issues/8352>`__
+
+^^^^^^^^^
+Bug Fixes
+^^^^^^^^^
+* `Fixed issue with repeating group control <https://github.com/craftercms/craftercms/issues/8355>`__
+
+* `Fixed issue with Studio UI breaking when searching for a user with [SA] in the name <https://github.com/craftercms/craftercms/issues/8351>`__ |br|
+  Square brackets are now allowed by default in search queries. To allow other characters not permitted by default in search queries,
+  simply modify the ``studio.validation.regex.SEARCH_KEYWORDS`` property in the Studio :ref:`Global Config <nav-menu-global-config>`.
+  
+  See :ref:`studio-validations-regex` to learn more on configuring the regex for validating user names to suit your needs.
+
+^^^^^^^^^^^^^^^^^^
+Dependency Updates
+^^^^^^^^^^^^^^^^^^
+* Noteworthy dependency updates:
+
+  - Spring security to version 6.5.4
+  - Mariadb4j to version 3.1.0.5
+
+For a complete list of community tickets, please visit: `GitHub 4.5.0 <https://github.com/orgs/craftercms/projects/34/views/1>`_
+
+For information on upgrading 3.1.x sites, see :ref:`here <compatibility-with-3.1.x>`
+
+|hr|
+
diff --git a/source/release-notes/4-x-breaking-changes.rst b/source/release-notes/4-x-breaking-changes.rst
index c7a0c5ea4..55c463620 100644
--- a/source/release-notes/4-x-breaking-changes.rst
+++ b/source/release-notes/4-x-breaking-changes.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.4.4
+:last-updated: 4.5.0
 :orphan:
 
 .. _breaking-changes-4-x:
@@ -23,6 +23,18 @@ before upgrading. Please review the following and apply changes as required:
 
 |hr|
 
+.. _breaking-changes-in-craftercms-4-5-0:
+
+------------------------------------
+Breaking Changes in CrafterCMS 4.5.0
+------------------------------------
+- CrafterCMS version 4.5.0 added a whitelist for Groovy scripts that is enabled by default and might break existing
+  systems on upgrade because of this. Please see :ref:`Deployer Groovy Sandbox <deployer-groovy-sandbox-configuration>`,
+  :ref:`Engine Groovy Sandbox <groovy-sandbox-configuration>` and
+  :ref:`Studio Groovy Sandbox <studio-groovy-sandbox-configuration>` for more information on the whitelists.
+
+|hr|
+
 .. _breaking-changes-in-craftercms-4-4-3:
 
 ------------------------------------
@@ -31,6 +43,8 @@ Breaking Changes in CrafterCMS 4.4.3
 CrafterCMS version 4.4.3 works with JavaScript SDK version 5.0.0 and later. See :ref:`compatibility-with-craftercms-version`
 for more information.
 
+|hr|
+
 .. _breaking-changes-in-craftercms-4-4-0:
 
 ------------------------------------
diff --git a/source/release-notes/index.rst b/source/release-notes/index.rst
index f4523cb50..70b1ff237 100644
--- a/source/release-notes/index.rst
+++ b/source/release-notes/index.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.4.4
+:last-updated: 4.5.0
 
 .. _release-notes:
 
@@ -11,6 +11,7 @@ version release's release notes page :ref:`below <other-release-notes>`
 
 .. note:: CrafterCMS requires Java 21
 
+.. include:: /release-notes/4-5-0.rst
 .. include:: /release-notes/4-4-4.rst
 .. include:: /release-notes/4-4-3.rst
 .. include:: /release-notes/4-4-2.rst
diff --git a/source/support.rst b/source/support.rst
index d0a6634bc..d0b633e9c 100644
--- a/source/support.rst
+++ b/source/support.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.4.4
+:last-updated: 4.5.0
 
 .. index:: Support
 
@@ -21,10 +21,15 @@ What's Supported?
       - Commercial Support
       - Latest
 
-    * - `4.4 <https://craftercms.com/download>`__
-      - June 13, 2025
+    * - `4.5 <https://craftercms.com/download>`__
+      - TBD, 2025
       - :green:`Active`
       - :green:`Active`
+      - 4.5.0 (TBD, 2025)
+    * - 4.4
+      - June 13, 2025
+      - :green:`TBD`
+      - :green:`TBD`
       - 4.4.4 (September 6, 2025)
     * - 4.3
       - February 21, 2025