shaytan/telegram_glpi
1
0
Fork 0
mirror of https://github.com/stjornleysi/telegram_glpi.git synced 2025-11-30 00:53:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
telegram_glpi/node_modules/glpi-api/docs/Glpi.html
Александр Тороп 038bf44010 init
2024-03-30 18:27:37 +03:00

7672 lines
113 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Glpi - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Glpi.html">Glpi</a><ul class='methods'><li data-type='method'><a href="Glpi.html#_getAuth">_getAuth</a></li><li data-type='method'><a href="Glpi.html#_parseContentRange">_parseContentRange</a></li><li data-type='method'><a href="Glpi.html#_request">_request</a></li><li data-type='method'><a href="Glpi.html#_validateItemType">_validateItemType</a></li><li data-type='method'><a href="Glpi.html#addCustomItemTypes">addCustomItemTypes</a></li><li data-type='method'><a href="Glpi.html#addItems">addItems</a></li><li data-type='method'><a href="Glpi.html#changeActiveEntities">changeActiveEntities</a></li><li data-type='method'><a href="Glpi.html#changeActiveProfile">changeActiveProfile</a></li><li data-type='method'><a href="Glpi.html#deleteItems">deleteItems</a></li><li data-type='method'><a href="Glpi.html#download">download</a></li><li data-type='method'><a href="Glpi.html#getActiveEntities">getActiveEntities</a></li><li data-type='method'><a href="Glpi.html#getActiveProfile">getActiveProfile</a></li><li data-type='method'><a href="Glpi.html#getFullSession">getFullSession</a></li><li data-type='method'><a href="Glpi.html#getItem">getItem</a></li><li data-type='method'><a href="Glpi.html#getItems">getItems</a></li><li data-type='method'><a href="Glpi.html#getMultipleItems">getMultipleItems</a></li><li data-type='method'><a href="Glpi.html#getMyEntities">getMyEntities</a></li><li data-type='method'><a href="Glpi.html#getMyProfiles">getMyProfiles</a></li><li data-type='method'><a href="Glpi.html#getSubItems">getSubItems</a></li><li data-type='method'><a href="Glpi.html#initSession">initSession</a></li><li data-type='method'><a href="Glpi.html#killSession">killSession</a></li><li data-type='method'><a href="Glpi.html#listSearchOptions">listSearchOptions</a></li><li data-type='method'><a href="Glpi.html#lostPassword">lostPassword</a></li><li data-type='method'><a href="Glpi.html#search">search</a></li><li data-type='method'><a href="Glpi.html#updateItems">updateItems</a></li><li data-type='method'><a href="Glpi.html#upload">upload</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Glpi</h1>
<section>
<header>
<h2>
Glpi
</h2>
<div class="class-description"><p>Class to manage access to GLPI via REST API</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="Glpi"><span class="type-signature"></span>new Glpi<span class="signature">(settings)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line66">line 66</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Create a Glpi object</p>
<p>Usage :</p>
<pre class="prettyprint source"><code>const Glpi = require('glpi-api');
const glpi = new Glpi({
apiurl : 'http://glpi.myserver.com/apirest.php',
user_token : 'q56hqkniwot8wntb3z1qarka5atf365taaa2uyjrn',
app_token : 'f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7',
});
// or
const glpi = new Glpi({
apiurl : 'http://glpi.myserver.com/apirest.php',
app_token : 'f7g3csp8mgatg5ebc5elnazakw20i9fyev1qopya7',
auth : {
username : 'glpi',
password : 'glpi',
}
});
</code></pre>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>settings</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>user_token</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Token used for user token authentication</p></td>
</tr>
<tr>
<td class="name"><code>auth</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>2 parameters to login with user authentication</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>username</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>username parameter used for user authentication</p></td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>password parameter used for user authentication</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>app_token</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Authorization string provided by the GLPI api configuration</p></td>
</tr>
<tr>
<td class="name"><code>apiurl</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>URL of the apirest.php file</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="_getAuth"><span class="type-signature"></span>_getAuth<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return the appropriate string for authentication</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>settings.auth</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>2 parameters to login with user authentication</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>username</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>username parameter used for user authentication</p></td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>password parameter used for user authentication</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="_parseContentRange"><span class="type-signature"></span>_parseContentRange<span class="signature">(headers)</span><span class="type-signature"> &rarr; {object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line220">line 220</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Extract min, max and total from Content-Range header</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>key/value object of HTTP headers</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="_request"><span class="type-signature"></span>_request<span class="signature">(method, endpoint, options)</span><span class="type-signature"> &rarr; {object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line143">line 143</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Send HTTP requests</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>method</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>HTTP method to use for the request. Only GET, POST, PUT and DELETE are accepted,
throws an InvalidHTTPMethodError otherwise.</p></td>
</tr>
<tr>
<td class="name"><code>endpoint</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>API endpoint</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>headers</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>HTTP headers to add to the request</p></td>
</tr>
<tr>
<td class="name"><code>query</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>URL query string to add to the request</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h4 class="name" id="_validateItemType"><span class="type-signature"></span>_validateItemType<span class="signature">(itemType)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line203">line 203</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Validate if itemType is accepted by GLPI</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>itemType requested</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="addCustomItemTypes"><span class="type-signature"></span>addCustomItemTypes<span class="signature">(customItemTypes)</span><span class="type-signature"> &rarr; {undefined}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Add one or more custom itemTypes to the valid itemTypes list</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>customItemTypes</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">array</span>
</td>
<td class="description last"><p>String or array of string of itemType to add to the valid itemTypes list</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">undefined</span>
</dd>
</dl>
<h4 class="name" id="addItems"><span class="type-signature"></span>addItems<span class="signature">(itemType, input)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line706">line 706</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Add an object (or multiple objects) into GLPI.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>itemType requested</p></td>
</tr>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">Array.&lt;object></span>
</td>
<td class="description last"><p>an object with fields of itemtype to be inserted.
You can add several items in one action by passing an array of objects. Mandatory.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="changeActiveEntities"><span class="type-signature"></span>changeActiveEntities<span class="signature">(profiles_id)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line374">line 374</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Change active profile to the profiles_id one.
See getMyProfiles endpoint for possible profiles.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>profiles_id</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>ID of the new active profile.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="changeActiveProfile"><span class="type-signature"></span>changeActiveProfile<span class="signature">(profiles_id)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line332">line 332</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Change active profile to the profiles_id one.
See ${getMyProfiles} endpoint for possible profiles.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>profiles_id</code></td>
<td class="type">
<span class="param-type">integer</span>
</td>
<td class="description last"><p>ID of the new active profile.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="deleteItems"><span class="type-signature"></span>deleteItems<span class="signature">(itemType, id<span class="signature-attributes">opt</span>, input, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line775">line 775</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Delete an object existing in GLPI.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>itemType requested</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>the unique identifier of the itemtype passed in URL.
You could skip this parameter by passing it in the input payload.</p></td>
</tr>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Array of id who need to be deleted.</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>force_purge</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>boolean, if the itemtype have a dustbin, you can force purge (delete finally). Optional.</p></td>
</tr>
<tr>
<td class="name"><code>history</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>boolean, set to false to disable saving of deletion in global history. Optional.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="download"><span class="type-signature"></span>download<span class="signature">(documentId)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line861">line 861</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Download a document from GLPI</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>documentId</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">number</span>
</td>
<td class="description last"><p>unique identifier of the itemtype passed in the URL.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getActiveEntities"><span class="type-signature"></span>getActiveEntities<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line359">line 359</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return active entities of current logged user.</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getActiveProfile"><span class="type-signature"></span>getActiveProfile<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line317">line 317</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return the current active profile.</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getFullSession"><span class="type-signature"></span>getFullSession<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line387">line 387</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return the current php $_SESSION.</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getItem"><span class="type-signature"></span>getItem<span class="signature">(itemType, id, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line419">line 419</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return the instance fields of itemtype identified by id.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>itemtype requested</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>unique identifier of the itemtype. Mandatory.</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>expand_dropdowns</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>show dropdown name instead of id.</p></td>
</tr>
<tr>
<td class="name"><code>get_hateoas</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>Show relations of the item in a links attribute.</p></td>
</tr>
<tr>
<td class="name"><code>get_sha1</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Get a sha1 signature instead of the full answer.</p></td>
</tr>
<tr>
<td class="name"><code>with_devices</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for [Computer, NetworkEquipment, Peripheral, Phone, Printer], retrieve the associated components.</p></td>
</tr>
<tr>
<td class="name"><code>with_disks</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for Computer, retrieve the associated file-systems.</p></td>
</tr>
<tr>
<td class="name"><code>with_softwares</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for Computer, retrieve the associated software's installations.</p></td>
</tr>
<tr>
<td class="name"><code>with_connections</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for Computer, retrieve the associated direct connections (like peripherals and printers) .Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_networkports</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve all network's connections and advanced network's informations.</p></td>
</tr>
<tr>
<td class="name"><code>with_infocoms</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve financial and administrative informations.</p></td>
</tr>
<tr>
<td class="name"><code>with_contracts</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated contracts.</p></td>
</tr>
<tr>
<td class="name"><code>with_documents</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated external documents.</p></td>
</tr>
<tr>
<td class="name"><code>with_tickets</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated itil tickets.</p></td>
</tr>
<tr>
<td class="name"><code>with_problems</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated itil problems.</p></td>
</tr>
<tr>
<td class="name"><code>with_changes</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated itil changes.</p></td>
</tr>
<tr>
<td class="name"><code>with_notes</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve Notes.</p></td>
</tr>
<tr>
<td class="name"><code>with_logs</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve historical.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getItems"><span class="type-signature"></span>getItems<span class="signature">(itemType, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line465">line 465</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return a collection of rows of the itemtype.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>itemtype requested</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>expand_dropdowns</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>show dropdown name instead of id.</p></td>
</tr>
<tr>
<td class="name"><code>get_hateoas</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>Show relation of item in a links attribute.</p></td>
</tr>
<tr>
<td class="name"><code>only_id</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>keep only id keys in returned data.</p></td>
</tr>
<tr>
<td class="name"><code>range</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>0-50</code>
</td>
<td class="description last"><p>a string with a couple of number for start and end of pagination separated by a '-'. Ex: 150-200.</p></td>
</tr>
<tr>
<td class="name"><code>sort</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>id</code>
</td>
<td class="description last"><p>id of the searchoption to sort by.</p></td>
</tr>
<tr>
<td class="name"><code>order</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>DESC</code>
</td>
<td class="description last"><p>ASC - Ascending sort / DESC Descending sort.</p></td>
</tr>
<tr>
<td class="name"><code>searchText</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last"><p>array of filters to pass on the query (with key = field and value the text to search)</p></td>
</tr>
<tr>
<td class="name"><code>is_deleted</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Return deleted element.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getMultipleItems"><span class="type-signature"></span>getMultipleItems<span class="signature">(opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line579">line 579</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Virtually call Get an item for each line in input. So, you can have a ticket and a user in the same query.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>items</code></td>
<td class="type">
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>items to retrieve. Mandatory. Each line of this array should contains two keys: <code>itemtype</code>and <code>items_id</code></p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemtype</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>itemtype requested</p></td>
</tr>
<tr>
<td class="name"><code>items_id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>unique identifier of the itemtype</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>expand_dropdowns</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>show dropdown name instead of id. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>get_hateoas</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>Show relations of the item in a links attribute. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>get_sha1</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Get a sha1 signature instead of the full answer. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_devices</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for [Computer, NetworkEquipment, Peripheral, Phone, Printer], retrieve the associated components. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_disks</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for Computer, retrieve the associated file-systems. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_softwares</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for Computer, retrieve the associated software's installations. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_connections</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Only for Computer, retrieve the associated direct connections (like peripherals and printers) .Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_networkports</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve all network's connections and advanced network's informations. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_infocoms</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve financial and administrative informations. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_contracts</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated contracts. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_documents</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated external documents. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_tickets</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated itil tickets. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_problems</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated itil problems. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_changes</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve associated itil changes. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_notes</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve Notes. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>with_logs</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>Retrieve historical. Optional.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getMyEntities"><span class="type-signature"></span>getMyEntities<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line345">line 345</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return all the possible entities of the current logged user (and for current active profile).</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getMyProfiles"><span class="type-signature"></span>getMyProfiles<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line305">line 305</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Return all the profiles associated to logged user.</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="getSubItems"><span class="type-signature"></span>getSubItems<span class="signature">(itemType, id, subItemType, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line502">line 502</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>parent itemtype provided. If Object, id must not be provided</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>unique identifier of the itemtype. Mandatory if itemType is a string.</p></td>
</tr>
<tr>
<td class="name"><code>subItemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>subItemType requested</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>expand_dropdowns</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>show dropdown name instead of id. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>get_hateoas</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>true</code>
</td>
<td class="description last"><p>Show relation of item in a links attribute. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>only_id</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>keep only id keys in returned data. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>range</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>0-50</code>
</td>
<td class="description last"><p>a string with a couple of number for start and end of pagination separated by a '-'. Ex: 150-200. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>sort</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>id</code>
</td>
<td class="description last"><p>id of the searchoption to sort by. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>order</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>DESC</code>
</td>
<td class="description last"><p>ASC - Ascending sort / DESC Descending sort. Optional.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="initSession"><span class="type-signature"></span>initSession<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line237">line 237</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Request a session token to use other api endpoints.</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="killSession"><span class="type-signature"></span>killSession<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line264">line 264</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Destroy a session identified by a session token.</p>
</div>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="listSearchOptions"><span class="type-signature"></span>listSearchOptions<span class="signature">(itemType, raw<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line620">line 620</a>
</li></ul></dd>
</dl>
<div class="description">
<p>List the searchoptions of provided itemtype. To use with Search items.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>itemType requested</p></td>
</tr>
<tr>
<td class="name"><code>raw</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>return searchoption uncleaned if true (as provided by core)</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="lostPassword"><span class="type-signature"></span>lostPassword<span class="signature">(email, password_forget_token, password)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line286">line 286</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Sends a notification to the user to reset his password.
Reset the password if <code>password_forget_token</code> and <code>password</code> are provided</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>email</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>email address of the user to recover. Mandatory.</p></td>
</tr>
<tr>
<td class="name"><code>password_forget_token</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>reset token. Mandatory to reset password</p></td>
</tr>
<tr>
<td class="name"><code>password</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the new password for the user. Mandatory to reset password</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="search"><span class="type-signature"></span>search<span class="signature">(itemType, opts<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line674">line 674</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Expose the GLPI searchEngine and combine criteria to retrieve a list of elements of specified itemtype.</p>
<p>Note: you can use 'AllAssets' itemtype to retrieve a combination of all asset's types.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>itemType requested</p></td>
</tr>
<tr>
<td class="name"><code>opts</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>criteria</code></td>
<td class="type">
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>array of criterion objects to filter search. Optional.
Each criterion object must provide :</p>
<ul>
<li><em>link</em>: (optional for 1st element) logical operator in [AND, OR, AND NOT, AND NOT].</li>
<li><em>field</em>: id of the searchoption.</li>
<li><em>searchtype</em>: type of search in [contains, equals, notequals, lessthan, morethan, under, notunder].</li>
<li><em>value</em>: the value to search.</li>
</ul>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>link</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>(optional for 1st element) logical operator in [AND, OR, AND NOT, AND NOT].</p></td>
</tr>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>id of the searchoption.</p></td>
</tr>
<tr>
<td class="name"><code>searchtype</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>type of search in [contains, equals, notequals, lessthan, morethan, under, notunder].</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the value to search.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>metacriteria</code></td>
<td class="type">
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>array of meta-criterion objects to filter search. Optional.
A meta search is a link with another itemtype (ex: Computer with softwares). Each meta-criterion object must provide:</p>
<ul>
<li><em>link</em>: logical operator in [AND, OR, AND NOT, AND NOT]. Mandatory.</li>
<li><em>itemtype</em> : second itemtype to link.</li>
<li><em>field</em>: id of the searchoption.</li>
<li><em>searchtype</em>: type of search in [contains, equals, notequals, lessthan, morethan, under, notunder].</li>
<li><em>value</em>: the value to search.</li>
</ul>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>link</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>logical operator in [AND, OR, AND NOT, AND NOT]. Mandatory.</p></td>
</tr>
<tr>
<td class="name"><code>itemtype</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>second itemtype to link.</p></td>
</tr>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>id of the searchoption.</p></td>
</tr>
<tr>
<td class="name"><code>searchtype</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>type of search in [contains, equals, notequals, lessthan, morethan, under, notunder].</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>the value to search.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td class="name"><code>sort</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>id</code>
</td>
<td class="description last"><p>id of the searchoption to sort by. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>order</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>DESC</code>
</td>
<td class="description last"><p>ASC - Ascending sort / DESC Descending sort. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>range</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>0-50</code>
</td>
<td class="description last"><p>a string with a couple of number for start and end of pagination separated by a '-'. Ex: 150-200. Optional.</p></td>
</tr>
<tr>
<td class="name"><code>forcedisplay</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>array of columns to display (default empty = use display preferences and searched criteria).
Some columns will be always presents (1: id, 2: name, 80: Entity). Optional.</p></td>
</tr>
<tr>
<td class="name"><code>rawdata</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>a boolean for displaying raws data of the Search engine of glpi (like SQL request, full searchoptions, etc)</p></td>
</tr>
<tr>
<td class="name"><code>withindexes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>a boolean to retrieve rows indexed by items id. By default this option is set to false,
because order of json objects (which are identified by index) cannot be garrantued
(from http://json.org/ : An object is an unordered set of name/value pairs). So, we provide arrays to guarantying sorted rows.</p></td>
</tr>
<tr>
<td class="name"><code>uid_cols</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>a boolean to identify cols by the 'uniqid' of the searchoptions instead of a numeric value (see List searchOptions and 'uid' field)</p></td>
</tr>
<tr>
<td class="name"><code>giveItems</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
<code>false</code>
</td>
<td class="description last"><p>a boolean to retrieve the data with the html parsed from core, new data are provided in data_html key.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="updateItems"><span class="type-signature"></span>updateItems<span class="signature">(itemType, id<span class="signature-attributes">opt</span>, input)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line731">line 731</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Update an object (or multiple objects) existing in GLPI.</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>itemType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>itemType requested</p></td>
</tr>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>the unique identifier of the itemtype passed in URL.
You could skip this parameter by passing it in the input payload.</p></td>
</tr>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">object</span>
|
<span class="param-type">Array.&lt;object></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>an object with fields of itemtype to be inserted.
You can add several items in one action by passing an array of objects. Mandatory.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
<h4 class="name" id="upload"><span class="type-signature"></span>upload<span class="signature">(filePath, description<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="glpi.js.html">glpi.js</a>, <a href="glpi.js.html#line818">line 818</a>
</li></ul></dd>
</dl>
<div class="description">
<p>Upload a document to GLPI</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>filePath</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Absolute path to the file to upload</p></td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>Description to add to document</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Oct 04 2019 16:24:24 GMT+0200 (GMT+02:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink